تخطَّ إلى المحتوى

مفاتيح الـ API

POST /api/v1/api-keys

ينشئ مفتاح API جديدًا للمستخدم المصادق عليه.

{
"name": "My integration"
}
الحقلمطلوبالوصف
nameنعماسم عرض للمفتاح (1-100 حرف)
{
"data": {
"id": "key_uuid",
"name": "My integration",
"prefix": "rm_abc123",
"key": "rm_abc123def456...",
"created_at": "2025-09-19T15:00:00.000Z"
}
}

GET /api/v1/api-keys

يعرض جميع مفاتيح API للمستخدم المصادق عليه. لا يتم إرجاع قيمة المفتاح الكاملة أبدًا بعد الإنشاء.

{
"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
}
]
}

DELETE /api/v1/api-keys/:id

يلغي مفتاح API بشكل دائم. ستفشل الطلبات التي تستخدم هذا المفتاح على الفور مع رسالة INVALID_API_KEY.

{
"data": { "success": true }
}
الرمزحالة HTTPالمعنى
API_KEY_NOT_FOUND404المفتاح غير موجود أو ينتمي إلى مستخدم آخر
ALREADY_REVOKED400تم إلغاء المفتاح بالفعل