api-keys

POST `/v1/api-keys`

Create an API key.

Նույնականացում

Ուղարկեք API բանալին որպես bearer token: Բանալին պետք է ունենա apikeys.manage թույլտվությունը. առանց դրա բանալին մերժվում է 403, և ոչ թե 404 կարգավիճակով:

Որտեղ տեղադրվում է ձեր կազմակերպության ID-ն

Այս վերջնակետը 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