api-keys

POST /v1/api-keys

Create an API key.

Svi api-keys krajnji točke

Autentifikacija

Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu apikeys.manage; ključ bez nje se odbija s kodom 403, a ne 404.

Gdje dolazi ID vaše organizacije

Ova krajnja točka prihvaća org_id kao polje u JSON tijelu.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

curl -X POST https://api.zinndigital.com/v1/api-keys \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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`.

Parametri

NazivVrstaObaveznoŠto je to
Idempotency-Key (header)stringNeClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Tijelo zahtjeva

NazivVrstaObaveznoŠto je to
namestringDa
scopesstring[]NeRBAC 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…
sandboxbooleanNeMint a sandbox (test-mode) key. Defaults to false.
org_idUuid | nullNeThe organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Odgovor

NazivVrstaObaveznoŠto je to
idUuidDaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringDa
prefixstringDaThe key's public lookup id (the middle segment of the token).
scopesstring[]DaThe RBAC permission keys this key may exercise.
sandboxbooleanDaA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectNeWhen the key last authenticated a request; null if never used.
revoked_atobjectNeAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringDa
tokenstringDaThe full `zdk_<mode>_<prefix>_<secret>` token. Shown **once, here only** — store it now; it cannot be retrieved again, only replaced.

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 409 · 422 · 429