api-keys

POST `/v1/api-keys`

Create an API key.

Uwierzytelnianie

Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie apikeys.manage; klucz bez niego jest odrzucany z kodem 403, a nie 404.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako pole w treści JSON.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

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

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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

Parametry

Nazwa	Typ	Wymagane	Co to jest
`Idempotency-Key (header)`	`string`	Nie	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`name`	`string`	Tak	—
`scopes`	`string[]`	Nie	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`	Nie	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	Nie	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Odpowiedź

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

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 409 · 422 · 429