Introduction

This document outlines how we approach developing and supporting multiple API endpoint versions.

Phases of life

Phase	Description	Feature changes	Security patches
Current	This is the most recent major version of our API	Yes	Yes
Deprecated	One major version behind "current"	No	Yes
End of life	Endpoints that are no longer supported at all	No	No

General philosophy

We would like all of our customers to be using the most current version of our API. This is the version that we will be updating with features and actively maintaining.

Deprecated endpoints are available for use (their routes work) but are not actively supported with new features.

Endpoints that are in end of life will be scheduled to be removed from the server, clients making use of them should contact us for help in migrating to more current endpoints.

We will not move an endpoint to "end of life" before consulting with client developers.

Current version lifecycle

Channel

Version	Title	Lifecycle	Documentation	EOL
4.0	Channels	Planned	Schedule#/Channels/GetChannelsIndex
4.0	Channel details	Planned	Schedule#/Channels/GetChannelById
3.1	User specific channels	End of Life	User specific channels (v3.1)	June 2021
3.1	List of channels	End of Life	List of Channels (v3.1)	June 2021
2	List of channels	End of Life	List of Channels (v2)	June 2021
2	Details of channel	End of Life	Details of Channel (v2)	June 2021
2	Play channel	End of Life	PlayableStream	June 2021
2.0	Mark/unmark channel as favourite	End of Life	Mark/unmark channel as favourite	June 2021
1.0	Play Channel	End of Life	Play Channel (deprecated)	June 2021
1.0	Adding Channels to be Recorded	End of Life	Adding Channels to be Recorded	June 2021

EPG

Version	Title	Lifecycle	Documentation	EOL
4.0	Broadcast slots	Current	Schedule#/Broadcast%20Slots/GetBroadcastSlotsIndex
4.0	Broadcast slot details	Current	Schedule#/Broadcast%20Slots/GetBroadcastSlotById
3.0	EPG List V3	End of Life	EPG List V3	June 2021
3.0	EPG Program Details V3	End of Life	EPG Program Details V3	June 2021
No version	EPG List V2	End of Life	EPG List V2	June 2021
2.0	EPG V2 - Program Details	End of Life	EPG V2 - Program Details	June 2021
2.0	List of top recordings	End of Life	List of top recordings	June 2021
4.0	Get a list of programs with basic metadata	Current	Metadata: Programs#/Programs/GetProgramIndex
4.0	Get details for a specific program including rich metadata relationships	Current	Metadata: Programs#/Programs/GetProgram
4	Get a list of genres	Planned	Metadata: Genres#/Genres/indexGenres
4	Get a list of programs for a particular genre	Planned	Metadata: Genres#/Genres/SeeGenrePrograms
4	Get list of programs for a credited person	Planned	/wiki/spaces/MAPI/pages/49676902

Teletext

Version	Title	Lifecycle	Documentation	EOL
2.0	Teletext Page Item	End of Life	Teletext Page Item	June 2021
2.0	Teletext SubPage Item	End of Life	Teletext SubPage Item	June 2021
2.0	TeleText SubPage Index	End of Life	Teletext SubPage Index	June 2021
2.0	TeleText Create	End of Life	Teletext Create	June 2021

Product and Licensing

Version	Title	Lifecycle	Documentation	EOL
4.0	Get list of user's active licenses	Current	User licenses v4#/License/GetUserLicenses
4.0	Purchase a new license for the user	Current	User licenses v4#/License/PurchaseUserLicense
4.0	Get a list of products visible to the user	Current	User licenses v4#/Product/GetAllProducts
4.0	Get licenses with a filter (management)	Current	Management Licenses v4#/License/GetLicenses
4.0	Create a new license (management)	Current	Management Licenses v4#/License/CreateLicense
4.0	Get a license (management)	Current	Management Licenses v4#/License/GetLicenseById
4.0	Delete a license (management)	Current	Management Licenses v4#/License/DeleteLicenseById
4.0	Batch create licenses (management)	Current	Management Licenses v4#/License/BatchCreateLicenses
4.0	Batch delete licenses (management)	Current	Management Licenses v4#/License/BatchDeleteLicenses
4.0	Delete all user's licenses (management)	Current	Management Licenses v4#/License/BatchDeleteAllUserLicenses
4.0	Get all user's licenses (management)	Current	Management Licenses v4#/License/GetLicensesByUser
4.0	Get all products (management)	Current	Management Licenses v4#/Product/GetAllProducts
4.0	Create a new product (management)	Current	Management Licenses v4#/Product/CreateProduct
4.0	Get product details (management)	Current	Management Licenses v4#/Product/GetProductById
4.0	Update product (management)	Current	Management Licenses v4#/Product/UpdateProduct
4.0	Delete a product (management)	Current	Management Licenses v4#/Product/DeleteProductById
2.0	List of Products	End of Life	List of Products	June 2021
1.1	List of external VOD Products	End of Life	List of external VOD Products	June 2021
2.0	Details of Products	End of Life	Details of Products	June 2021
2.0	Product Buy Options	End of Life	Product Buy Options	June 2021
2.0	Buy a Product	End of Life	Buy a Product	June 2021
2.0	List of Licenses	End of Life	List of Licenses	June 2021
2.0	Details of License	End of Life	Details of License	June 2021
2.0	Update License	End of Life	Update License	June 2021
No version	Check License Status	End of Life	Check License Status	June 2021
No version	Verify App-Store Payment	End of Life	Verify App-Store Payment	June 2021
2.0	Verify Credit Card	End of Life	Verify Credit Card	June 2021
2.0	Booxmedia Product Details	End of Life	Booxmedia Product Details	June 2021
2.2	JWT token for VOD provider product license	End of Life	JWT token for VOD provider product license	June 2021
2.0	SilverHD license	End of Life	SilverHD license	June 2021
2.0	Activate Gameleo license	End of Life	Activate Gameleo license	June 2021

User Management

Version	Title	Lifecycle	Documentation	EOL
4.0	An index of the user profiles for an account	Current	User profiles#/User%20profiles/indexUserProfiles
4.0	Create a new user profile	Current	User profiles#/User%20profiles/createUserProfile
4.0	Remove a user profile from an account.	Current	User profiles#/User%20profiles/deleteUserProfile
4.0	Update a user profile	Current	User profiles#/User%20profiles/updateUserProfile
4.0	An index of the user profiles for an account	Current	User sessions
4.0	Log out all sessions for the user	Current	User sessions
4.0	Log out a session by refresh token	Current	User sessions
4.0	Log out given session for the user	Current	User sessions
4.0	Get an index of Users (management)	Planned	Users#/Users/indexUsers
4.0	Create a user (management)	Planned	Users#/Users/createUser
4.0	Get the details for a particular user (management)	Planned	Users#/Users/getUser
4.0	Add user flag (management)	Current	Users#/User%20Flags/addUserFlag
4.0	Remove user flag (management)	Current	Users#/User%20Flags/deleteUserFlag
4.0	User market segmentation (management)	Current	Users#/Market%20Segmentation/getUserMarketSegments
4.0	Update user's market segmentation (management)	Current	Users#/Market%20Segmentation/createUserMarketSegments
4.0	User market segmentation	Current	Market segmentation#/Market%20Segmentation/getUserMarketSegments
4.0	User login and access tokens	Current	User Authentication#/Account%20Authentication/createAccessToken
4.0	Device Authorization	Current	User Authentication#/Device%20Authorization/createUserCode
4.0	Device Authorization verification	Current	User Authentication#/Device%20Authorization/verifyUserCode
2.0	User Login	End of Life	User Login	June 2021
2.0	User Logout	End of Life	User Logout	June 2021
2.0	List of Users	End of Life	List of Users	June 2021
2.0	Add New User Account	End of Life	Add New User Account	June 2021
2.0	Edit Existing User Account	End of Life	Edit Existing User Account	June 2021
2.0	Delete User Account	End of Life	Delete User Account	June 2021
2.0	Request Account Password Reset	End of Life	Request Account Password Reset	June 2021
2.0	Confirm Account Password Reset	End of Life	Confirm Account Password Reset	June 2021
2.0	Delete User Account	End of Life	Delete User Account	June 2021
2.0	Add User Alias	End of Life	Add User Alias	June 2021
2.0	Change User Alias	End of Life	Change User Alias	June 2021
2.0	Delete User Alias	End of Life	Delete User Alias	June 2021
2.0	Link User with User Alias	End of Life	Link User with User Alias	June 2021
2.0	Associate Package with User Alias	End of Life	Associate Package with User Alias	June 2021
2.0	Change Associated Package	End of Life	Change Associated Package	June 2021
2.0	Add Additional Service	End of Life	Add Additional Service	June 2021
2.0	Get Service Status	End of Life	Get Service Status	June 2021
2.0	Logged In User's Service Status	End of Life	Logged In User's Service Status	June 2021
2.0	Update User Service Settings	End of Life	Update User Service Settings	June 2021
2.0	Get User Service Details	End of Life	Get User Service Details	June 2021
2.0	Delete Additional Service	End of Life	Delete Additional Service	June 2021
2.0	Player Consume Minutes	End of Life	Player Consume Minutes	June 2021
2.0	Get Consumed Minutes	End of Life	Get Consumed Minutes	June 2021
2.0	Add STB	End of Life	Add STB	June 2021
2.0	Link STB to User	End of Life	Link STB to User	June 2021
2.0	Remove STB Ownership from an User	End of Life	Remove STB Ownership from an User	June 2021
2.0	OAuth2 User Login (Delta)	End of Life	OAuth2 User Login (Delta)	June 2021

Recording

Version	Title	Lifecycle	Documentation	EOL
4.0	Get a list of popular recordings	Current	Recordings v4#/Recordings/getMostPopularBroadcastSlots
4.0	Search for recordings of a given user profile	Current	Recordings v4#/Recordings/searchRecordedSlots
4.0	Create a recording	Current	Recordings v4#/Recordings/createRecordedSlot
4.0	Update a recording	Current	Recordings v4#/Recordings/updateRecordedSlot
4.0	Delete a recording	Current	Recordings v4#/Recordings/deleteRecordedSlot
4.0	Batch delete recordings	Current	Recordings v4#/Recordings/batchDeleteRecordedSlots
4.0	List all recorded broadcast slots	Current	Recordings v4#/Recordings/recordedBroadcastSlots
4.0	User's recording storage quota	Current	Recordings v4#/Recordings/storageQuota
4.0	List all automated recordings requests for a given user profile	Current	Recordings v4#/Automated%20Recording%20Requests/indexRecordingRequests
4.0	Create an automated recording request	Current	Recordings v4#/Automated%20Recording%20Requests/createRecordingRequest
4.0	Update an automated recording request	Current	Recordings v4#/Automated%20Recording%20Requests/updateRecordingRequests
4.0	Delete an automated recording request	Current	Recordings v4#/Automated%20Recording%20Requests/deleteRecordingRequests
4.0	List all recording groups for a given user profile	Current	Recordings v4#/Recording%20Groups/indexRecordingGroups
4.0	List all recordings for a specific recording group	Current	Recordings v4#/Recording%20Groups/getRecordingsForGroup
4.0	List all recording which do not belong to a group	Current	Recordings v4#/Recording%20Groups/indexUngroupedRecordingGroupRecordings
REST 1.0	Update one or more attributes of an existing entity	End of Life	/wiki/spaces/MAPI/pages/49676468	June 2021
REST 1.0	Get a list of recordings that have previously been started	End of Life	/wiki/spaces/MAPI/pages/49676468	June 2021
2.0	Recording item	End of Life	Recording item	June 2021
2.3	Add Program for Recording	End of Life	Add Program for Recording	June 2021
2.3	Play user recording	End of Life	Play user recording in favour of PlayableStream related to Recording	June 2021
2.0	Logging User Playback	End of Life	Logging User Playback	June 2021
2.3	Update Recorded Content	End of Life	Update Recorded Content	June 2021
2.3	Delete Recorded Content	End of Life	Delete Recorded Content	June 2021
2.3	Search Recorded Content	End of Life	Search Recorded Content	June 2021
2.0	Get list of playheads	End of Life	Get list of playheads	June 2021
2.0	Get specific playhead	End of Life	Get specific playhead	June 2021
2.0	Update Recording Playback position	End of Life	Update Recording Playback position	June 2021
2.0	List of Favourite Recordings	End of Life	List of Favorite Recordings	June 2021
2.0	Update multiple user favourites	End of Life	Update multiple user favourites	June 2021
2.2	Delete Grouped Recorded Content	End of Life	Delete Grouped Recorded Content	June 2021
1.0	List Programs in a Recording Group V1	End of Life	List Programs in a Recording Group V1	June 2021
1.0	List Recording Groups and Single Programs V1	End of Life	List Recording Groups and Single Programs V1	June 2021
2.1	List Recording Groups and Single Programs V2	End of Life	List Recording Groups and Single Programs V2	June 2021
No version	List Programs in a Recording Group V2	End of Life	List Programs in a Recording Group V2	June 2021
1.2	Patch User Recordings	End of Life	Patch User Recordings	June 2021
1.1	Get Continue Watching Recordings	End of Life	Get Continue Watching Recordings	June 2021
1.1	Get User Recordings	End of Life	Get User Recordings	June 2021
2.0	User Recording Storage	End of Life	User Recording Storage	June 2021

Catchup

Version	Title	Lifecycle	Documentation	EOL
4.0	List catchup programs	Current	/wiki/spaces/MAPI/pages/49676422
4.0	List most popular catchup programs	Current	/wiki/spaces/MAPI/pages/49676422
End of Life		End of Life	Catchup Program	June 2021
2.0	Catchup Groups collection	End of Life	Catchup Groups collection	June 2021
2.0	Catchup Group item	End of Life	Catchup Group item	June 2021
2.1	Logging Catchup Playback	End of Life	Logging Catchup Playback	June 2021

Playable streams

Version	Title	Lifecycle	Documentation
4.0	Live streams	Current	PlayableStream related to Channel (live)#/Stream/getChannelStreams
4.0	Recordings streams	Current	PlayableStream related to Recording#/Stream/getChannelStreams
4.0	Catchup streams	Current	PlayableStream related to Catchup
4.0	List user's active media play sessions	Current	Media play sessions#/Media%20Play%20Sessions/indexMediaPlaySession
4.0	Create a new media play session	Current	Media play sessions#/Media%20Play%20Sessions/postMediaPlaySession
4.0	Create or update an existing media play session	Current	Media play sessions#/Media%20Play%20Sessions/putMediaPlaySession
4.0	Update an existing media play session	Current	Media play sessions#/Media%20Play%20Sessions/patchMediaPlaySession
4.0	Delete a media play session	Current	Media play sessions#/Media%20Play%20Sessions/deleteMediaPlaySession

Ruutu APIs

Version	Title	Lifecycle	Documentation	EOL
2.1	Get a Ruutu session for the user	End of Life	Get a Ruutu session for the user	June 2021
2.0	Verify Ruutu Agreement	End of Life	Verify Ruutu Agreement	June 2021
2.0	Get user's Ruutu Licenses	End of Life	Get user's Ruutu Licenses	June 2021

Server

Version	Title	Lifecycle	Documentation
2.0	Get Server Time	Current	Get Server Time
2.0	Translation	End of Life	Translation
2.0	Get Site Images	End of Life	Get Site Images
2.0	Application Languages List	End of Life	Application Languages List
2.0	Configuration Option List	Current	Configuration Option List
2.0	Detail of Configuration Option	Current	Detail of Configuration Option
2.0	GEO Blocking	Current	GEO Blocking
2.0	VAST Ads	End of Life	VAST Ads
2.0	Get server health	Current	Get server health

Social Media

Version	Title	Lifecycle	Documentation
2.0	Login	End of Life	Login
No version	Logout	End of Life	Logout
2.0	Proxy Login	End of Life	Proxy Login
2.0	Twitter	End of Life	Twitter

Playback info

Version	Title	Lifecycle	Documentation	EOL
4.0	Populate playback info	Current	Playback Info#/Playback%20Info/putPlaybackInfo
4.0	Get the current playback info for a given asset	Current	Playback Info#/Playback%20Info/getPlaybackInfo
4.0	Get the list of playback info items per asset type	Current	Playback Info#/Playback%20Info/getPlaybackInfoIndex
2.0	Create Playback stats log	End of Life	Create Playback stats log	June 2021

STB authentication and functionality

Version	Title	Lifecycle	Documentation	EOL
2.1	STB Authentication	End of Life	STB Authentication	June 2021
2.0	Refresh Token	End of Life	Refresh Token	June 2021
2.0	Link STB to User	End of Life	Link STB to User	June 2021
2.0	Remove STB Ownership from an User	End of Life	Remove STB Ownership from an User	June 2021
2.0	Logout STB	End of Life	Logout STB	June 2021

User favourite channels

Version	Title	Lifecycle	Documentation
4.0	An index of all of the favourite channel lists for a specific user	Current	Favourite channel lists#/Favourite%20Channel%20List%20Collection/indexUserFavouriteChannelList
4.0	Create a new favourite channel list	Current	Favourite channel lists#/Favourite%20Channel%20List%20Collection/createFavouriteChannelList
4.0	Delete a favourite channel list	Current	Favourite channel lists#/Favourite%20Channel%20List%20Resource/deleteFavouriteChannelList
4.0	Update a favourite channel list	Current	Favourite channel lists#/Favourite%20Channel%20List%20Resource/updateFavouriteChannelList
4.0	A list of ALL the channels that a user has marked as favourite in ANY list.	Current	Favourite channel lists#/Favourite%20Channel%20List%20Relationships/indexChannelListContents
4.0	An index of all of the channels that a list contains.	Current	Favourite channel lists#/Favourite%20Channel%20List%20Relationships/indexChannelListContents
4.0	Remove a channel from a favourite list	Current	Favourite channel lists#/Favourite%20Channel%20List%20Relationships/deleteFavouriteChannelItem
4.0	Add a channel into a favourite list	Current	Favourite channel lists#/Favourite%20Channel%20List%20Relationships/createFavouriteChannelListItem

User

Version	Title	Lifecycle	Documentation	EOL
4.0	Update an user account	Current	User information v2#/User%20Preferences/updateUser
4.0	Request a password reset	Current	User information v2#/Password%20Reset/requestResetPassword
4.0	Confirm password reset	Current	User information v2#/Password%20Reset/confirmResetPassword
REST 1.0	Get the details for a particular user (accepts id or email as identifier)	End of Life	User information v1#/Users/getUser	June 2021
REST 1.0	Update a user	End of Life	User information v1#/Users/getUser	June 2021
2.0	User Registration	End of Life	User Registration	June 2021
1.0	Get Users	End of Life	Get Users	June 2021
1.0	Get User By ID	End of Life	Get User By ID	June 2021
2.0	PIN Code Verification	End of Life	PIN Code Verification	June 2021
2.0	PIN Code Reset Request	End of Life	PIN Code Reset Request	June 2021
2.0	PIN Code Reset/Update	End of Life	PIN Code Reset/Update	June 2021
2.0	Parental PIN Code Reset/Update	End of Life	Parental PIN Code Reset/Update	June 2021
2.0	Verify Parental PIN Code	End of Life	Verify Parental PIN Code	June 2021
2.0	Parental PIN code reset request	End of Life	Parental PIN code reset request	June 2021
2.0	Get age limit	End of Life	Get age limit	June 2021
2.0	Set age limit	End of Life	Set age limit	June 2021

DRM

Version	Title	Lifecycle	Documentation	EOL
4.0	EZDRM verify playback request	Current	/wiki/spaces/MAPI/pages/49676985
2.0	Associate User with STBDevice	End of Life	Associate User with STBDevice	June 2021
REST 1.0	Entitle a set top box to watch DVB channels	Planned	/wiki/spaces/MAPI/pages/49676635
REST 1.0	Remove entitlement from set top box	Planned	/wiki/spaces/MAPI/pages/49676635
2.0	Registers Device player's DRM id	End of Life	Registers Device player's DRM id	June 2021

VoD

Version	Title	Lifecycle	Documentation	EOL
4.0	Program metadata (REST)	Current	Metadata: Programs
4.0	Genres (REST)	Current	Metadata: Genres
4.0	Seasons (REST)	Planned	/wiki/spaces/MAPI/pages/49676898
2.0	List of Programs	End of Life	List of Programs	June 2021
2.0	Detail of Program	End of Life	Detail of Program	June 2021
2.0	List of Genres	End of Life	List of Genres	June 2021
2.0	Detail of Genre	End of Life	Detail of Genre	June 2021
2.0	List of Seasons	End of Life	List of Seasons	June 2021
2.0	Detail of Season	End of Life	Detail of Season	June 2021
2.0	Mark/Unmark a VOD Program as Favorite	End of Life	Mark/Unmark a VOD Program as Favorite	June 2021
2.0	Play VoD Content	End of Life	Play VoD Content	June 2021
2.0	Play VOD Trailer	End of Life	Play VOD Trailer	June 2021
2.0	Import XML of VOD	End of Life	Import XML of VOD	June 2021

Wallet

Version	Title	Lifecycle	Documentation	EOL
2.0	List of Wallets	End of Life	List of Wallets	June 2021
2.0	Details of Wallet	End of Life	Details of Wallet	June 2021
2.0	Transactions List	End of Life	Transactions List	June 2021
2.0	Transaction Detail	End of Life	Transaction Detail	June 2021
2.0	Charge Product List	End of Life	Charge Product List	June 2021
2.0	Charge Product Detail	End of Life	Charge Product Detail	June 2021
2.0	Buy Product	End of Life	Buy Product	June 2021
2.0	Charge Wallet with Credit Card	End of Life	Charge Wallet with Credit Card	June 2021
2.0	Charge Wallet with Voucher	End of Life	Charge Wallet with Voucher	June 2021
2.0	Apple Receipt Verification	End of Life	Apple Receipt Verification	June 2021

AminoTV API

AminoTV API Lifecycle