api-keys

POST `/v1/api-keys`

Create an API key.

Doğrulama

API açarını bearer token kimi göndərin. Açar apikeys.manage icazəsinə malik olmalıdır; bu icazəsi olmayan açar 404 deyil, 403 xətası ilə rədd edilir.

Təşkilatınızın identifikatorunun yerləşdiyi yer

Bu son nöqtə JSON gövdəsində sahə kimi org_id qəbul edir.

Təşkilatınızın identifikatoru idarə panelinizdəki API açarları ekranında, açarın özünün yanında yerləşir. Bu, etdiyiniz hər bir sorğuda eyni identifikatordur.

Sınaqdan keçir

Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.

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

Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın

Təfərrüatlar

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

Parametrlər

Ad	Tip	Tələb olunur	Nədir
`Idempotency-Key (header)`	`string`	Xeyr	Client-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Sorğu gövdəsi

Ad	Tip	Tələb olunur	Nədir
`name`	`string`	Bəli	—
`scopes`	`string[]`	Xeyr	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`	Xeyr	Mint a sandbox (test-mode) key. Defaults to false.
`org_id`	`Uuid \| null`	Xeyr	The organization the key belongs to. Defaults to the caller's org; the caller must hold `apikeys.manage` in the target org.

Cavab

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

Bu son nöqtənin qaytara biləcəyi xətalar

401 · 403 · 409 · 422 · 429