Skip to content

Developer docs

Connect your product to DevEntitle

DevEntitle speaks plain HTTPS and JSON. Your installed product uses three small endpoints; your own systems use a REST API; platforms connect with OAuth 2. This page shows which to use and how to start.

Also in the app: terminal.deventitle.com/docs · Machine-readable spec: openapi.json (OpenAPI 3.1)

The three ways in

You are building…UseAuthentication
The software you sell (it checks its own licence and updates itself)Licence protocol /api/v1The buyer's licence key
Your own website, billing, CRM or CI (issue keys, look them up, upload releases)Management API /api/manage/v1API token de_live_…
An app other companies connect to (marketplace, reseller site)Connected apps (OAuth 2 + PKCE), then the Management APIOAuth access token de_oat_…

Plus webhooks to be told when things happen: a licence issued, an activation added, a release published, an order paid or refunded.

Quick start

  1. Create a free account and your company. Set your support email in Company settings.
  2. Add a product. Its slug (for example acme-crm) is what your software sends, and it can’t change later.
  3. Add a licence type and issue yourself a test licence in the panel.
  4. From your product, call activate with the key:
POST /api/v1/activate
curl -X POST https://terminal.deventitle.com/api/v1/activate \
  -H "Content-Type: application/json" \
  -d '{
    "license_key": "ACME-7KQ2M-X9PTR-4HWBN-C8ZVD",
    "product": "acme-crm",
    "domain": "crm.buyer.com",
    "version": "1.4.2"
  }'
200 OK
{
  "valid": true,
  "message": "Licence active.",
  "buyer": "Buyer Ltd",
  "license_type": "Single site",
  "supported_until": "2027-10-15T23:59:59Z"
}
  1. Show the message to the buyer as it is. Then add deactivate and the updates check. The client code does all three for PHP, Laravel, Node.js and Python.
  2. Create a signing keypair with the Release Kit, sign your first release, upload it and publish.

The integration checklist has the full list for going live.

Base URLs

WhatURL
Licence protocolhttps://terminal.deventitle.com/api/v1
Management APIhttps://terminal.deventitle.com/api/manage/v1
OAuth (connected apps)https://terminal.deventitle.com/oauth/authorize, /oauth/token, /oauth/revoke
OpenAPI 3.1 filehttps://terminal.deventitle.com/docs/openapi.json
In-app docs and Release Kit downloadshttps://terminal.deventitle.com/docs

Everything is HTTPS with JSON bodies. Dates are UTC ISO 8601 (2026-11-01T09:30:00Z). Money in the Management API is in minor units (cents, paise) with an ISO currency code.

Rules for products

A licence unlocks updates, downloads and support only

Never disable features because a licence is invalid, expired, or because the server can’t be reached. Show the message and hold back updates. Products that use DevEntitle are required to follow this.

  • Only a 5xx answer (or no answer) is a server problem: say it “could not be reached, try later” and keep working. Licence answers, valid or not, are always HTTP 200.
  • HTTP 429 means too many checks in a minute (60 per IP address, 20 per key). Check on demand or once a day, not on every page view.
  • Send only the four fields: license_key, product, domain, version.
  • Keep API tokens and OAuth secrets on your servers. Never put them in browser code or in the product you ship.

All reference pages

  • Licence protocol: activate, deactivate, updates, and every message your product may show.
  • Releases and signing: Ed25519, the manifest, the Release Kit, checking an update before installing.
  • Management API: every endpoint, scopes, errors, pagination and idempotency.
  • Connected apps: OAuth 2 with PKCE for marketplaces and resellers.
  • Webhooks: events, payload, signature check and retries.
  • Client code: copy-paste files for PHP, Laravel, Node.js and Python.
  • Integration checklist: from sign-up to your first published release.