Versions Compared

Version Old Version 16 New Version 17
Changes made by

Andy Beak (Unlicensed)

Andy Beak (Unlicensed)

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 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

VersionEndpointLifecycleDocumentation
Not versionedList of categoriesCurrentJenkins

Channel

VersionTitleLifecycleDocumentation
4User specified favourite channel lists (REST)PlannedFavourite channel lists
4Channel index (REST)PlannedJenkins
3.1User specific channelsCurrent
3.1List of channelsCurrent
3List of channelsSupported
2List of channelsDeprecated
2Details of channelCurrent
2Play channelDeprecatedPlayableStream


Teletext

VersionTitleLifecycleDocumentation
2.0Teletext Page ItemCurrentJenkins
2.0Teletext SubPage ItemCurrent
2.0TeleText SubPage IndexCurrent
2.0TeleText CreateCurrent


EPG

VersionTitleLifecycleDocumentation
4.0Schedule (REST)PlannedSchedule
4.0Program metadata (REST)PlannedMetadata: Programs
3.1EPG List V3CurrentEPG List V3
3.0EPG Program Details V3CurrentEPG Program Details V3
No versionEPG List V2DeprecatedEPG List V2
2.0EPG V2 - Program DetailsDeprecatedEPG V2 - Program Details
2.0List of top recordingsCurrentList of top recordings
4.0GenresPlannedMetadata: Genres
4.0SeasonsPlanned/wiki/spaces/MAPI/pages/49676898
4.0SeriesPlannedMetadata: Series
4.0CreditedPersonPlanned/wiki/spaces/MAPI/pages/49676902


Irdeto Integration    

VersionTitleLifecycleDocumentation
2.0Associate User with STBDeviceCurrentAssociate User with STBDevice


Product and Licensing    

VersionTitleLifecycleDocumentation
4.0Channel License (REST)PlannedChannel License
2.0List of ProductsCurrentList of Products
1.1List of external VOD ProductsCurrentList of external VOD Products
2.0Details of ProductsCurrentDetails of Products
2.0Product Buy OptionsCurrentProduct Buy Options
2.0Buy a ProductCurrentBuy a Product
2.0List of LicensesCurrentList of Licenses
2.0Details of LicenseCurrentDetails of License
2.0Update LicenseCurrentUpdate License
No versionCheck License StatusCurrentCheck License Status
No versionVerify App-Store PaymentCurrentVerify App-Store Payment
2.0Verify Credit CardCurrentVerify Credit Card
2.0Booxmedia Product DetailsCurrentBooxmedia Product Details
2.2JWT token for VOD provider product licenseCurrentJWT token for VOD provider product license
2.0SilverHD licenseCurrentSilverHD license
2.0Activate Gameleo licenseCurrentActivate Gameleo license


User Management    

VersionTitleLifecycleDocumentation
4.0User administration (REST)PlannedUsers
4.0User Market segmentation (REST)PlannedUsers
2.0User LoginCurrentUser Login
2.0User LogoutCurrentUser Logout
2.0List of UsersCurrentList of Users
2.0Add New User AccountCurrentAdd New User Account
2.0Edit Existing User AccountCurrentEdit Existing User Account
2.0Delete User AccountCurrentDelete User Account
2.0Request Account Password ResetCurrentRequest Account Password Reset
2.0Confirm Account Password ResetCurrentConfirm Account Password Reset
2.0Delete User AccountCurrentDelete User Account
2.0Add User AliasCurrentAdd User Alias
2.0Change User AliasCurrentChange User Alias
2.0Delete User AliasCurrentDelete User Alias
2.0Link User with User AliasCurrentLink User with User Alias
2.0Associate Package with User AliasCurrentAssociate Package with User Alias
2.0Change Associated PackageCurrentChange Associated Package
2.0Add Additional ServiceCurrentAdd Additional Service
2.0Get Service StatusCurrentGet Service Status
2.0Logged In User's Service StatusCurrentLogged In User's Service Status
2.0Update User Service SettingsCurrentUpdate User Service Settings
2.0Get User Service DetailsCurrentGet User Service Details
2.0Delete Additional ServiceCurrentDelete Additional Service
2.0Player Consume MinutesCurrentPlayer Consume Minutes
2.0Get Consumed MinutesCurrentGet Consumed Minutes
2.0Add STBCurrentAdd STB
2.0Link STB to UserCurrentLink STB to User
2.0Remove STB Ownership from an UserCurrentRemove STB Ownership from an User
2.0OAuth2 User Login (Delta)CurrentOAuth2 User Login (Delta)



Recommendation    

VersionTitleLifecycleDocumentation
4.0User recommendations (REST)Planned/wiki/spaces/MAPI/pages/49676845
4.0User event (REST)Planned/wiki/spaces/MAPI/pages/49676845
2.0List of RecommendationsCurrentList of Recommendations
2.0List of Recommendations for MoviesCurrentList of Recommendations for Movies
2.0List of Recommendations for SeasonCurrentList of Recommendations for Season
2.0List of Recommendations for SeriesCurrentList of Recommendations for Series
2.0List of Recommendations for EpisodeCurrentList of Recommendations for Episode
2.0List of Recommendations for RecordingCurrentList of Recommendations for Recording


Recording    

VersionTitleLifecycleDocumentation
4.0User recording playable streamsCurrentPlayableStream related to Recording
4.0User recordings (REST)Planned/wiki/spaces/MAPI/pages/49676468
4.0User recording Tags (REST)Planned/wiki/spaces/MAPI/pages/49676468

Recording item  Logging User Playback Update Recorded Content Delete Recorded Content Search Recorded Content item    Get list of playheads Get specific playhead Update Recording Playback position List of Favorite Recordings Update multiple user favourites Delete Grouped Recorded Content List Recording Groups and Single Programs V1 List Programs in a Recording Group V1 List Recording Groups and Single Programs V2 List Programs in a Recording Group V2 Catchup Program Catchup Groups collection Catchup Group item Logging Catchup Playback Patch User Recordings Get Continue Watching Recordings Get User Recordings User Recording Storage


Recording item

Add Program for Recording
Add Program for Recording

Play user recordingDeprecatedPlay user recording in favour of PlayableStream related to Recording

Logging User Playback
Logging User Playback

Update Recorded Content
Update Recorded Content

Delete Recorded Content
Delete Recorded Content

Search Recorded Content
Search Recorded Content



Get list of playheads



Get specific playhead



Update Recording Playback position



List of Favorite Recordings



Update multiple user favourites



Delete Grouped Recorded Content



List Programs in a Recording Group V1



List Recording Groups and Single Programs V1



List Recording Groups and Single Programs V2



List Programs in a Recording Group V2



Catchup Program



Catchup Groups collection



Catchup Group item



Logging Catchup Playback



Patch User Recordings



Get Continue Watching Recordings



Get User Recordings



User Recording Storage


Ruutu APIs    


Server    


Social Media    


Stats    


STB authentication and functionality    


User    


Verimatrix APIs for DRM content    


VoD    


Wallet    


Stream    




Play user recording