Versions Compared

Version Old Version 9 New Version Current
Changes made by

Thomas Langenskiold

Thomas Langenskiold

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

User's access to services provided by the AminoTV API are handled by Licenses. In order to use a service, the user must first be issued a License to a Product granting access to the requested service.

Entities overview

See /wiki/spaces/MAPI/pages/49676828

Entity

Purpose

ProductA Product represents a collection of services to which a user may be granted access. Products are defined by the service provider.
License

A License grants access for one user to the services granted by one Product. A user may have several licenses. Licenses can be purchased, revoked and expired.

Purchasing

Endpoints overview

...

A user may purchase a License for themselves by calling the create license endpoint. In order to create a license, some method of payment must be provided. At the moment only one method of payment is supported: "billing". With this payment method, no further payment details are necessary, but the user is charged through the service provider's billing system.

Purchase restrictions

User restrictions

Some users may have restrictions set on their account that prevent them from making purchases. These users are marked with the user flag "LICENSE_PURCHASE_RESTRICTED". See User flags for more information.

Product restrictions

Only Products marked as "visible" may be purchased through the License v4 API. Other Products should not be shown to users as purchasable options.

Info

In Channel API v2, products including a listed channel is included in the response under the "categories" field. The "visible" field shows whether the Product is considered "visible".

The "price" field can be used to show the purchasing price of the product to the user.

Billing

...

There are different APIs used for issuing licenses to user and to manage licenses and products by BSS:

Child pages (Children Display)

Each API has same by meaning license and product resources but management API resources provide more data on represented object.

Licenses are immutable and won't change. In case client needs to introduce changes to existing licenses it must delete previous licenses and create new ones.

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

LicenseV4.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.

Helper -  contains auth request which could be used to obtain Bearer token which then can be used with later requests to real server. 


Table of Contents