api-keys

POST `/v1/api-keys`

Create an API key.

Hitelesítés

Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) apikeys.manage jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.

A szervezet azonosítójának helye

Ez a végpont a org_id mezőt várja a JSON törzsben.

A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.

Próbálja ki

Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.

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

Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban

Részletek

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

Paraméterek

Név	Típus	Kötelező	Mi ez
`Idempotency-Key (header)`	`string`	Nem	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Kérés törzse

Név	Típus	Kötelező	Mi ez
`name`	`string`	Igen	—
`scopes`	`string[]`	Nem	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`	Nem	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	Nem	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Válasz

Név	Típus	Kötelező	Mi ez
`id`	`Uuid`	Igen	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Igen	—
`prefix`	`string`	Igen	The key's public lookup id (the middle segment of the token).
`scopes`	`string[]`	Igen	The RBAC permission keys this key may exercise.
`sandbox`	`boolean`	Igen	A sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
`last_used_at`	`object`	Nem	When the key last authenticated a request; null if never used.
`revoked_at`	`object`	Nem	Always null on a listed/fetched key — revoked keys are not returned.
`created_at`	`string`	Igen	—
`token`	`string`	Igen	The full `zdk_<mode>_<prefix>_<secret>` token. Shown once, here only — store it now; it cannot be retrieved again, only replaced.

Hibák, amelyeket ez a végpont visszaadhattatlan

401 · 403 · 409 · 422 · 429