api-keys

GET /v1/api-keys/{apiKeyId}

Get an API key.

Semua titik akhir api-keys

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Titik akhir ini tidak memerlukan id organisasi. Kunci anda telah mengenal pasti organisasi kepunyaannya, dan respons dis skopkan kepadanya.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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

Parameter

NamaJenisDiperlukanApakah ia
apiKeyId (path)UuidYaThe API key's id.

Respons

NamaJenisDiperlukanApakah ia
idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
namestringYa
prefixstringYaThe key's public lookup id (the middle segment of the token).
scopesstring[]YaThe RBAC permission keys this key may exercise.
sandboxbooleanYaA sandbox (test-mode) key suppresses billing + provisioning (docs/09 §2).
last_used_atobjectTidakWhen the key last authenticated a request; null if never used.
revoked_atobjectTidakAlways null on a listed/fetched key — revoked keys are not returned.
created_atstringYa

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 429