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
4	User specified favourite channel lists (REST)	Planned	Favourite channel lists
4	Channel index (REST)	Planned	Jenkins
3.1	User specific channels	Current
3.1	List of channels	Current
3	List of channels	Supported
2	List of channels	Deprecated
2	Details of channel	Current
2	Play channel	Deprecated	PlayableStream

Teletext

Version	Title	Lifecycle	Documentation
2.0	Teletext Page Item	Current	Jenkins
2.0	Teletext SubPage Item	Current
2.0	TeleText SubPage Index	Current
2.0	TeleText Create	Current

EPG

Version	Title	Lifecycle	Documentation
4.0	Schedule (REST)	Planned	Schedule
4.0	Program metadata (REST)	Planned	Metadata: Programs
3.1	EPG List V3	Current	EPG List V3
3.0	EPG Program Details V3	Current	EPG Program Details V3
No version	EPG List V2	Deprecated	EPG List V2
2.0	EPG V2 - Program Details	Deprecated	EPG V2 - Program Details
2.0	List of top recordings	Current	List of top recordings
4.0	Genres	Planned	Metadata: Genres
4.0	Seasons	Planned	/wiki/spaces/MAPI/pages/49676898
4.0	Series	Planned	Metadata: Series
4.0	CreditedPerson	Planned	/wiki/spaces/MAPI/pages/49676902

Irdeto Integration

Version	Title	Lifecycle	Documentation
2.0	Associate User with STBDevice	Current	Associate User with STBDevice

Product and Licensing

Version	Title	Lifecycle	Documentation
4.0	Channel License (REST)	Planned	Channel License
2.0	List of Products	Current	List of Products
1.1	List of external VOD Products	Current	List of external VOD Products
2.0	Details of Products	Current	Details of Products
2.0	Product Buy Options	Current	Product Buy Options
2.0	Buy a Product	Current	Buy a Product
2.0	List of Licenses	Current	List of Licenses
2.0	Details of License	Current	Details of License
2.0	Update License	Current	Update License
No version	Check License Status	Current	Check License Status
No version	Verify App-Store Payment	Current	Verify App-Store Payment
2.0	Verify Credit Card	Current	Verify Credit Card
2.0	Booxmedia Product Details	Current	Booxmedia Product Details
2.2	JWT token for VOD provider product license	Current	JWT token for VOD provider product license
2.0	SilverHD license	Current	SilverHD license
2.0	Activate Gameleo license	Current	Activate Gameleo license

User Management

Version	Title	Lifecycle	Documentation
4.0	User administration (REST)	Planned	Users
4.0	User Market segmentation (REST)	Planned	Users
2.0	User Login	Current	User Login
2.0	User Logout	Current	User Logout
2.0	List of Users	Current	List of Users
2.0	Add New User Account	Current	Add New User Account
2.0	Edit Existing User Account	Current	Edit Existing User Account
2.0	Delete User Account	Current	Delete User Account
2.0	Request Account Password Reset	Current	Request Account Password Reset
2.0	Confirm Account Password Reset	Current	Confirm Account Password Reset
2.0	Delete User Account	Current	Delete User Account
2.0	Add User Alias	Current	Add User Alias
2.0	Change User Alias	Current	Change User Alias
2.0	Delete User Alias	Current	Delete User Alias
2.0	Link User with User Alias	Current	Link User with User Alias
2.0	Associate Package with User Alias	Current	Associate Package with User Alias
2.0	Change Associated Package	Current	Change Associated Package
2.0	Add Additional Service	Current	Add Additional Service
2.0	Get Service Status	Current	Get Service Status
2.0	Logged In User's Service Status	Current	Logged In User's Service Status
2.0	Update User Service Settings	Current	Update User Service Settings
2.0	Get User Service Details	Current	Get User Service Details
2.0	Delete Additional Service	Current	Delete Additional Service
2.0	Player Consume Minutes	Current	Player Consume Minutes
2.0	Get Consumed Minutes	Current	Get Consumed Minutes
2.0	Add STB	Current	Add STB
2.0	Link STB to User	Current	Link STB to User
2.0	Remove STB Ownership from an User	Current	Remove STB Ownership from an User
2.0	OAuth2 User Login (Delta)	Current	OAuth2 User Login (Delta)

Recommendation

Version	Title	Lifecycle	Documentation
4.0	User recommendations (REST)	Planned	/wiki/spaces/MAPI/pages/49676845
4.0	User event (REST)	Planned	/wiki/spaces/MAPI/pages/49676845
2.0	List of Recommendations	Current	List of Recommendations
2.0	List of Recommendations for Movies	Current	List of Recommendations for Movies
2.0	List of Recommendations for Season	Current	List of Recommendations for Season
2.0	List of Recommendations for Series	Current	List of Recommendations for Series
2.0	List of Recommendations for Episode	Current	List of Recommendations for Episode
2.0	List of Recommendations for Recording	Current	List of Recommendations for Recording

Recording

Version	Title	Lifecycle	Documentation
4.0	User recording playable streams	Current	PlayableStream related to Recording
4.0	User recordings (REST)	Planned	/wiki/spaces/MAPI/pages/49676468
4.0	User recording Tags (REST)	Planned	/wiki/spaces/MAPI/pages/49676468
	Recording item		Recording item
	Add Program for Recording		Add Program for Recording
	Play user recording	Deprecated	Play 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 list of playheads
	Get specific playhead		Get specific playhead
	Update Recording Playback position		Update Recording Playback position
	List of Favorite Recordings		List of Favorite Recordings
	Update multiple user favourites		Update multiple user favourites
	Delete Grouped Recorded Content		Delete Grouped Recorded Content
	List Recording Groups and Single Programs V1		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

Introduction

Phases of life

General philosophy

Current version lifecycle

Category

Channel

Teletext

EPG

Irdeto Integration

Product and Licensing

User Management

Recommendation

Recording

Ruutu APIs

Server

Social Media

Stats

STB authentication and functionality

User

Verimatrix APIs for DRM content

VoD

Wallet

Stream

Move API Lifecycle

Introduction

Phases of life

General philosophy

Current version lifecycle

Category

Channel

Teletext

EPG

Irdeto Integration

Product and Licensing

User Management

Recommendation

Recording

Ruutu APIs

Server

Social Media

Stats

STB authentication and functionality

User

Verimatrix APIs for DRM content

VoD

Wallet

Stream