مفاتيح الـ API
إنشاء مفتاح API
Section titled “إنشاء مفتاح API”POST /api/v1/api-keysينشئ مفتاح API جديدًا للمستخدم المصادق عليه.
نص الطلب
Section titled “نص الطلب”{ "name": "My integration"}| الحقل | مطلوب | الوصف |
|---|---|---|
name | نعم | اسم عرض للمفتاح (1-100 حرف) |
الاستجابة
Section titled “الاستجابة”{ "data": { "id": "key_uuid", "name": "My integration", "prefix": "rm_abc123", "key": "rm_abc123def456...", "created_at": "2025-09-19T15:00:00.000Z" }}قائمة مفاتيح الـ API
Section titled “قائمة مفاتيح الـ API”GET /api/v1/api-keysيعرض جميع مفاتيح API للمستخدم المصادق عليه. لا يتم إرجاع قيمة المفتاح الكاملة أبدًا بعد الإنشاء.
الاستجابة
Section titled “الاستجابة”{ "data": [ { "id": "key_uuid", "name": "My integration", "prefix": "rm_abc123", "created_at": "2025-09-19T15:00:00.000Z", "last_used_at": "2025-09-20T10:30:00.000Z", "is_revoked": false } ]}إلغاء مفتاح الـ API
Section titled “إلغاء مفتاح الـ API”DELETE /api/v1/api-keys/:idيلغي مفتاح API بشكل دائم. ستفشل الطلبات التي تستخدم هذا المفتاح على الفور مع رسالة INVALID_API_KEY.
الاستجابة
Section titled “الاستجابة”{ "data": { "success": true }}رموز الخطأ
Section titled “رموز الخطأ”| الرمز | حالة HTTP | المعنى |
|---|---|---|
API_KEY_NOT_FOUND | 404 | المفتاح غير موجود أو ينتمي إلى مستخدم آخر |
ALREADY_REVOKED | 400 | تم إلغاء المفتاح بالفعل |