مصادقة API
صادق على طلبات Rivya API باستخدام مفاتيح Bearer API، والأذونات محددة النطاق، وعرض السر مرة واحدة، والإلغاء، والتدوير.
آخر مراجعة في 2026/05/10
تستخدم Rivya API مفاتيح API للوصول من خادم إلى خادم.
مفتاح API ليس مثل جلسة تسجيل الدخول في المتصفح. لا تستخدم ملفات cookie، أو حالة جلسة Better Auth، أو رمز متصفح شخصي كبيانات اعتماد عامة لـ API.
صيغة Header
أرسل المفتاح في header باسم Authorization:
Authorization: Bearer rvya_sk_...يعرض المفتاح الكامل مرة واحدة فقط عند إنشائه. تحفظ Rivya قيمة hash وبادئة مرئية، لا السر الكامل.
إنشاء مفتاح
- سجل الدخول إلى Rivya.
- افتح إعدادات API Keys.
- أنشئ مفتاحا بالنطاقات التي تحتاجها.
- انسخ المفتاح الكامل فورا.
- خزنه في مدير أسرار على الخادم أو في متغير بيئة.
لا تضع المفتاح في JavaScript من جهة العميل، أو حزم تطبيقات الهاتف، أو المستودعات العامة، أو أحداث analytics، أو السجلات.
النطاقات الحالية
توثق النسخة الأولى هذه النطاقات:
models:readgenerations:creategenerations:readfiles:createfiles:readcredits:readwebhooks:managechat:createchat:read
تتضمن المفاتيح الجديدة التي تنشأ في Settings النطاقات الموثقة افتراضيا. قد تحتاج المفاتيح الأقدم إلى إعادة إنشائها قبل استخدام Files API أو API Webhooks أو Chat API.
الإلغاء والتدوير
إذا انكشف مفتاح:
- ألغ المفتاح القديم من Settings.
- أنشئ مفتاحا جديدا.
- حدّث السر على الخادم.
- تأكد أن المفتاح الجديد يعمل مع
GET /api/v1/credits. - أزل المفتاح القديم من أنظمة البناء، والسجلات، ومتغيرات النشر.
تعيد المفاتيح الملغاة api_key_revoked.
أخطاء المصادقة
أخطاء المصادقة الشائعة:
api_key_missingapi_key_invalidapi_key_revokedapi_key_expiredapi_scope_deniedpublic_api_disabled
راجع أخطاء API وحدودها للاطلاع على جدول الأخطاء العامة الكامل.