Management API
The Management API administers the licensing data: customers, contacts, products, orders, licenses, license tokens and templates, assemblies, resources, received reports, users, roles, API keys, the log and the service settings.
Every route takes an API key in the x-api-key header; a bearer token is refused. The key needs the permission bit for the HTTP method, and its owner needs one of the roles the route allows. See Authentication and Roles and Access. List routes accept filter, sort, skip, take, select and, on some routes, include; see Querying Lists.
All PUT endpoints update only the fields present in the body; see Updating Resources.
Pages
Customers, their contacts, orders and licenses.
Contacts of customers.
Products and the orders that include them.
Create, update, list and delete orders.
The products of an order and the licenses issued for it.
Create, update, list and delete licenses.
Activation and floating tokens issued for licenses.
License usage traces and their geolocation.
License templates and the licenses created from them.
Assemblies that licenses and releases refer to.
Stored resources such as signature keys and files.
Reports sent by applications, and their geolocation.
Users and user settings.
Roles and role membership of users.
Create, update, list and revoke API keys.
Read and clear the service log.
Service settings and server information.
Send email and license email.
Endpoints
| Endpoint | Page |
|---|---|
GET /v1/customers | Customers |
POST /v1/customers | Customers |
PUT /v1/customers | Customers |
GET /v1/customers/{customerId}/contacts | Customers |
GET /v1/customers/{customerId}/orders | Customers |
GET /v1/customers/{customerId}/licenses | Customers |
DELETE /v1/customers/{customerId} | Customers |
GET /v1/contacts | Contacts |
POST /v1/contacts | Contacts |
PUT /v1/contacts | Contacts |
DELETE /v1/contacts/{contactId} | Contacts |
GET /v1/products | Products |
POST /v1/products | Products |
PUT /v1/products | Products |
DELETE /v1/products/{productId} | Products |
GET /v1/products/{productId}/orders | Products |
GET /v1/orders | Orders |
POST /v1/orders | Orders |
PUT /v1/orders | Orders |
DELETE /v1/orders/{orderId} | Orders |
GET /v1/orders/{orderId}/products | Order Products and Licenses |
POST /v1/orders/{orderId}/products/{productId} | Order Products and Licenses |
PUT /v1/orders/{orderId}/products/{productId} | Order Products and Licenses |
DELETE /v1/orders/{orderId}/products/{productId} | Order Products and Licenses |
GET /v1/orders/{orderId}/licenses | Order Products and Licenses |
GET /v1/licenses | Licenses |
POST /v1/licenses | Licenses |
PUT /v1/licenses | Licenses |
DELETE /v1/licenses/{licenseId} | Licenses |
GET /v1/license-tokens | License Tokens |
GET /v1/licenses/{licenseId}/tokens | License Tokens |
POST /v1/licenses/{licenseId}/tokens | License Tokens |
DELETE /v1/licenses/{licenseId}/tokens/{tokenId} | License Tokens |
GET /v1/license-traces | License Traces |
DELETE /v1/license-traces | License Traces |
POST /v1/license-traces/geolocation | License Traces |
GET /v1/license-templates | License Templates |
POST /v1/license-templates | License Templates |
PUT /v1/license-templates | License Templates |
GET /v1/license-templates/{templateId}/licenses | License Templates |
DELETE /v1/license-templates/{templateId} | License Templates |
GET /v1/assemblies | Assemblies |
POST /v1/assemblies | Assemblies |
PUT /v1/assemblies | Assemblies |
DELETE /v1/assemblies/{assemblyId} | Assemblies |
GET /v1/resources | Resources |
POST /v1/resources | Resources |
PUT /v1/resources | Resources |
DELETE /v1/resources/{resourceId} | Resources |
GET /v1/reports | Received Reports |
POST /v1/reports/geolocation | Received Reports |
DELETE /v1/reports/{reportId} | Received Reports |
GET /v1/users | Users |
POST /v1/users | Users |
PUT /v1/users | Users |
DELETE /v1/users/{userId} | Users |
GET /v1/users/{userId}/settings | Users |
POST /v1/users/{userId}/settings | Users |
PUT /v1/users/{userId}/settings | Users |
DELETE /v1/users/{userId}/settings/{settingId} | Users |
GET /v1/roles | Roles |
GET /v1/users/{userId}/roles | Roles |
POST /v1/users/{userId}/roles | Roles |
DELETE /v1/users/{userId}/roles | Roles |
GET /v1/api-keys | API Keys |
POST /v1/api-keys | API Keys |
PUT /v1/api-keys | API Keys |
DELETE /v1/api-keys/{apiKeyId} | API Keys |
GET /v1/log/levels | Log |
GET /v1/log | Log |
DELETE /v1/log | Log |
GET /v1/settings | Settings and Server Info |
PUT /v1/settings | Settings and Server Info |
GET /v1/info | Settings and Server Info |
POST /v1/email/send | |
POST /v1/email/license |