api-keys

POST `/v1/api-keys`

Create an API key.

Autentifikimi

Drgoni një çelës API si një token mbajtës. Çelësi duhet të ketë lejen apikeys.manage; një çelës pa të refuzohet me 403, jo 404.

Ku shkon id i organizatës suaj

Ky endpoint pranon org_id si fushë në trupin JSON.

ID-ja e organizatës suaj ndodhet në ekranin e çelësave API në panelin tuaj të kontrollit, pranë vetë çelësit. Është i njëjti ID në çdo thirrje që bëni.

Provoje

Zëvendësoni çdo gjë brenda kllapave këndore me vlerat tuaja dhe vendbanuesin e çelësit me një çelës nga paneli juaj.

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

Jeni kyçur? Konsola e API-së në panelin tuaj plotëson ID-në tuaj reale të organizatës dhe çelësin tuaj, dhe ekzekuton kërkesën kundrejt API-së live, kështu që ju mund të shihni përgjigjen aktuale. Hapni këtë pikë fundore në konsolën e API-së

Detajet

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

Parametrat

Emri	Lloji	Kërkohet	Çfarë është kjo
`Idempotency-Key (header)`	`string`	Jo	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Trupi i kërkesës

Emri	Lloji	Kërkohet	Çfarë është kjo
`name`	`string`	Po	—
`scopes`	`string[]`	Jo	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`	Jo	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	Jo	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Përgjigja

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

Gabimet që ky pikëndalim mund të kthejë

401 · 403 · 409 · 422 · 429