api-keys

POST `/v1/api-keys`

Create an API key.

Автентифікація

Надішліть ключ API як маркер носія (bearer token). Ключ повинен мати дозвіл 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, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі 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