api-keys

POST `/v1/api-keys`

Create an API key.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението apikeys.manage; ключ без него се отхвърля с 403, а не с 404.

Където отива идентификаторът на вашата организация

Този краен пункт приема 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 конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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.

Грешки, които този крайpoint може да върне

401 · 403 · 409 · 422 · 429