API quickstart

For developers who want the whole loop in code: from an empty account to a live license and a metered usage event, using only the REST API. Prefer clicking through the UI first? See the Admin path.

Prerequisites

• An API client with the right scopes (see Authentication & scopes).
• Your API base URL.

Steps

Authenticate once, then carry Authorization: Bearer <token> on every call below.

1. Get a token — POST /connect/token (client-credentials grant).
2. Create a product — POST /api/v1/provision/admin/products.
3. Add a feature — POST /api/v1/provision/admin/products/{productId}/features with a dotted feature code.
4. Create an entitlement — POST /api/v1/provision/admin/entitlements, then set it Published.
5. Issue an activation code — POST /api/v1/provision/operational/entitlements/{entitlementId}/activation-codes.
6. Activate a license — POST /api/v1/provision/activations/license with the code and a device fingerprint; keep the returned sessionId.
7. Report usage — POST /api/v1/provision/usage/sessions/{sessionId}/transactions.
8. Read it back — GET /api/v1/provision/usage/{sessionId}/{metric}/usage.

Example: token and activation

# 1. Get a token
curl -X POST https://api.example.com/connect/token \
  -d grant_type=client_credentials \
  -d client_id=$ID -d client_secret=$SECRET

# 6. Activate a license
curl -X POST https://api.example.com/api/v1/provision/activations/license \
  -H "authorization: Bearer $TOKEN" \
  -H "content-type: application/json" \
  -d '{ "activationCode": "…", "fingerprint": "…" }'

Full request and response shapes are in the REST API reference.