Chave API de gerenciamento

Use uma API Key de gestão para emitir licenças pelo sistema de pedidos ou ler dados de autorização no servidor. Ela representa seu espaço de fornecedor.

Qual chave o cliente precisa?

Credencial	Destinatário	Para que serve
`lv_api_…` Chave API de gerenciamento	Seu servidor	Criar produtos, políticas e licenças; ver dispositivos, uso e auditoria
`lv_lic_…` Chave de licença	Aplicativo do cliente	Ativar, validar, enviar heartbeats e liberar dispositivo
Chave pública do produto	Distribuir com o cliente	Verificar assinatura da licença do servidor

Para validar a licença no software do cliente, basta a chave de licença. A API Key de gestão controla todo o espaço; não a coloque no software cliente ou em páginas públicas.

Criar uma chave

Entre como Owner do espaço e abra API Key e clique em Criar API Key.
Dê um nome conforme o uso, como “Pedidos”. Escolha Somente leitura para consultar ou Leitura/escrita para criar ou alterar licenças. Validade: 1–365 dias.
Copie a chave completa ao salvar; ela aparece apenas uma vez. Guarde na configuração privada do servidor ou em uma variável de ambiente.

Enviar a primeira requisição de gestão

Este exemplo lê a lista de produtos. Defina LICENTIVO_URL como URL do servidor de licenças e defina LICENTIVO_API_KEY como chave completa criada e execute:

curl "$LICENTIVO_URL/api/v1/products?limit=25" \
  -H "Authorization: Bearer $LICENTIVO_API_KEY"

Sintaxe para Bash/macOS/Linux. No Windows PowerShell, use curl.exe; a variável de ambiente é $env:LICENTIVO_URL e $env:LICENTIVO_API_KEY. Exemplos completos em nove linguagens também estão em Opção API Key de gestão no servidor na página SDK.

Sucesso retorna HTTP 200 com data.items. Requisições Bearer Key dispensam cookies de login e CSRF.

Permissões e invalidação

Chaves de leitura consultam recursos; leitura/escrita também cria e altera produtos, políticas e licenças. Contas, equipes, configurações e pagamentos exigem login de uma conta autorizada, não uma chave de gestão.

Revogue no console chaves vazadas ou sem uso. Para substituir, clique em Rotacionar; a antiga deixa de funcionar imediatamente. Depois atualize a configuração do servidor.

A cota API do plano conta ativação, validação, heartbeat e liberação. Estas requisições de gestão não entram na cota.

Common request and response conventions

Item	Convention
Server origin	`LICENTIVO_URL` is the license server origin. API paths start with `/api/v1` .
Authentication	`Authorization: Bearer YOUR_MANAGEMENT_API_KEY`. Read-only keys use `scope=read`; read/write keys use `scope=write`. A key accesses its own workspace. Writes also require its creator to be an active Owner.
JSON body	For requests with a body, send `Content-Type: application/json`. Bodies are limited to 64 KiB. Unknown fields, multiple JSON objects and invalid types are rejected. Operations marked `{}` require an empty JSON object. GET and DELETE have no body.
Updates	PATCH preserves omitted fields. Basic updates require at least one editable field. See conditional requirements, such as `duration_days`.
Success and failure	Successful JSON responses use `{"data": ..., "request_id": "..."}`; errors use `{"error": {"code": "...", "message": "..."}, "request_id": "..."}`. Creation usually returns 201, reads and updates 200, and queued tasks 202.
File responses	Successful CSV and ZIP responses contain file data without a `data` wrapper. Errors still use JSON. The `X-Request-ID` response header identifies the request.
Pagination	Paginated operations default to `limit=25`, `offset=0`; ranges are 1–100 and 0–100000. Most lists return `items` e `total`. Check each field table for echoed pagination parameters. Audit logs omit total. Increase offset for the next page and stop when fewer than limit items are returned. Do not rely on undocumented filters.
Dates and money	Date strings use UTC / RFC 3339. Offline requests use `created_at` in Unix seconds. Amounts ending in `_cents` are hundredths of the currency unit;`_micros` are millionths. Interpret amounts with `currency` .

Retries and idempotency

Ordinary creation, renewal and key rotation do not provide general Idempotency-Key deduplication. Do not blindly resend after a timeout; it can issue or renew twice. For reliable order processing, use POST /api/v1/licenses/batch: generate and store the body request_idper order, and keep the original ID and identical content for retries. Onboarding also deduplicates by its body request_id.

The top-level response request_id differs from the business idempotency ID: the server generates the former for each HTTP request, while you retain the latter per business operation. Poll task status after 202. On 429, wait according to Retry-After . A 5xx or lost connection can leave a write outcome uncertain; query first or recover using that operation’s idempotency rules.

Management errors and recovery

HTTP / error.code	Cause and recovery
`400 INVALID_INPUT` `415 JSON_REQUIRED`	Correct fields, conditional requirements or Content-Type before retrying.
`401 UNAUTHENTICATED`	The key is malformed, expired or revoked, or its account/workspace is inactive. Check the complete key and account state.
`403 FORBIDDEN` `403 CSRF_INVALID`	Check scope, Owner role and session requirements. CSRF tokens for cookie-authenticated writes must match the session.
`404 NOT_FOUND` `405 METHOD_NOT_ALLOWED`	Check the resource ID, workspace, archive state and HTTP method. A 405 response lists allowed methods in Allow.
`409 PRODUCT_DISABLED` `409 RESOURCE_IN_USE`	Enable the product first. Resolve dependent resources before archiving a product or policy.
`409 LICENSE_REVOKED` `409 PERPETUAL_LICENSE`	Revoked licenses cannot be restored or renewed. Perpetual licenses have no usage expiry to extend.
`409 DEVICE_LIMIT_BELOW_ACTIVE` `409 ACTIVE_DEVICES_CONFLICT`	Release excess devices/sessions before lowering limits or switching license models.
`409 POLICY_CHANGED` `409 PREVIEW_STALE`	Reload the policy revision or preview the changes again before submitting; preserve concurrent updates.
`409 IDEMPOTENCY_CONFLICT`	The business request_id was reused with different content. Retries retain the original ID and body; new operations need a new ID.
`409 KEY_LIMIT` `409 KEY_INACTIVE`	At most 100 active keys are allowed; revoke unused keys. Rotation requires an active key whose creator remains an active Owner.
`409 PLAN_VERSION_CONFLICT` `409 INVOICE_STATE_CONFLICT` `409 JOB_STATE_CONFLICT`	Reload pricing, invoice or task state before proceeding. Only failed billing tasks can be retried.
`409 DELIVERY_RUNNING` `409 WEBHOOK_DISABLED`	Wait for the running delivery or enable the endpoint first. Receivers must deduplicate by event ID.
`413 EXPORT_TOO_LARGE` `429 RATE_LIMITED`	Filter exports to at most 5000 rows or use pagination. Wait according to Retry-After when rate-limited.
`500 INTERNAL_ERROR` `503 DEFAULT_PLAN_DISABLED`	Keep request_id for diagnosis; contact an administrator if the default allowance is disabled. Recover uncertain writes according to the operation’s idempotency rules.

Offline operations may also return runtime licensing errors; see Troubleshooting and licensing errors.

Technical terminology

Prazo	Significado
`authentication / authorization`	Authentication / authorization: establish the credential’s identity, then check permission for the operation.
`scope`	Scope: read grants read access and write grants read/write access; separate from the Owner / read_only account role.
`policy / plan / purchase`	Licensing policy / billing plan / package purchase contract: software licensing rules, service prices and purchased entitlements respectively.
`license / license key`	License / license key: the management record and the customer’s activation secret respectively; both differ from the management API Key.
`activation / seat / lease`	Activation / seat / authorization lease: a device or session record, a concurrent-use slot, and time-bounded server-signed authorization respectively.
`revoke / suspend / archive / release`	Revoke / suspend / archive / release: revocation is terminal, suspension is reversible, archiving removes normal visibility, and release frees a device or seat.
`rotate / idempotency / reservation`	Rotation / idempotency / reservation: replacing a key, preventing additional effects from repeated execution of the same operation, and reserving feature uses before committing them.

All management requests and responses

The reference covers every Bearer-key operation plus the Owner-session operations for creating, listing, rotating and revoking keys. Select an operation for calls, responses, fields and conditions. All example credentials are illustrative.

Loading API reference…

Management key permissions

Read-only keys can call operations marked “Read or write key”; write keys also support “Write key” operations. Key lifecycle, accounts, members, system settings, payments and refunds require an authorized session. Monthly billing queries and tasks use the permissions listed here. Customer runtime operations use customer credentials; see Chamadas de licença do SDK.

Download the machine-readable OpenAPI JSON (idioma atual)for import into tools such as Postman. Web field explanations follow the documentation language.