api-keys

POST `/v1/api-keys`

Create an API key.

Баталгаажуулалт

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Түлхүүр нь apikeys.manage эрхтэй байх ёстой бөгөөд үүнгүйгээр 404 биш, харин 403 алдаа буцааж татгалзах болно.

Таны байгууллагын дугаар орох газар

Энэ төгсгөлийн цэг нь JSON бие хэсэгт org_id-ийг талбар болгон авдаг.

Танай байгууллагын ID нь таны хяналтын самбар дээрх API түлхүүрийн дэлгэцэнд, түлхүүр өөрөө хажууд байрладаг. Энэ нь таны хийх дуудлага бүрт ижил ID байна.

Туршиж үзэх

Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.

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