API reference License checks Get an offline license file

Get an offline license file

POST methodhttps://api.anyshop.io/v1/licenses/offline

Public: the license key is the credential. Verify the file with the store's Ed25519 public key (Developers page).

No API key: the license key is the credential

Body

application/json1 required, 3 optional

keystring requiredThe license key as the buyer typed or pasted itUp to 200 characters
device_idstring Your app's identifier of the device, the same on every launch; only its hash is kept. Needed to activate and deactivate; with validate, it also checks the license is active on this device1 to 200 characters
namestring A name the seller sees, like Studio MacUp to 100 characters
platformstring The device's system, for the sellerUp to 40 characters

Example

curl -X POST https://api.anyshop.io/v1/licenses/offline \
  -H "Content-Type: application/json" \
  -d '{
    "key": "PXF-7Q2M-K8WD-4H9R-2LTN",
    "device_id": "a3f9c2e17b8d4e05",
    "name": "Studio Mac",
    "platform": "macOS"
  }'

{
  "ok": true,
  "file": {
    "format": "anyshop-license",
    "version": 1,
    "alg": "Ed25519",
    "payload": "eyJsaWNlbnNlIjoibGljXzAxbTNydjJm...",
    "signature": "q8Zc0v2mK3a..."
  }
}

The IDs and keys in these examples are made up. Every schema is in the OpenAPI document, served at https://api.anyshop.io/v1/openapi.json.

Returns

An object with ok and file.

Errors

Status and error.code

400invalid_key: not a license key; device_required: no device ID
403revoked or expired
404not_found: no license has this key; not_activated: it is not active on this device
429rate_limited: too many requests; see Retry-After