Versions Compared
| Version | Old Version 20 | New Version 21 |
|---|---|---|
| Changes made by | Former user |
Former user |
| Saved on |
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Introduction
This section describes BSS communication with AminoTV License 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.
Authorization
All BSS endpoint support API key authorization. The header named 'Authorization' with content "Apikey PUT_YOUR_KEY_HERE" must be passed with request.
Licenses management
Fetch licenses
Id | Endpoint | HTTP method | Purpose |
|---|---|---|---|
| GetLicenses | /api/license/management/v4/licenses | GET | Fetch list of licenses with filters |
| GetLicenseById | /api/license/management/v4/licenses/{license_id} | GET | Get license specified by id |
| GetLicensesByUser | /api/license/management/v4/users/{user_id}/licenses | GET | Get all user licenses |
Create licenses
Id | Endpoint | HTTP method | Purpose |
|---|---|---|---|
| CreateLicense | /api/license/management/v4/licenses | POST | Grant license on specified product to user |
Delete licenses
Id | Endpoint | HTTP method | Purpose |
|---|---|---|---|
| DeleteLicenseById | /api/license/management/v4/licenses/{license_id} | DELETE | Delete license by id |
Batch operations
Id | Endpoint | HTTP method | Purpose |
|---|---|---|---|
| BatchCreateLicenses | /api/license/management/v4/licenses/batch_create | POST | Create multiple licenses |
| BatchDeleteLicenses | /api/license/management/v4/licenses/batch_delete | POST | Delete multiple licenses |
Products management
Fetch products
Id | Endpoint | HTTP method | Purpose |
|---|---|---|---|
| GetAllProducts | /api/license/management/v4/products | GET | Get all product |
| GetProductById | /api/license/management/v4/products/{product_id} | GET | Get product bu Id |
Create products
Id | Endpoint | HTTP method | Purpose |
|---|---|---|---|
| CreateProduct | /api/license/management/v4/products | POST | Create new product |
Update products
Id | Endpoint | HTTP method | Purpose |
|---|---|---|---|
| UpdateProduct | /api/license/management/v4/products/{product_id} | PATCH | Update product attributes |
Delete products
Id | Endpoint | HTTP method | Purpose |
|---|---|---|---|
| DeleteProductById | /api/license/management/v4/products/{product_id} | DELETE | Delete product by id |
Use cases
Migration from legacy
| Table of Contents |
|---|