Current version lifecycle
Category
Version | Endpoint | Lifecycle | Documentation |
---|---|---|---|
No version | List of categories | Deprecated | List of Categories |
Channel
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 | User specified favourite channel lists (REST) | Current | Favourite channel lists |
4.0 | Channels | Planned | Schedule#/Channels/GetChannelsIndex |
4.0 | Channel details | Planned | Schedule#/Channels/GetChannelById |
3.1 | User specific channels | End of Life | User specific channels (v3.1) |
3.1 | List of channels | End of Life | List of Channels (v3.1) |
2 | List of channels | Deprecated | List of Channels (v2) |
2 | Details of channel | Deprecated | Details of Channel (v2) |
2 | Play channel | Deprecated | PlayableStream |
2.0 | Mark/unmark channel as favourite | Deprecated | Mark/unmark channel as favourite |
1.0 | Play Channel | End of Life | Play Channel (deprecated) |
1.0 | Adding Channels to be Recorded | End of Life | Adding Channels to be Recorded |
EPG
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 | Broadcast slots | Current | Schedule#/Broadcast%20Slots/GetBroadcastSlotsIndex |
4.0 | Broadcast slot details | Current | Schedule#/Broadcast%20Slots/GetBroadcastSlotById |
3.0 | EPG List V3 | Deprecated | EPG List V3 |
3.0 | EPG Program Details V3 | Deprecated | EPG Program Details V3 |
No version | EPG List V2 | End of Life | EPG List V2 |
2.0 | EPG V2 - Program Details | End of Life | EPG V2 - Program Details |
2.0 | List of top recordings | Deprecated | List of top recordings |
4 | Get a list of broadcast slots | Planned | Schedule#/BroadcastSlots/GetBroadcastSlotsIndex |
4 | Get a list of programs with basic metadata | Planned | Metadata: Programs#/Programs/GetProgramIndex |
4 | Get details for a specific program including rich metadata relationships | Planned | Metadata: Programs#/Programs/GetProgram |
4 | Get a list of genres | Planned | Metadata: Genres#/Genres/indexGenres |
4 | Get a list of programs for a particular genre | Planned | Metadata: Genres#/Genres/SeeGenrePrograms |
4 | Get list of programs for a credited person | Planned | /wiki/spaces/MAPI/pages/49676902 |
Teletext
Version | Title | Lifecycle | Documentation |
---|---|---|---|
2.0 | Teletext Page Item | Deprecated | Teletext Page Item |
2.0 | Teletext SubPage Item | Deprecated | Teletext SubPage Item |
2.0 | TeleText SubPage Index | Deprecated | Teletext SubPage Index |
2.0 | TeleText Create | Deprecated | Teletext Create |
Product and Licensing
Version | Title | Lifecycle | Documentation |
---|
4.0 |
Get list of user's active licenses | Current | User licenses v4#/License/GetUserLicenses | |
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 |
Remove entitlement from set top box
Product and Licensing
Purchase a new license for the user | Current | User licenses v4#/License/PurchaseUserLicense | |||
4.0 | Get a list of products visible to the user | Current | User licenses v4#/Product/GetAllProducts | ||
4.0 | Get list of user's active licenseslicenses with a filter (management) | Current | User licenses Management Licenses v4#/License/GetUserLicensesGetLicenses | ||
4.0 | Purchase Create a new license for the user(management) | Current | User licenses Management Licenses v4#/License/PurchaseUserLicenseCreateLicense | ||
4.0 | Get a list of products visible to the userlicense (management) | Current | User licenses Management Licenses v4#/ProductLicense/GetAllProductsGetLicenseById | ||
4.0 | Get licenses withDelete a | filterlicense (management) | Current | Management Licenses v4#/License/ | GetLicensesDeleteLicenseById |
4.0 | Create a new licenseBatch create licenses (management) | Current | Management Licenses v4#/License/ | CreateLicenseBatchCreateLicenses | |
4.0 | Get a license Batch delete licenses (management) | Current | Management Licenses v4#/License/GetLicenseByIdBatchDeleteLicenses | ||
4.0 | Delete a license all user's licenses (management) | Current | Management Licenses v4#/License/DeleteLicenseByIdBatchDeleteAllUserLicenses | ||
4.0 | Batch create Get all user's licenses (management) | Current | Management Licenses v4#/License/BatchCreateLicensesGetLicensesByUser | ||
4.0 | Batch delete licenses Get all products (management) | Current | Management Licenses v4#/LicenseProduct/BatchDeleteLicensesGetAllProducts | ||
4.0 | Delete all user's licenses Create a new product (management) | Current | Management Licenses v4#/LicenseProduct/BatchDeleteAllUserLicensesCreateProduct | ||
4.0 | Get all user's licenses product details (management) | Current | Management Licenses v4#/LicenseProduct/GetLicensesByUserGetProductById | ||
4.0 | Get all products Update product (management) | Current | Management Licenses v4#/Product/GetAllProductsUpdateProduct | ||
4.0 | Create Delete a new product (management) | Current | Management Licenses v4#/Product/CreateProductDeleteProductById4 | ||
2.0 | Get product details (management) | Current | Management Licenses v4#/Product/GetProductById | ||
4.0 | Update product (management) | Current | Management Licenses v4#/Product/UpdateProduct | ||
4.0 | Delete a product (management) | Current | Management Licenses v4#/Product/DeleteProductById | ||
2.0 | List of Products | List of Products | Deprecated | List of Products | |
1.1 | List of external VOD Products | Deprecated | List of external VOD Products | ||
2.0 | Details of Products | Deprecated | Details of Products | ||
2.0 | Product Buy Options | Deprecated | Product Buy Options | ||
2.0 | Buy a Product | Deprecated | Buy a Product | ||
2.0 | List of Licenses | Deprecated | List of Licenses | ||
2.0 | Details of License | Deprecated | Details of License | ||
2.0 | Update License | Deprecated | Update License | ||
No version | Check License Status | Deprecated | Check License Status | ||
No version | Verify App-Store Payment | Deprecated | Verify App-Store Payment | ||
2.0 | Verify Credit Card | Deprecated | Verify Credit Card | ||
2.0 | Booxmedia Product Details | Deprecated | Booxmedia Product Details | ||
2.2 | JWT token for VOD provider product license | Deprecated | JWT token for VOD provider product license | ||
2.0 | SilverHD license | Deprecated | SilverHD license | ||
2.0 | Activate Gameleo license | Deprecated | Activate Gameleo license |
User Management
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 | Get an index of Users (management) | Planned | Users#/Users/indexUsers |
4.0 | Create a user (management) | Planned | Users#/Users/createUser |
4.0 | Get the details for a particular user (management) | Planned | Users#/Users/getUser |
4.0 | Add user flag (management) | Current | Users#/User%20Flags/addUserFlag |
4.0 | Remove user flag (management) | Current | Users#/User%20Flags/deleteUserFlag |
4.0 | User market segmentation (management) | Current | Users#/Market%20Segmentation/getUserMarketSegments |
4.0 | Update user's market segmentation (management) | Current | Users#/Market%20Segmentation/createUserMarketSegments |
4.0 | User market segmentation | Current | Market segmentation#/Market%20Segmentation/getUserMarketSegments |
4.0 | User login and access tokens | Current | User Authentication#/Account%20Authentication/createAccessToken |
4.0 | Device Authorization | Planned | User Authentication#/Device%20Authorization/createUserCode |
4.0 | Device Authorization verification | Planned | User Authentication#/Device%20Authorization/verifyUserCode |
2.0 | User Login | Deprecated | User Login |
2.0 | User Logout | Deprecated | User Logout |
2.0 | List of Users | Deprecated | List of Users |
2.0 | Add New User Account | Deprecated | Add New User Account |
2.0 | Edit Existing User Account | Deprecated | Edit Existing User Account |
2.0 | Delete User Account | Deprecated | Delete User Account |
2.0 | Request Account Password Reset | Deprecated | Request Account Password Reset |
2.0 | Confirm Account Password Reset | Deprecated | Confirm Account Password Reset |
2.0 | Delete User Account | Deprecated | Delete User Account |
2.0 | Add User Alias | End of Life | Add User Alias |
2.0 | Change User Alias | End of Life | Change User Alias |
2.0 | Delete User Alias | End of Life | Delete User Alias |
2.0 | Link User with User Alias | End of Life | Link User with User Alias |
2.0 | Associate Package with User Alias | End of Life | Associate Package with User Alias |
2.0 | Change Associated Package | End of Life | Change Associated Package |
2.0 | Add Additional Service | Deprecated | Add Additional Service |
2.0 | Get Service Status | Deprecated | Get Service Status |
2.0 | Logged In User's Service Status | End of Life | Logged In User's Service Status |
2.0 | Update User Service Settings | End of Life | Update User Service Settings |
2.0 | Get User Service Details | End of Life | Get User Service Details |
2.0 | Delete Additional Service | Deprecated | Delete Additional Service |
2.0 | Player Consume Minutes | Deprecated | Player Consume Minutes |
2.0 | Get Consumed Minutes | Deprecated | Get Consumed Minutes |
2.0 | Add STB | Deprecated | Add STB |
2.0 | Link STB to User | Deprecated | Link STB to User |
2.0 | Remove STB Ownership from an User | Deprecated | Remove STB Ownership from an User |
2.0 | OAuth2 User Login (Delta) | Deprecated | OAuth2 User Login (Delta) |
Recording
Version | Title | Lifecycle | Documentation | |
---|---|---|---|---|
4.0 | Get a list of popular recordings | Current | Recordings v4#/Recordings/getMostPopularBroadcastSlots | |
4.0 | Search for recordings of a given user profile | Current | Recordings v4#/Recordings/searchRecordedSlots | |
4.0 | Create a recording | Current | Recordings v4#/Recordings/createRecordedSlot | |
4.0 | Update a recording | Current | Recordings v4#/Recordings/updateRecordedSlot | |
4.0 | Delete a recording | Current | Recordings v4#/Recordings/deleteRecordedSlot | |
4.0 | Batch delete recordings | Current | Recordings v4#/Recordings/batchDeleteRecordedSlots | |
4.0 | List all recorded broadcast slots | Current | Recordings v4#/Recordings/recordedBroadcastSlots | |
4.0 | User's recording storage quota | Current | Recordings v4#/Recordings/storageQuota | |
4.0 | List all automated recordings requests for a given user profile | Current | Recordings v4#/Automated%20Recording%20Requests/indexRecordingRequests | |
4.0 | Create an automated recording request | Current | Recordings v4#/Automated%20Recording%20Requests/createRecordingRequest | |
4.0 | Update an automated recording request | Current | Recordings v4#/Automated%20Recording%20Requests/updateRecordingRequests | |
4.0 | Delete an automated recording request | Current | Recordings v4#/Automated%20Recording%20Requests/deleteRecordingRequests | |
4.0 | List all recording groups for a given user profile | Current | Recordings v4#/Recording%20Groups/indexRecordingGroups | |
4.0 | List all recordings for a specific recording group | Current | Recordings v4#/Recording%20Groups/getRecordingsForGroup | |
4.0 | List all recording which do not belong to a group | Current | Recordings v4#/Recording%20Groups/indexUngroupedRecordingGroupRecordings | |
REST 1.0 | Update one or more attributes of an existing entity | Deprecated | /wiki/spaces/MAPI/pages/49676468 | |
REST 1.0 | Get a list of recordings that have previously been started | Deprecated | /wiki/spaces/MAPI/pages/49676468 | |
2.0 | Recording item | Deprecated | Recording item | |
2.3 | Add Program for Recording | Deprecated | Add Program for Recording | |
2.3 | Play user recording | Deprecated | Play user recording in favour of PlayableStream related to Recording | |
2.0 | Logging User Playback | Deprecated | Logging User Playback | |
2.3 | Update Recorded Content | Deprecated | Update Recorded Content | |
2.3 | Delete Recorded Content | Deprecated | Delete Recorded Content | |
2.3 | Search Recorded Content | Deprecated | Search Recorded Content | |
2.0 | Get list of playheads | Deprecated | Get list of playheads | |
2.0 | Get specific playhead | Deprecated | Get specific playhead | |
2.0 | Update Recording Playback position | Deprecated | Update Recording Playback position | |
2.0 | List of | FavoriteFavourite Recordings | Deprecated | List of Favorite Recordings |
2.0 | Update multiple user favourites | Deprecated | Update multiple user favourites | |
2.2 | Delete Grouped Recorded Content | Deprecated | Delete Grouped Recorded Content | |
1.0 | List Programs in a Recording Group V1 | Deprecated | List Programs in a Recording Group V1 | |
1.0 | List Recording Groups and Single Programs V1 | Deprecated | List Recording Groups and Single Programs V1 | |
2.1 | List Recording Groups and Single Programs V2 | Deprecated | List Recording Groups and Single Programs V2 | |
No version | List Programs in a Recording Group V2 | Deprecated | List Programs in a Recording Group V2 | |
1.2 | .0Catchup Program | Deprecated | Catchup Program | |
2.0 | Catchup Groups collection | Deprecated | Catchup Groups collection | |
2.0 | Catchup Group item | Deprecated | Catchup Group item | |
2.1 | Logging Catchup Playback | Deprecated | Logging Catchup Playback | |
1.2 | PatchPatch User Recordings | Deprecated | Patch User Recordings | |
1.1 | Get Continue Watching Recordings | Deprecated | Get Continue Watching Recordings | |
1.1 | Get User Recordings | Deprecated | Get User Recordings | |
2.0 | User Recording Storage | Deprecated | User Recording Storage |
Catchup
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 |
List catchup programs | Current |
/wiki/spaces/MAPI/pages/49676422 |
4.0 |
List most popular catchup programs | Current |
Playable streams
/wiki/spaces/MAPI/pages/49676422 | |||
2.0 | Catchup Program | Deprecated | Catchup Program |
2.0 | Catchup Groups collection | Deprecated | Catchup Groups collection |
2.0 | Catchup Group item | Deprecated | Catchup Group item |
2.1 | Logging Catchup Playback | Deprecated | Logging Catchup Playback |
Playable streams
Version | Title | Lifecycle | Documentation |
---|---|---|---|
24.1 | Get a Ruutu session for the user | Current | Get a Ruutu session for the user |
2.0 | Verify Ruutu Agreement | Current | Verify Ruutu Agreement |
2.0 | Get user's Ruutu Licenses | Current | Get user's Ruutu Licenses |
Server
0 | Live streams | Current | PlayableStream related to Channel (live)#/Stream/getChannelStreams |
4.0 | Recordings streams | Current | PlayableStream related to Recording#/Stream/getChannelStreams |
4.0 | Catchup streams | Current | PlayableStream related to Catchup |
4.0 | List user's active media play sessions | Current | Media play sessions#/Media%20Play%20Sessions/indexMediaPlaySession |
4.0 | Create a new media play session | Current | Media play sessions#/Media%20Play%20Sessions/postMediaPlaySession |
4.0 | Create or update an existing media play session | Current | Media play sessions#/Media%20Play%20Sessions/putMediaPlaySession |
4.0 | Update an existing media play session | Current | Media play sessions#/Media%20Play%20Sessions/patchMediaPlaySession |
4.0 | Delete a media play session | Current | Media play sessions#/Media%20Play%20Sessions/deleteMediaPlaySession |
Ruutu APIs
Version | Title | Lifecycle | Documentation |
---|---|---|---|
2.1 | Get a Ruutu session for the user | End of Life | Get a Ruutu session for the user |
2.0 | Verify Ruutu Agreement | End of Life | Verify Ruutu Agreement |
2.0 | Get user's Ruutu Licenses | End of Life | Get user's Ruutu Licenses |
Server
Version | Title | Lifecycle | Documentation |
---|---|---|---|
2.0 |
Get Server Time | Current | Get Server Time | |
2.0 | Translation | Deprecated | Translation |
2.0 |
Get Site Images | Deprecated | Get Site Images |
2.0 |
Stats
Application Languages List | Deprecated | Application Languages List | |
2.0 | Configuration Option List | Current | Configuration Option List |
2.0 |
Detail of Configuration Option | Current |
STB authentication and functionality
Detail of Configuration Option | |||
2.0 | GEO Blocking | Current | GEO Blocking |
2. |
0 |
VAST Ads |
Deprecated |
VAST Ads |
2.0 |
Get server health | Current |
Get server health |
Social Media
Version | Title | Lifecycle | Documentation |
---|---|---|---|
2.0 |
Login | End of Life | Login | |
No version | Logout | End of Life | Logout |
2.0 | Proxy Login | End of Life | Proxy Login |
2.0 | End of Life |
Playback info
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 |
Populate playback info | Current |
Playback Info#/Playback%20Info/putPlaybackInfo |
4.0 |
Get the current playback info for a given asset | Current |
Playback Info#/Playback%20Info/getPlaybackInfo |
4.0 |
Get the list of playback info items per asset type | Current |
Playback Info#/Playback%20Info/getPlaybackInfoIndex | |||
2.0 | Create Playback stats log | Deprecated | Create Playback stats log |
STB authentication and functionality
Version | Title | Lifecycle | Documentation |
---|---|---|---|
2.1 | STB Authentication | Deprecated | STB Authentication |
2.0 | Refresh Token | Deprecated | Refresh Token |
2.0 | Link STB to User | Deprecated | Link STB to User |
2.0 | Remove STB Ownership from an User | Deprecated | Remove STB Ownership from an User |
2.0 | Logout STB | Deprecated | Logout STB |
User favourite channels
User
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 |
Update an user account | Current |
User information v2#/User%20Preferences/updateUser |
4.0 |
Request a password reset | Current |
User information v2#/Password%20Reset/requestResetPassword |
4.0 |
Confirm password reset | Current |
User
User information v2#/Password%20Reset/confirmResetPassword | |
REST 1.0 | Get the details for a particular user (accepts id or email as identifier) |
Deprecated | User information v1#/Users/getUser | ||
REST 1.0 | Update a user | Deprecated | User information v1#/Users/getUser |
2.0 | User Registration |
Deprecated | User Registration |
1.0 | Get Users |
Deprecated | Get Users |
1.0 | Get User By ID |
Deprecated | Get User By ID |
2.0 | PIN Code Verification |
Deprecated | PIN Code Verification |
2.0 | PIN Code Reset Request |
Deprecated | PIN Code Reset Request |
2.0 | PIN Code Reset/Update |
Deprecated | PIN Code Reset/Update |
2.0 | Parental PIN Code Reset/Update |
Deprecated | Parental PIN Code Reset/Update |
2.0 | Verify Parental PIN Code |
Deprecated | Verify Parental PIN Code |
2.0 | Parental PIN code reset request |
Deprecated | Parental PIN code reset request | ||
2.0 | Get age limit | Deprecated | Get age limit |
2.0 | Set age limit | Deprecated | Set age limit |
DRM
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 | EZDRM verify playback request | Current | /wiki/spaces/MAPI/pages/49676985 |
2.0 |
Verimatrix APIs for DRM content
Version | Title | Lifecycle | DocumentationAssociate User with STBDevice | Deprecated | Associate User with STBDevice |
---|---|---|---|---|---|
REST 1.0 | Entitle a set top box to watch DVB channels | Planned | /wiki/spaces/MAPI/pages/49676635 | ||
REST 1.0 | Remove entitlement from set top box | Planned | /wiki/spaces/MAPI/pages/49676635 | ||
2.0 | Registers Device player's DRM id | CurrentDeprecated | Registers Device player's DRM id |
VoD
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 | Program metadata (REST) | Current | Metadata: Programs |
4.0 | Genres (REST) | Current | Metadata: Genres |
4.0 | Seasons (REST) | CurrentPlanned | /wiki/spaces/MAPI/pages/49676898 |
2.0 | List of Programs | End of Life | List of Programs |
2.0 | Detail of Program | End of Life | Detail of Program |
2.0 | List of Genres | End of Life | List of Genres |
2.0 | Detail of Genre | End of Life | Detail of Genre |
2.0 | List of Seasons | End of Life | List of Seasons |
2.0 | Detail of Season | End of Life | Detail of Season |
2.0 | Mark/Unmark a VOD Program as Favorite | End of Life | Mark/Unmark a VOD Program as Favorite |
2.0 | Play VoD Content | End of Life | Play VoD Content |
2.0 | Play VOD Trailer | End of Life | Play VOD Trailer |
2.0 | Import XML of VOD | End of Life | Import XML of VOD |
Wallet
Version | Title | Lifecycle | Documentation | ||||
---|---|---|---|---|---|---|---|
2.0 | List of Wallets | End of Life | List of Wallets | ||||
2.0 | Details of Wallet | End of Life | Details of Wallet | ||||
2.0 | Transactions List | End of Life | Transactions List | ||||
2.0 | Transaction Detail | End of Life | Transaction Detail | ||||
2.0 | Charge Product List | End of Life | Charge Product List | ||||
2.0 | Charge Product Detail | End of Life | Charge Product Detail | 2.0 | Buy Product | End of Life | Buy ProductTransaction Detail |
2.0 | Charge Wallet with Credit CardProduct List | End of Life | Charge Wallet with Credit CardProduct List | ||||
2.0 | Charge | Wallet with VoucherProduct Detail | End of Life | Charge | Wallet with VoucherProduct Detail | ||
2.0 | Apple Receipt VerificationBuy Product | End of Life | Apple Receipt Verification |
Stream (replaces "play" endpoints)
Buy Product | |||
2.0 | Charge Wallet with Credit Card | End of Life | Charge Wallet with Credit Card |
2.0 | Charge Wallet with Voucher | End of Life | Charge Wallet with Voucher |
2.0 | Apple Receipt Verification | End of Life | Apple Receipt Verification |
Authentication / Session management
Version | Title | Lifecycle | Documentation |
---|---|---|---|
4.0 | Create a user session ("login") in the middleware and receive a session cookie | Planned | User login#/User%20Session/createUserSession |
4.0 | Delete a user session in the middleware ("logout") | Planned | User login#/User%20Session/deleteUserSession |