Streams v4 API

Introduction

This section describes BSS communication with AminoTV Streams v4 API. Products and user licenses are manageable through License Management API. 

The license management API consist of two parts: licenses management and products management. No caching is used with those endpoints.

In order to use a service, the client must first be issued an API key.

Entities overview

The resources descriptions could be found on API documentation page Streams v4 under schemas section.

StreamResource

Typical stream resource may look like the one below.

{
    "id": "live-100001-hls",
    "type": "Stream",
    "attributes": {
        "type": "hls",
        "url": "https://org-01.amino.tv/drm/ezdrm.isml/playlist.m3u8",
        "drm": {
            "provider": "EZDRM",
            "fairplay": {
                "content_id": "2484bd14-0000-0000-0000-5c89a289d7c5",
                "la_url": "https://fps.ezdrm.com/api/licenses/2484bd14-0000-0000-0000-5c89a289d7c5",
                "cert": "https://org-01.amino.tv/fairplay.cer"
            },
            "widevine": {
                "content_id": "WTJoaGJtNWxiweE53PT0=",
                "la_url": "https://widevine-dash.ezdrm.com/proxy?pX=000000"
            },
            "playready": {
                "content_id": "WTJoaGJtNWxiweE53PT0=",
                "la_url": "https://playready.ezdrm.com/cency/preauth.aspx?pX=000000"
            }
        }
    }
}

DRM providers support

Irdeto integration

If Irdeto DRM and rights management integration is enabled for customer environment then all the calls which create/delete licenses will force Irdeto entitlements creation/deletion. 

The management of Irdeto products is not supported within this API, which means that client is obligated to take care of creating/deleting needed products by themselves.

Postman collection

<todo: postman_collection.tar.gz>

Postman collection was created which can be used to explore API, use cases and has possibility to configure it to use with client environment or with mocked environment:  

In the archive there is a collection itself and example mock environment. Both need to be imported into postman.

The collection consists of 3 folders:

API spec - just a plain listing of all available calls, those are not mocked.

UseCase - the folder contains typical API use cases, all of those are mocked and contain complete examples with requests and responses.