api-keys

POST `/v1/api-keys`

Create an API key.

Ìfàṣẹ́pọ̀

Fi bọ́ọ̀lù (bearer token) ranṣẹ gẹ́gẹ́ bí kọ́kọ́rọ́ API. Kọ́kọ́rọ́ náà gbọ́dọ̀ ní ìyọ̀ǹda apikeys.manage; a ó kọ̀ ọ́ silẹ pẹlu 403, kii ṣe 404, ti kọ́kọ́rọ́ náà kò bá ní i.

Ibùdó àmì ìdánimọ̀ ilé-iṣẹ́ rẹ sí

Ibi-iwọle yii n gba org_id gẹgẹ bi aaye ninu ara JSON naa.

Id àjọ rẹ wa lórí ojú-ìwákòòkò àwọn bọ́tìnnì API nínú daṣibọọdú rẹ, lẹ́gbẹ̀ẹ́ bọ́tìnnì náà gan-an. Ó jẹ́ ìd kan náà nínú gbogbo ìpè tí o bá ṣe.

Gbiyanju rẹ

Rọ́pọ̀ èyíkéyìí nínú àwọn àmì ìtọ́ka < > pẹ̀lú iye tirẹ̀, àti àmì ìdánimọ̀ bọ́tìnnì náà pẹ̀lú bọ́tìnnì kan láti inú dásibọ̀ọ̀dù rẹ.

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

Ṣé o ti wọlé? Iwọ̀n api ní nú ìgbékalẹ̀ rẹ kún id àjọ gidi rẹ ati bọtini tirẹ, o si nṣiṣẹ ibeere na lòdì si api gidi ki o le rii esi gidi na. Ṣí ojú abáná yìí sílẹ̀ nínú kọnsólù API

Àwọn kúlẹ̀kúlẹ̀

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

Àwọn ìpìlẹ̀

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`Idempotency-Key (header)`	`string`	Bẹẹkọ	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Akoonu ibeere naa

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`name`	`string`	Bẹẹni	—
`scopes`	`string[]`	Bẹẹkọ	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`	Bẹẹkọ	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	Bẹẹkọ	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Idahun

Orúkọ	Iru	Tí a nílò	Kini o jẹ
`id`	`Uuid`	Bẹẹni	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Bẹẹni	—
`prefix`	`string`	Bẹẹni	The key's public lookup id (the middle segment of the token).
`scopes`	`string[]`	Bẹẹni	The RBAC permission keys this key may exercise.
`sandbox`	`boolean`	Bẹẹni	A sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
`last_used_at`	`object`	Bẹẹkọ	When the key last authenticated a request; null if never used.
`revoked_at`	`object`	Bẹẹkọ	Always null on a listed/fetched key — revoked keys are not returned.
`created_at`	`string`	Bẹẹni	—
`token`	`string`	Bẹẹni	The full `zdk_<mode>_<prefix>_<secret>` token. Shown once, here only — store it now; it cannot be retrieved again, only replaced.

Awọn aṣiṣe ti ibudo ipari yii le da pada

401 · 403 · 409 · 422 · 429