Skip to end of banner
Go to start of banner

Move API Lifecycle

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 12 Next »

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.


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

User Login
User Login

User Logout
User Logout

List of Users
List of Users

Add New User Account
Add New User Account

Edit Existing User Account
Edit Existing User Account

Delete User Account
Delete User Account

Request Account Password Reset
Request Account Password Reset

Confirm Account Password Reset
Confirm Account Password Reset

Delete User Account
Delete User Account

Add User Alias
Add User Alias

Change User Alias
Change User Alias

Delete User Alias
Delete User Alias

Link User with User Alias
Link User with User Alias

Associate Package with User Alias
Associate Package with User Alias

Change Associated Package
Change Associated Package

Add Additional Service
Add Additional Service

Get Service Status
Get Service Status

Logged In User's Service Status
Logged In User's Service Status

Update User Service Settings
Update User Service Settings

Get User Service Details
Get User Service Details

Delete Additional Service
Delete Additional Service

Player Consume Minutes
Player Consume Minutes

Get Consumed Minutes
Get Consumed Minutes

Add STB
Add STB

Link STB to User
Link STB to User

Remove STB Ownership from an User
Remove STB Ownership from an User

OAuth2 User Login (Delta)
OAuth2 User Login (Delta)


Notification    


Push Notifications    


Recommendation    


Recording    


Ruutu APIs    


Server    


Social Media    


Stats    


STB authentication and functionality    


User    


Verimatrix APIs for DRM content    


VoD    


Wallet    


Stream    



  • No labels