المصادقة
يجب مصادقة جميع طلبات واجهة برمجة التطبيقات باستخدام مفتاح واجهة برمجة التطبيقات.
عنوان URL الأساسي
Section titled “عنوان URL الأساسي”https://api.recordmeeting.com/v1مصادقة مفتاح واجهة برمجة التطبيقات (API)
Section titled “مصادقة مفتاح واجهة برمجة التطبيقات (API)”قم بتضمين مفتاح واجهة برمجة التطبيقات الخاص بك في ترويسة Authorization:
Authorization: Bearer <your_api_key>لإنشاء مفتاح واجهة برمجة تطبيقات، راجع دليل المستخدم ← مفاتيح واجهة برمجة التطبيقات.
مثال على الطلب
Section titled “مثال على الطلب”curl -X GET "https://api.recordmeeting.com/v1/recordings" -H "Authorization: Bearer rm_your_api_key_here"استجابات الخطأ
Section titled “استجابات الخطأ”تتبع جميع الأخطاء هذا التنسيق:
{ "error": { "code": "ERROR_CODE", "message": "Human readable description" }}رموز خطأ المصادقة
Section titled “رموز خطأ المصادقة”| الرمز | حالة HTTP | المعنى |
|---|---|---|
UNAUTHORIZED | 401 | ترويسة Authorization مفقودة أو خاطئة التكوين |
INVALID_API_KEY | 401 | المفتاح غير موجود أو تم إلغاؤه |
API_KEY_EXPIRED | 401 | انتهت صلاحية المفتاح |
USER_NOT_FOUND | 401 | لم يعد المستخدم المرتبط بالمفتاح موجودًا |
FORBIDDEN | 403 | تمت المصادقة، ولكن لا توجد صلاحية لهذا المورد |
رموز الأخطاء الشائعة
Section titled “رموز الأخطاء الشائعة”| الرمز | حالة HTTP | المعنى |
|---|---|---|
RECORDING_NOT_FOUND | 404 | معرّف التسجيل غير موجود أو لا يمكن الوصول إليه |
RECORDING_LOCKED | 403 | تتطلب الميزة ترقية الاشتراك |
ORGANIZATION_SUBSCRIPTION_EXPIRED | 402 | لم تعد المنظمة التي تملك التسجيل لديها اشتراك Enterprise نشط |
TRANSCRIPT_NOT_AVAILABLE | 403 | تعطيل النسخ للمنظمة أو العضو |
SHARING_DISABLED | 403 | تعطيل المشاركة للمنظمة أو العضو |
VALIDATION_ERROR | 400 | معلمات الطلب غير صالحة أو مفقودة |
INTERNAL_ERROR | 500 | خطأ من جانب الخادم |