Versions Compared

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.

Table of Contents

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

State

Version
Current
Endpoint
2
Lifecycle
Deprecated
Documentation
-
Not versioned
End
List of
Life
categories
-
Current
Server authentication
Jenkins
State

Channel

Version
Current
Title
2
Lifecycle
Deprecated
Documentation
-End of Life-

JWT

StateVersionCurrent2Deprecated-End of Life-

Channel

StateVersionCurrent2Deprecated-End of Life-

Teletext

StateVersionCurrent2Deprecated-End of Life-

EPG

StateVersionCurrent3Deprecated2End of Life-

Irdeto Integration    

StateVersionCurrent2Deprecated-End of Life-

Product and Licensing    

StateVersionCurrent2Deprecated-End of Life-

User Management    

StateVersionCurrent2Deprecated-End of Life-

Notification    

StateVersionCurrent2Deprecated-End of Life-

Push Notifications    

StateVersionCurrent2Deprecated-End of Life-

Recommendation    

StateVersionCurrent2Deprecated-End of Life-

Recording    

StateVersionCurrent2Deprecated-End of Life-

Ruutu APIs    

StateVersionCurrent2Deprecated-End of Life-

Server    

StateVersionCurrent2Deprecated-End of Life-

Social Media    

StateVersionCurrent2Deprecated-End of Life-

Stats    

StateVersionCurrent2Deprecated-End of Life-

STB authentication and functionality    

StateVersionCurrent2Deprecated-End of Life-

User    

StateVersionCurrent2Deprecated-End of Life-

Verimatrix APIs for DRM content    

StateVersionCurrent2Deprecated-End of Life-

VoD    

StateVersionCurrent2Deprecated-End of Life-

Wallet    

StateVersionCurrent2Deprecated-End of Life-

Stream    

StateVersionCurrent2Deprecated-End of Life-
4Channel indexPlannedJenkins
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


Irdeto Integration    


Product and Licensing    


User Management    


Notification    


Push Notifications    


Recommendation    


Recording    


Ruutu APIs    


Server    


Social Media    


Stats    


STB authentication and functionality    


User    


Verimatrix APIs for DRM content    


VoD    


Wallet    


Stream