Versions Compared

Version Old Version 29 New Version Current
Changes made by

Andy Beak

Antti Peltosaari

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

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

Phases of life

PhaseDescriptionFeature changesSecurity patchesCurrentThis is the most recent major version of our APIYesYesDeprecatedOne major version behind "current"NoYesEnd of lifeEndpoints that are no longer supported at allNoNo

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.

Table of Contents

Current version lifecycle

Category

VersionEndpointLifecycleDocumentationNot versionedList of categoriesCurrentJenkins

Channel

VersionTitleLifecycleDocumentation4User specified favourite channel lists (REST)PlannedFavourite channel lists4Channel index (REST)PlannedJenkins3.1User specific channelsCurrentUser specific channels (v3.1)3.1List of channelsCurrentList of Channels (v3.1)3List of channelsDeprecatedList of Channels (v3)2List of channelsDeprecatedList of Channels (v2)2Details of channelCurrentDetails of Channel (v2)2Play channelDeprecatedPlayableStream2.0Mark/unmark channel as favouriteDeprecatedMark/unmark channel as favourite1.0Play ChannelEnd of LifePlay Channel (deprecated)1.0Adding Channels to be RecordedEnd of LifeAdding Channels to be Recorded

Teletext

VersionTitleLifecycleDocumentation2.0Teletext Page ItemCurrentTeletext Page Item2.0Teletext SubPage ItemCurrentTeletext SubPage Item2.0TeleText SubPage IndexCurrentTeletext SubPage Index2.0TeleText CreateCurrentTeletext Create

EPG

VersionTitleLifecycleDocumentation4.0Schedule (REST)PlannedSchedule4.0Program metadata (REST)PlannedMetadata: Programs3.1EPG List V3CurrentEPG List V33.0EPG Program Details V3CurrentEPG Program Details V3No versionEPG List V2DeprecatedEPG List V22.0EPG V2 - Program DetailsDeprecatedEPG V2 - Program Details2.0List of top recordingsCurrentList of top recordings4.0GenresPlannedMetadata: Genres4.0SeasonsPlanned/wiki/spaces/MAPI/pages/496768984.0SeriesPlannedMetadata: Series4.0CreditedPersonPlanned/wiki/spaces/MAPI/pages/49676902

Irdeto Integration    

VersionTitleLifecycleDocumentation2.0Associate User with STBDeviceCurrentAssociate User with STBDevice

Product and Licensing    

VersionTitleLifecycleDocumentation4.0Channel License (REST)PlannedChannel License2.0List of ProductsCurrentList of Products1.1List of external VOD ProductsCurrentList of external VOD Products2.0Details of ProductsCurrentDetails of Products2.0Product Buy OptionsCurrentProduct Buy Options2.0Buy a ProductCurrentBuy a Product2.0List of LicensesCurrentList of Licenses2.0Details of LicenseCurrentDetails of License2.0Update LicenseCurrentUpdate LicenseNo versionCheck License StatusCurrentCheck License StatusNo versionVerify App-Store PaymentCurrentVerify App-Store Payment2.0Verify Credit CardCurrentVerify Credit Card2.0Booxmedia Product DetailsCurrentBooxmedia Product Details2.2JWT token for VOD provider product licenseCurrentJWT token for VOD provider product license2.0SilverHD licenseCurrentSilverHD license2.0Activate Gameleo licenseCurrentActivate Gameleo license

User Management    

VersionTitleLifecycleDocumentation4.0User administration (REST)PlannedUsers4.0User Market segmentation (REST)PlannedUsers2.0User LoginCurrentUser Login2.0User LogoutCurrentUser Logout2.0List of UsersCurrentList of Users2.0Add New User AccountCurrentAdd New User Account2.0Edit Existing User AccountCurrentEdit Existing User Account2.0Delete User AccountCurrentDelete User Account2.0Request Account Password ResetCurrentRequest Account Password Reset2.0Confirm Account Password ResetCurrentConfirm Account Password Reset2.0Delete User AccountCurrentDelete User Account2.0Add User AliasCurrentAdd User Alias2.0Change User AliasCurrentChange User Alias2.0Delete User AliasCurrentDelete User Alias2.0Link User with User AliasCurrentLink User with User Alias2.0Associate Package with User AliasCurrentAssociate Package with User Alias2.0Change Associated PackageCurrentChange Associated Package2.0Add Additional ServiceCurrentAdd Additional Service2.0Get Service StatusCurrentGet Service Status2.0Logged In User's Service StatusCurrentLogged In User's Service Status2.0Update User Service SettingsCurrentUpdate User Service Settings2.0Get User Service DetailsCurrentGet User Service Details2.0Delete Additional ServiceCurrentDelete Additional Service2.0Player Consume MinutesCurrentPlayer Consume Minutes2.0Get Consumed MinutesCurrentGet Consumed Minutes2.0Add STBCurrentAdd STB2.0Link STB to UserCurrentLink STB to User2.0Remove STB Ownership from an UserCurrentRemove STB Ownership from an User2.0OAuth2 User Login (Delta)CurrentOAuth2 User Login (Delta)

Recommendation    

VersionTitleLifecycleDocumentation4.0User recommendations (REST)Planned/wiki/spaces/MAPI/pages/496768454.0User event (REST)Planned/wiki/spaces/MAPI/pages/496768452.0List of RecommendationsCurrentList of Recommendations2.0List of Recommendations for MoviesCurrentList of Recommendations for Movies2.0List of Recommendations for SeasonCurrentList of Recommendations for Season2.0List of Recommendations for SeriesCurrentList of Recommendations for Series2.0List of Recommendations for EpisodeCurrentList of Recommendations for Episode2.0List of Recommendations for RecordingCurrentList of Recommendations for Recording

Recording    

VersionTitleLifecycleDocumentation4.0User recording playable streamsCurrentPlayableStream related to Recording4.0User recordings (REST)Planned/wiki/spaces/MAPI/pages/496764684.0User recording Tags (REST)Planned/wiki/spaces/MAPI/pages/496764682.0

Recording item

CurrentRecording item2.3Add Program for RecordingCurrentAdd Program for Recording2.3Play user recordingDeprecatedPlay user recording in favour of PlayableStream related to Recording2.0Logging User PlaybackCurrentLogging User Playback2.3Update Recorded ContentCurrentUpdate Recorded Content2.3Delete Recorded ContentCurrentDelete Recorded Content2.3Search Recorded ContentCurrentSearch Recorded Content2.0Get list of playheadsCurrentGet list of playheads2.0Get specific playheadCurrentGet specific playhead2.0Update Recording Playback positionCurrentUpdate Recording Playback position2.0List of Favorite RecordingsCurrentList of Favorite Recordings2.0Update multiple user favouritesCurrentUpdate multiple user favourites2.2Delete Grouped Recorded ContentCurrentDelete Grouped Recorded Content1.0List Programs in a Recording Group V1DeprecatedList Programs in a Recording Group V11.0List Recording Groups and Single Programs V1DeprecatedList Recording Groups and Single Programs V12.1List Recording Groups and Single Programs V2CurrentList Recording Groups and Single Programs V2No versionList Programs in a Recording Group V2CurrentList Programs in a Recording Group V22.0Catchup ProgramCurrentCatchup Program2.0Catchup Groups collectionCurrentCatchup Groups collection2.0Catchup Group itemCurrentCatchup Group item2.1Logging Catchup PlaybackCurrentLogging Catchup Playback1.2Patch User RecordingsCurrentPatch User Recordings1.1Get Continue Watching RecordingsCurrentGet Continue Watching Recordings1.1Get User RecordingsDeprecatedGet User Recordings2.0User Recording StorageCurrentUser Recording Storage

Ruutu APIs    

VersionTitleLifecycleDocumentation2.1Get a Ruutu session for the userCurrentGet a Ruutu session for the user2.0Verify Ruutu AgreementCurrentVerify Ruutu Agreement2.0Get user's Ruutu LicensesCurrentGet user's Ruutu Licenses

Server    

VersionTitleLifecycleDocumentation2.0Get Server TimeCurrentGet Server Time2.0TranslationCurrentTranslation2.0Get Site ImagesCurrentGet Site Images2.0Application Languages ListCurrentApplication Languages List2.0Configuration Option ListCurrentConfiguration Option List2.0Detail of Configuration OptionCurrentDetail of Configuration Option2.0GEO BlockingCurrentGEO Blocking2.0VAST AdsCurrentVAST Ads2.0Get server healthCurrentGet server health

Social Media    

VersionTitleLifecycleDocumentation2.0LoginEnd of LifeLoginNo versionLogoutEnd of LifeLogout2.0Proxy LoginEnd of LifeProxy Login2.0TwitterEnd of LifeTwitter

Stats    

VersionTitleLifecycleDocumentation2.0Create Playback stats logCurrentCreate Playback stats log

STB authentication and functionality    

VersionTitleLifecycleDocumentation2.1STB AuthenticationCurrentSTB Authentication2.0Refresh TokenCurrentRefresh Token2.0Link STB to UserCurrentLink STB to User2.0Remove STB Ownership from an UserCurrentRemove STB Ownership from an User2.0Logout STBCurrentLogout STB

User    

VersionTitleLifecycleDocumentation4.0Users (REST)PlannedUsers2.0User RegistrationCurrentUser Registration1.0Get UsersCurrentGet Users1.0Get User By IDCurrentGet User By ID2.0PIN Code VerificationCurrentPIN Code Verification2.0PIN Code Reset RequestCurrentPIN Code Reset Request2.0PIN Code Reset/UpdateCurrentPIN Code Reset/Update2.0Parental PIN Code Reset/UpdateCurrentParental PIN Code Reset/Update2.0Verify Parental PIN CodeCurrentVerify Parental PIN Code2.0Parental PIN code reset requestCurrentParental PIN code reset request2.0Get age limitCurrentGet age limit2.0Set age limitCurrentSet age limit

Verimatrix APIs for DRM content    

VersionTitleLifecycleDocumentation2.0Registers Device player's DRM idCurrentRegisters Device player's DRM id

VoD    

VersionTitleLifecycleDocumentation4.0Program metadata (REST)PlannedMetadata: Programs4.0Genres (REST)PlannedMetadata: Genres4.0Seasons (REST)Planned/wiki/spaces/MAPI/pages/496768982.0List of ProgramsCurrentList of Programs2.0Detail of ProgramCurrentDetail of Program2.0List of GenresCurrentList of Genres2.0Detail of GenreCurrentDetail of Genre2.0List of SeasonsCurrentList of Seasons2.0Detail of SeasonCurrentDetail of Season2.0Mark/Unmark a VOD Program as FavoriteCurrentMark/Unmark a VOD Program as Favorite2.0Play VoD ContentCurrentPlay VoD Content2.0Play VOD TrailerCurrentPlay VOD Trailer2.0Import XML of VODCurrentImport XML of VOD

Wallet    

VersionTitleLifecycleDocumentationList of WalletsDetails of WalletTransactions ListTransaction DetailCharge Product ListCharge Product DetailBuy ProductCharge Wallet with Credit CardCharge Wallet with VoucherCharge Wallet with VoucherApple Receipt VerificationApple Receipt Verification

Stream    

Play user recording

Introduction

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

Phases of life

PhaseDescriptionFeature changesSecurity patches
CurrentThis is the most recent major version of our APIYesYes
DeprecatedOne major version behind "current"NoYes
End of lifeEndpoints that are no longer supported at allNoNo

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.

Table of Contents


Current version lifecycle

Category

VersionEndpointLifecycleDocumentationEOL
No versionList of categoriesEnd of LifeList of CategoriesJune 2021

Channel

VersionTitleLifecycleDocumentationEOL
4.0ChannelsPlannedSchedule#/Channels/GetChannelsIndex
4.0Channel detailsPlannedSchedule#/Channels/GetChannelById
3.1User specific channelsEnd of LifeUser specific channels (v3.1)June 2021
3.1List of channelsEnd of LifeList of Channels (v3.1)June 2021
2List of channelsEnd of LifeList of Channels (v2)June 2021
2Details of channelEnd of Life
Details of Channel (v2)June 2021
2Play channelEnd of LifePlayableStreamJune 2021
2.0Mark/unmark channel as favouriteEnd of LifeMark/unmark channel as favouriteJune 2021
1.0Play ChannelEnd of LifePlay Channel (deprecated)June 2021
1.0Adding Channels to be RecordedEnd of LifeAdding Channels to be RecordedJune 2021

EPG

VersionTitleLifecycleDocumentationEOL
4.0Broadcast slotsCurrentSchedule#/Broadcast%20Slots/GetBroadcastSlotsIndex
4.0Broadcast slot detailsCurrentSchedule#/Broadcast%20Slots/GetBroadcastSlotById
3.0EPG List V3End of Life
EPG List V3June 2021
3.0EPG Program Details V3End of Life
EPG Program Details V3June 2021
No versionEPG List V2End of LifeEPG List V2June 2021
2.0EPG V2 - Program DetailsEnd of LifeEPG V2 - Program DetailsJune 2021
2.0List of top recordingsEnd of Life
List of top recordingsJune 2021
4.0Get a list of programs with basic metadataCurrentMetadata: Programs#/Programs/GetProgramIndex
4.0Get details for a specific program including rich metadata relationshipsCurrentMetadata: Programs#/Programs/GetProgram
4Get a list of genresPlannedMetadata: Genres#/Genres/indexGenres
4Get a list of programs for a particular genrePlannedMetadata: Genres#/Genres/SeeGenrePrograms
4Get list of programs for a credited personPlanned/wiki/spaces/MAPI/pages/49676902


Teletext

VersionTitleLifecycleDocumentationEOL
2.0Teletext Page ItemEnd of Life
Teletext Page ItemJune 2021
2.0Teletext SubPage ItemEnd of Life
Teletext SubPage ItemJune 2021
2.0TeleText SubPage IndexEnd of Life
Teletext SubPage IndexJune 2021
2.0TeleText CreateEnd of Life
Teletext CreateJune 2021

Product and Licensing    

VersionTitleLifecycleDocumentationEOL
4.0Get list of user's active licensesCurrentUser licenses v4#/License/GetUserLicenses
4.0Purchase a new license for the userCurrentUser licenses v4#/License/PurchaseUserLicense
4.0Get a list of products visible to the userCurrentUser licenses v4#/Product/GetAllProducts
4.0

Get licenses with a filter (management)

CurrentManagement Licenses v4#/License/GetLicenses
4.0Create a new license (management)CurrentManagement Licenses v4#/License/CreateLicense
4.0Get a license (management)CurrentManagement Licenses v4#/License/GetLicenseById
4.0Delete a license (management)CurrentManagement Licenses v4#/License/DeleteLicenseById
4.0Batch create licenses (management)CurrentManagement Licenses v4#/License/BatchCreateLicenses
4.0Batch delete licenses (management)CurrentManagement Licenses v4#/License/BatchDeleteLicenses
4.0Delete all user's licenses (management)CurrentManagement Licenses v4#/License/BatchDeleteAllUserLicenses
4.0Get all user's licenses (management)CurrentManagement Licenses v4#/License/GetLicensesByUser
4.0Get all products (management)CurrentManagement Licenses v4#/Product/GetAllProducts
4.0Create a new product (management)CurrentManagement Licenses v4#/Product/CreateProduct
4.0Get product details (management)CurrentManagement Licenses v4#/Product/GetProductById
4.0Update product (management)CurrentManagement Licenses v4#/Product/UpdateProduct
4.0Delete a product (management)CurrentManagement Licenses v4#/Product/DeleteProductById
2.0List of ProductsEnd of Life
List of ProductsJune 2021
1.1List of external VOD ProductsEnd of Life
List of external VOD ProductsJune 2021
2.0Details of ProductsEnd of Life
Details of ProductsJune 2021
2.0Product Buy OptionsEnd of Life
Product Buy OptionsJune 2021
2.0Buy a ProductEnd of Life
Buy a ProductJune 2021
2.0List of LicensesEnd of Life
List of LicensesJune 2021
2.0Details of LicenseEnd of Life
Details of LicenseJune 2021
2.0Update LicenseEnd of Life
Update LicenseJune 2021
No versionCheck License StatusEnd of Life
Check License StatusJune 2021
No versionVerify App-Store PaymentEnd of Life
Verify App-Store PaymentJune 2021
2.0Verify Credit CardEnd of Life
Verify Credit CardJune 2021
2.0Booxmedia Product DetailsEnd of Life
Booxmedia Product DetailsJune 2021
2.2JWT token for VOD provider product licenseEnd of Life
JWT token for VOD provider product licenseJune 2021
2.0SilverHD licenseEnd of Life
SilverHD licenseJune 2021
2.0Activate Gameleo licenseEnd of LifeActivate Gameleo licenseJune 2021


User Management

VersionTitleLifecycleDocumentationEOL
4.0An index of the user profiles for an accountCurrentUser profiles#/User%20profiles/indexUserProfiles
4.0Create a new user profileCurrentUser profiles#/User%20profiles/createUserProfile
4.0Remove a user profile from an account.CurrentUser profiles#/User%20profiles/deleteUserProfile
4.0Update a user profileCurrentUser profiles#/User%20profiles/updateUserProfile
4.0An index of the user profiles for an accountCurrentUser sessions
4.0Log out all sessions for the userCurrentUser sessions
4.0Log out a session by refresh tokenCurrentUser sessions
4.0Log out given session for the userCurrentUser sessions
4.0Get an index of Users (management)PlannedUsers#/Users/indexUsers
4.0Create a user (management)PlannedUsers#/Users/createUser
4.0

Get the details for a particular user (management)

PlannedUsers#/Users/getUser
4.0Add user flag (management)CurrentUsers#/User%20Flags/addUserFlag
4.0Remove user flag (management)CurrentUsers#/User%20Flags/deleteUserFlag
4.0User market segmentation (management)CurrentUsers#/Market%20Segmentation/getUserMarketSegments
4.0Update user's market segmentation (management)CurrentUsers#/Market%20Segmentation/createUserMarketSegments
4.0User market segmentationCurrentMarket segmentation#/Market%20Segmentation/getUserMarketSegments
4.0User login and access tokensCurrentUser Authentication#/Account%20Authentication/createAccessToken
4.0Device AuthorizationCurrentUser Authentication#/Device%20Authorization/createUserCode
4.0Device Authorization verificationCurrentUser Authentication#/Device%20Authorization/verifyUserCode
2.0User LoginEnd of Life
User LoginJune 2021
2.0User LogoutEnd of Life
User LogoutJune 2021
2.0List of UsersEnd of Life
List of UsersJune 2021
2.0Add New User AccountEnd of Life
Add New User AccountJune 2021
2.0Edit Existing User AccountEnd of Life
Edit Existing User AccountJune 2021
2.0Delete User AccountEnd of Life
Delete User AccountJune 2021
2.0Request Account Password ResetEnd of Life
Request Account Password ResetJune 2021
2.0Confirm Account Password ResetEnd of Life
Confirm Account Password ResetJune 2021
2.0Delete User AccountEnd of Life
Delete User AccountJune 2021
2.0Add User AliasEnd of LifeAdd User AliasJune 2021
2.0Change User AliasEnd of LifeChange User AliasJune 2021
2.0Delete User AliasEnd of LifeDelete User AliasJune 2021
2.0Link User with User AliasEnd of LifeLink User with User AliasJune 2021
2.0Associate Package with User AliasEnd of LifeAssociate Package with User AliasJune 2021
2.0Change Associated PackageEnd of LifeChange Associated PackageJune 2021
2.0Add Additional ServiceEnd of Life
Add Additional ServiceJune 2021
2.0Get Service StatusEnd of Life
Get Service StatusJune 2021
2.0Logged In User's Service StatusEnd of LifeLogged In User's Service StatusJune 2021
2.0Update User Service SettingsEnd of Life
Update User Service SettingsJune 2021
2.0Get User Service DetailsEnd of LifeGet User Service DetailsJune 2021
2.0Delete Additional ServiceEnd of Life
Delete Additional ServiceJune 2021
2.0Player Consume MinutesEnd of Life
Player Consume MinutesJune 2021
2.0Get Consumed MinutesEnd of Life
Get Consumed MinutesJune 2021
2.0Add STBEnd of Life
Add STBJune 2021
2.0Link STB to UserEnd of Life
Link STB to UserJune 2021
2.0Remove STB Ownership from an UserEnd of Life
Remove STB Ownership from an UserJune 2021
2.0OAuth2 User Login (Delta)End of Life
OAuth2 User Login (Delta)June 2021

Recording    

VersionTitleLifecycleDocumentationEOL
4.0Get a list of popular recordingsCurrentRecordings v4#/Recordings/getMostPopularBroadcastSlots
4.0

Search for recordings of a given user profile

CurrentRecordings v4#/Recordings/searchRecordedSlots
4.0Create a recordingCurrentRecordings v4#/Recordings/createRecordedSlot
4.0Update a recordingCurrentRecordings v4#/Recordings/updateRecordedSlot
4.0Delete a recordingCurrentRecordings v4#/Recordings/deleteRecordedSlot
4.0Batch delete recordingsCurrentRecordings v4#/Recordings/batchDeleteRecordedSlots
4.0List all recorded broadcast slotsCurrentRecordings v4#/Recordings/recordedBroadcastSlots
4.0

User's recording storage quota

CurrentRecordings v4#/Recordings/storageQuota
4.0List all automated recordings requests for a given user profileCurrentRecordings v4#/Automated%20Recording%20Requests/indexRecordingRequests
4.0Create an automated recording requestCurrentRecordings v4#/Automated%20Recording%20Requests/createRecordingRequest
4.0Update an automated recording requestCurrentRecordings v4#/Automated%20Recording%20Requests/updateRecordingRequests
4.0Delete an automated recording requestCurrentRecordings v4#/Automated%20Recording%20Requests/deleteRecordingRequests
4.0List all recording groups for a given user profileCurrentRecordings v4#/Recording%20Groups/indexRecordingGroups
4.0List all recordings for a specific recording groupCurrentRecordings v4#/Recording%20Groups/getRecordingsForGroup
4.0List all recording which do not belong to a groupCurrentRecordings v4#/Recording%20Groups/indexUngroupedRecordingGroupRecordings
REST 1.0

Update one or more attributes of an existing entity

End of Life/wiki/spaces/MAPI/pages/49676468June 2021
REST 1.0Get a list of recordings that have previously been startedEnd of Life/wiki/spaces/MAPI/pages/49676468June 2021
2.0

Recording item

End of Life
Recording itemJune 2021
2.3Add Program for RecordingEnd of Life
Add Program for RecordingJune 2021
2.3Play user recordingEnd of LifePlay user recording in favour of PlayableStream related to RecordingJune 2021
2.0Logging User PlaybackEnd of Life
Logging User PlaybackJune 2021
2.3Update Recorded ContentEnd of Life
Update Recorded ContentJune 2021
2.3Delete Recorded ContentEnd of Life
Delete Recorded ContentJune 2021
2.3Search Recorded ContentEnd of Life
Search Recorded ContentJune 2021
2.0Get list of playheadsEnd of Life
Get list of playheadsJune 2021
2.0Get specific playheadEnd of Life
Get specific playheadJune 2021
2.0Update Recording Playback positionEnd of Life
Update Recording Playback positionJune 2021
2.0List of Favourite RecordingsEnd of Life
List of Favorite RecordingsJune 2021
2.0Update multiple user favouritesEnd of Life
Update multiple user favouritesJune 2021
2.2Delete Grouped Recorded ContentEnd of Life
Delete Grouped Recorded ContentJune 2021
1.0List Programs in a Recording Group V1End of LifeList Programs in a Recording Group V1June 2021
1.0List Recording Groups and Single Programs V1End of LifeList Recording Groups and Single Programs V1June 2021
2.1List Recording Groups and Single Programs V2End of Life
List Recording Groups and Single Programs V2June 2021
No versionList Programs in a Recording Group V2End of Life
List Programs in a Recording Group V2June 2021
1.2Patch User RecordingsEnd of Life
Patch User RecordingsJune 2021
1.1Get Continue Watching RecordingsEnd of Life
Get Continue Watching RecordingsJune 2021
1.1Get User RecordingsEnd of LifeGet User RecordingsJune 2021
2.0User Recording StorageEnd of Life
User Recording StorageJune 2021

Catchup

VersionTitleLifecycleDocumentationEOL
4.0List catchup programsCurrent/wiki/spaces/MAPI/pages/49676422
4.0List most popular catchup programsCurrent/wiki/spaces/MAPI/pages/49676422
End of Life
End of Life
Catchup ProgramJune 2021
2.0Catchup Groups collectionEnd of Life
Catchup Groups collectionJune 2021
2.0Catchup Group itemEnd of Life
Catchup Group itemJune 2021
2.1Logging Catchup PlaybackEnd of Life
Logging Catchup PlaybackJune 2021

Playable streams

VersionTitleLifecycleDocumentation
4.0Live streamsCurrentPlayableStream related to Channel (live)#/Stream/getChannelStreams
4.0Recordings streamsCurrentPlayableStream related to Recording#/Stream/getChannelStreams
4.0Catchup streamsCurrentPlayableStream related to Catchup
4.0List user's active media play sessionsCurrentMedia play sessions#/Media%20Play%20Sessions/indexMediaPlaySession
4.0Create a new media play sessionCurrentMedia play sessions#/Media%20Play%20Sessions/postMediaPlaySession
4.0Create or update an existing media play sessionCurrentMedia play sessions#/Media%20Play%20Sessions/putMediaPlaySession
4.0Update an existing media play sessionCurrentMedia play sessions#/Media%20Play%20Sessions/patchMediaPlaySession
4.0Delete a media play sessionCurrentMedia play sessions#/Media%20Play%20Sessions/deleteMediaPlaySession

Ruutu APIs    

VersionTitleLifecycleDocumentationEOL
2.1Get a Ruutu session for the userEnd of LifeGet a Ruutu session for the userJune 2021
2.0Verify Ruutu AgreementEnd of LifeVerify Ruutu AgreementJune 2021
2.0Get user's Ruutu LicensesEnd of LifeGet user's Ruutu LicensesJune 2021

Server    

VersionTitleLifecycleDocumentation
2.0Get Server TimeCurrentGet Server Time
2.0TranslationEnd of Life
Translation
2.0Get Site ImagesEnd of Life
Get Site Images
2.0Application Languages ListEnd of Life
Application Languages List
2.0Configuration Option ListCurrentConfiguration Option List
2.0Detail of Configuration OptionCurrentDetail of Configuration Option
2.0GEO BlockingCurrentGEO Blocking
2.0VAST AdsEnd of LifeVAST Ads
2.0Get server healthCurrentGet server health

Social Media    

VersionTitleLifecycleDocumentation
2.0LoginEnd of LifeLogin
No versionLogoutEnd of LifeLogout
2.0Proxy LoginEnd of LifeProxy Login
2.0TwitterEnd of LifeTwitter

Playback info    

VersionTitleLifecycleDocumentationEOL
4.0Populate playback infoCurrentPlayback Info#/Playback%20Info/putPlaybackInfo
4.0Get the current playback info for a given assetCurrentPlayback Info#/Playback%20Info/getPlaybackInfo
4.0Get the list of playback info items per asset typeCurrentPlayback Info#/Playback%20Info/getPlaybackInfoIndex
2.0Create Playback stats logEnd of Life
Create Playback stats logJune 2021


STB authentication and functionality    

VersionTitleLifecycleDocumentationEOL
2.1STB AuthenticationEnd of Life
STB AuthenticationJune 2021
2.0Refresh TokenEnd of Life
Refresh TokenJune 2021
2.0Link STB to UserEnd of Life
Link STB to UserJune 2021
2.0Remove STB Ownership from an UserEnd of Life
Remove STB Ownership from an UserJune 2021
2.0Logout STBEnd of Life
Logout STBJune 2021


User favourite channels

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


User    

VersionTitleLifecycleDocumentationEOL
4.0Update an user accountCurrentUser information v2#/User%20Preferences/updateUser
4.0Request a password resetCurrentUser information v2#/Password%20Reset/requestResetPassword
4.0Confirm password resetCurrentUser information v2#/Password%20Reset/confirmResetPassword
REST 1.0

Get the details for a particular user (accepts id or email as identifier)

End of LifeUser information v1#/Users/getUserJune 2021
REST 1.0

Update a user

End of LifeUser information v1#/Users/getUserJune 2021
2.0User RegistrationEnd of Life
User RegistrationJune 2021
1.0Get UsersEnd of Life
Get UsersJune 2021
1.0Get User By IDEnd of Life
Get User By IDJune 2021
2.0PIN Code VerificationEnd of LifePIN Code VerificationJune 2021
2.0PIN Code Reset RequestEnd of Life
PIN Code Reset RequestJune 2021
2.0PIN Code Reset/UpdateEnd of Life
PIN Code Reset/UpdateJune 2021
2.0Parental PIN Code Reset/UpdateEnd of Life
Parental PIN Code Reset/UpdateJune 2021
2.0Verify Parental PIN CodeEnd of Life
Verify Parental PIN CodeJune 2021
2.0Parental PIN code reset requestEnd of Life
Parental PIN code reset requestJune 2021
2.0Get age limitEnd of Life
Get age limitJune 2021
2.0Set age limitEnd of Life
Set age limitJune 2021


DRM

VersionTitleLifecycleDocumentationEOL
4.0EZDRM verify playback requestCurrent/wiki/spaces/MAPI/pages/49676985
2.0Associate User with STBDeviceEnd of LifeAssociate User with STBDeviceJune 2021
REST 1.0Entitle a set top box to watch DVB channelsPlanned/wiki/spaces/MAPI/pages/49676635
REST 1.0

Remove entitlement from set top box

Planned/wiki/spaces/MAPI/pages/49676635
2.0Registers Device player's DRM idEnd of LifeRegisters Device player's DRM idJune 2021


VoD    

VersionTitleLifecycleDocumentationEOL
4.0Program metadata (REST)CurrentMetadata: Programs
4.0Genres (REST)CurrentMetadata: Genres
4.0Seasons (REST)Planned/wiki/spaces/MAPI/pages/49676898
2.0List of ProgramsEnd of LifeList of ProgramsJune 2021
2.0Detail of ProgramEnd of LifeDetail of ProgramJune 2021
2.0List of GenresEnd of LifeList of GenresJune 2021
2.0Detail of GenreEnd of LifeDetail of GenreJune 2021
2.0List of SeasonsEnd of LifeList of SeasonsJune 2021
2.0Detail of SeasonEnd of LifeDetail of SeasonJune 2021
2.0Mark/Unmark a VOD Program as FavoriteEnd of LifeMark/Unmark a VOD Program as FavoriteJune 2021
2.0Play VoD ContentEnd of LifePlay VoD ContentJune 2021
2.0Play VOD TrailerEnd of LifePlay VOD TrailerJune 2021
2.0Import XML of VODEnd of LifeImport XML of VODJune 2021


Wallet    

VersionTitleLifecycleDocumentationEOL
2.0List of WalletsEnd of LifeList of WalletsJune 2021
2.0Details of WalletEnd of LifeDetails of WalletJune 2021
2.0Transactions ListEnd of LifeTransactions ListJune 2021
2.0Transaction DetailEnd of LifeTransaction DetailJune 2021
2.0Charge Product ListEnd of LifeCharge Product ListJune 2021
2.0Charge Product DetailEnd of LifeCharge Product DetailJune 2021
2.0Buy ProductEnd of LifeBuy ProductJune 2021
2.0Charge Wallet with Credit CardEnd of LifeCharge Wallet with Credit CardJune 2021
2.0Charge Wallet with VoucherEnd of LifeCharge Wallet with VoucherJune 2021
2.0Apple Receipt VerificationEnd of LifeApple Receipt VerificationJune 2021