Versions Compared

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

EntityPurpose
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

EndpointHTTP methodPurpose
/api/license/v4/users/{user_id}POSTIssue a license to a user. This implies some method of payment is provided.

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.