api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

جميع نقاط نهاية api-keys

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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