فيديوهاتيالتوثيق

إنشاء مفتاح واجهة برمجية

إنشاء مفتاح واجهة برمجية

POST/v1/projects/{projectId}/keys

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

ينشئ مفتاح مشروع بصلاحيات محددة عبر جلسة لوحة التحكم. تعرض الاستجابة keyRaw مرة واحدة فقط، بينما يُخزَّن تجزئة argon2id وحدها.

حد المعدّل: 60 طلبًا لكل 60 ثانية لكل جلسة.

رموز الخطأ: unauthorized (401), not_found (404), invalid_name (400), invalid_scopes (400), key_generation_failed (500).

المصادقة

  • sessionCookie — ملف ارتباط جلسة لوحة التحكم الذي يضبطه POST /v1/auth/login. تتطلب مسارات الفيديو والتشغيل أيضًا معامل projectId عند استخدام الجلسة.

المعاملات

الاسمالموضعالنوعإلزاميالوصف
projectIdpathstring (Ulid)نعم

جسم الطلب

إلزامي

نوع المحتوى: application/json

المخطّط: ApiKeyCreateRequest

{
  "name": "backend-server",
  "scopes": [
    "read",
    "write"
  ]
}

الاستجابات

الرمزالمعنى
201أُنشئ المفتاح. خزّن keyRaw الآن لأنه لن يُعرض مرة أخرى.
400فشل التحقق من جسم الطلب أو معاملاته. يذكر وصف العملية قيم error.code الدقيقة.
401لم تُقدَّم بيانات اعتماد صالحة.
404المورد غير موجود أو غير مرئي لهذا المستدعي.
429تم تجاوز حد المعدّل.
500تعذّر على الخادم إكمال الطلب.

مثال على الطلب

{
  "name": "backend-server",
  "scopes": [
    "read",
    "write"
  ]
}