إنشاء مفتاح واجهة برمجية
إنشاء مفتاح واجهة برمجية
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عند استخدام الجلسة.
المعاملات
| الاسم | الموضع | النوع | إلزامي | الوصف |
|---|---|---|---|---|
projectId | path | string (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"
]
}