api-keys

POST `/v1/api-keys`

Create an API key.

Аутентификација

Пошаљите API кључ као bearer токен. Кључ мора имати дозволу apikeys.manage; кључ без ње се одбија уз 403, а не 404.

Где се уноси ID ваше организације

Ова крајња тачка узима org_id као поље у JSON телу.

Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.

Испробајте

Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.

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

Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли

Детаљи

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.

Параметри

Назив	Тип	Обавезно	Шта је ово
`Idempotency-Key (header)`	`string`	Не	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Тело захтева

Назив	Тип	Обавезно	Шта је ово
`name`	`string`	Да	—
`scopes`	`string[]`	Не	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`	Не	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	Не	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Одговор

Назив	Тип	Обавезно	Шта је ово
`id`	`Uuid`	Да	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`name`	`string`	Да	—
`prefix`	`string`	Да	The key's public lookup id (the middle segment of the token).
`scopes`	`string[]`	Да	The RBAC permission keys this key may exercise.
`sandbox`	`boolean`	Да	A sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
`last_used_at`	`object`	Не	When the key last authenticated a request; null if never used.
`revoked_at`	`object`	Не	Always null on a listed/fetched key — revoked keys are not returned.
`created_at`	`string`	Да	—
`token`	`string`	Да	The full `zdk_<mode>_<prefix>_<secret>` token. Shown once, here only — store it now; it cannot be retrieved again, only replaced.

Грешке које ова крајња тачка може вратити

401 · 403 · 409 · 422 · 429