api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Бүх api-keys төгсгөлийн цэгүүд

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

API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.

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

Туршиж үзэх

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

curl -X GET https://api.zinndigital.com/v1/api-keys/{apiKeyId} \
  -H "Authorization: Bearer zdk_live_…"

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

Дэлгэрэнгүй

Returns one non-revoked key's metadata (never the secret). RBAC + RLS scoped.

Параметрүүд

НэрТөрөлЗаавал шаардлагатайЭнэ юу вэ
apiKeyId (path)UuidТиймThe API key's id.

Хариу үйлдэл

НэрТөрөлЗаавал шаардлагатайЭнэ юу вэ
idUuidТиймUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringТийм
prefixstringТиймThe key's public lookup id (the middle segment of the token).
scopesstring[]ТиймThe RBAC permission keys this key may exercise.
sandboxbooleanТиймA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectҮгүйWhen the key last authenticated a request; null if never used.
revoked_atobjectҮгүйAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringТийм

Энэ төгсгөл цэгээс буцааж болох алдаанууд

401 · 403 · 404 · 429