Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie apikeys.manage beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt verwacht org_id als een veld in de JSON-body.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X POST https://api.zinndigital.com/v1/api-keys \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
Mints a new per-org API key and returns the full `zdk_…` token **once** — only its hash is stored, so a lost token is replaced, never recovered. The requested `scopes` must be permissions the caller already holds in the target org; asking for one you do not hold is a `403` (a key can never out-scope its creator). Send an `Idempotency-Key` so a retry after a lost response returns the same token rather than orphaning a key. Requires `apikeys.manage`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
Idempotency-Key (header) | string | Nee | Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats. |
Aanvraaglichaam
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
name | string | Ja | — |
scopes | string[] | Nee | RBAC permission keys to grant. Each must be a permission the caller holds in the target org (a key can never out-scope its creator); an unheld scope is a `403`, an unknown one a… |
sandbox | boolean | Nee | Mint a sandbox (test-mode) key. Defaults to false. |
org_id | Uuid | null | Nee | The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
id | Uuid | Ja | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
name | string | Ja | — |
prefix | string | Ja | The key's public lookup id (the middle segment of the token). |
scopes | string[] | Ja | The RBAC permission keys this key may exercise. |
sandbox | boolean | Ja | A sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2). |
last_used_at | object | Nee | When the key last authenticated a request; null if never used. |
revoked_at | object | Nee | Always null on a listed/fetched key — revoked keys are not returned. |
created_at | string | Ja | — |
token | string | Ja | The full `zdk_<mode>_<prefix>_<secret>` token. Shown **once, here only** — store it now; it cannot be retrieved again, only replaced. |
Fouten die dit eindpunt kan retourneren
401 · 403 · 409 · 422 · 429