Appearance
API Overview
Base URL
All endpoints are served from:
https://api.verustrust-licensing.comRequests and responses use JSON (Content-Type: application/json), except for some error messages, which are plain text. See Errors.
Authentication
The API has two kinds of endpoints.
Management endpoints (products, plans, entitlements, customers, licenses, and so on) need an access token in the Authorization header:
http
Authorization: Bearer <ACCESS_TOKEN>Get an access token by exchanging a User Token, as described in Authorization. Each endpoint lists the permission its token needs. Requests with a missing or expired token get 401, and requests whose token lacks the permission get 403.
License key endpoints are meant to be called from your end users' applications. They need no access token. The request is authenticated by the licenseKey in the request body, so you never have to ship an access token or User Token inside your application:
| Endpoint | Use it to |
|---|---|
POST /v1/licenses/license/validate | Check whether a license is valid |
POST /v1/licenses/license/activation | Check whether a license has a specific activation |
PUT /v1/licenses/license/actual | Report usage of an entitlement |
POST /v1/licenses/license/recreated | Get the key of the license that replaced this one |
POST /v1/activations | Create an activation |
PUT /v1/activations/activation | Activate or deactivate an activation |
POST /v1/activations/activation/delete | Delete an activation |
Keep license keys confidential: anyone with a key can call these endpoints for that license. See Security for more guidance.
Versioning
The version is part of the path. The current and only version is v1 (https://api.verustrust-licensing.com/v1/...).
Within v1, new endpoints, new response fields, and new optional request fields can be added at any time, so ignore response fields you don't recognize. Changes that may break existing integrations are marked Breaking in the Changelog.
OpenAPI spec and Postman collection
- OpenAPI 3 spec (
openapi.json): import it into your API client, or generate a client library with tools such as OpenAPI Generator. - Postman collection: in Postman, choose Import and select the file. Set the collection's
bearerTokenvariable to your access token.
Both files are generated from the API on every documentation release, so they match these pages.
Limits
- Rate limits: 20 requests per second and 200 per minute.
- Pagination: list endpoints are paginated with
pageSizeandpageNumber.