Developer docs
DevEntitle has three ways in. Pick the one that matches what you're building.
| You are building… | Use | Auth |
|---|---|---|
| The software you sell (it checks its own licence and updates itself) | Licence protocol /api/v1 | The buyer's licence key |
| Your own website, billing, CRM or CI (issue keys, look them up, upload releases) | Management API /api/manage/v1 | API token de_live_… |
| An app other companies connect to (a marketplace, a reseller site) | Connected apps, then the Management API | OAuth 2 + PKCE de_oat_… |
To be told when things happen (a licence issued, a site activated, a release published), add a webhook. Ready-made code is under Client code, and the full API description is in openapi.json.
The licence protocol
Your product calls three endpoints. Every call is a POST with a JSON body of exactly four fields. Nothing else is ever sent: no data from inside the product.
| Field | Example | Notes |
|---|---|---|
license_key | ACME-7KQ2M-… | As the buyer typed it; spaces and case don't matter. |
product | acme-crm | Your product slug on DevEntitle. |
domain | crm.buyer.com | The site's host, or a stable device ID for products counted per machine. |
version | 1.4.2 | The installed version. |
POSThttps://terminal.deventitle.com/api/v1/activate
Checks the key and records this domain. Licence answers are always HTTP 200:
{"valid": true, "message": "Licence active.", "buyer": "Buyer Ltd", "license_type": "Single site", "supported_until": "2027-10-15T23:59:59Z"}
{"valid": false, "message": "This licence is already used on its maximum of 1 site: crm.old.com. Remove it there under Updates & licence, or contact support."}
Development hosts (localhost, *.test, *.local, private IPs and similar) never count toward the limit.
POSThttps://terminal.deventitle.com/api/v1/deactivate
Frees this domain (the buyer is moving servers). Always answers {"ok": true}, so it can't be used to test whether keys exist.
POSThttps://terminal.deventitle.com/api/v1/updates
{
"license": {"valid": true, "message": "Licence active.", "supported_until": "2027-10-15T23:59:59Z"},
"latest": {
"version": "1.5.0", "channel": "stable", "notes": "## What's new …",
"released_at": "2026-11-01T09:30:00Z", "size": 36168558, "sha256": "…",
"signature": "…", "download_url": "https://terminal.deventitle.com/dl/…"
}
}
latest is the newest published release on the licence's channel, or null. signature and download_url are only there when the licence may download it; otherwise latest.message says why. Download links expire after 30 minutes, so ask again just before installing. Always check the SHA-256 and the signature before installing anything (see Signing releases).
Rules for your product
- Never disable features because a licence is invalid or the server can't be reached. A licence unlocks updates, downloads and support only. Show the message.
- Only a 5xx answer is a server problem: say "could not be reached, try later" and keep working.
- HTTP 429 means too many checks in a minute (60 per IP, 20 per key). Check on demand or once a day, not on every page view.
- Send only the four fields above.