المصادقة

يحمل كل طلب إلى واجهة الخادم البرمجية المفتاح الخاص لمكتبة واحدة، ولا يعمل إلا على تلك المكتبة.

العنوان الأساسينسخ رابط القسم

كل نقاط النهاية في واجهة الخادم البرمجية تقع تحت:

https://api.octavideo.tech/api/v1

تضع الاستجابات الناجحة محتواها داخل data، وتضيف استجابات القوائم meta لمعلومات الصفحات. اقرأ الأخطاء لمعرفة شكل الخطأ، والصفحات والحدود لمعرفة طريقة التقسيم إلى صفحات.

المفتاح الخاصنسخ رابط القسم

لكل مكتبة مفتاح خاص بها. يبدأ المفتاح بـ ovk_ ويمنح الوصول إلى تلك المكتبة وحدها: فيديوهاتها ومجموعاتها ورموز OTP الخاصة بتشغيلها. لا يصل المفتاح أبدًا إلى مكتبة أخرى، لذلك خصّص لكل مشروع أو عميل مكتبة خاصة به.

للحصول على المفتاح:

1. افتح مكتبتك في لوحة التحكم.
2. انتقل إلى الواجهة البرمجية والتضمين ← الخادم المخصّص.
3. تحت المفتاح الخاص، اختر انسخ.

تعرض لوحة التحكم المفتاح مخفيًا ولا تُظهره على الشاشة أبدًا. وإذا منع المتصفح النسخ، تخبرك اللوحة بذلك.

أرسل المفتاحنسخ رابط القسم

أرسل المفتاح في ترويسة AccessKey مع كل طلب:

AccessKey: ovk_your_private_key

يعرض هذا الطلب الصفحة الأولى من فيديوهات المكتبة. يقرأ كل مثال المفتاح من متغيّر البيئة OCTAVIDEO_KEY:

curl "https://api.octavideo.tech/api/v1/videos" \
  -H "AccessKey: $OCTAVIDEO_KEY"

إذا كان المفتاح مفقودًا أو غير صالح، تكون الاستجابة 401 بالرمز unauthorized. لا تحدّد الاستجابة أيّ الحالتين حدثت، لذلك تأكّد أن اسم الترويسة AccessKey بالضبط، وأن المفتاح يخص المكتبة التي تقصدها.

{
  "error": {
    "code": "unauthorized",
    "message": "unauthorized",
    "request_id": "01JBQ7Z9X2R3M4N5P6Q7S8T9V0"
  }
}

أبقِ المفتاح على خادمكنسخ رابط القسم

يستطيع المفتاح الخاص رفع كل فيديو في المكتبة وتعديله وتشغيله. تعامل معه كما تتعامل مع كلمة مرور قاعدة البيانات:

• احفظه في متغيّر بيئة أو في مدير أسرار، ولا تكتبه أبدًا في الكود المصدري.
• استدعِ واجهة الخادم البرمجية من الخادم فقط. لا تضع المفتاح أبدًا في صفحة ويب أو سكربت يعمل في المتصفح أو تطبيق جوّال.
• أعطِ المتصفح النتيجة بدلًا من المفتاح: للتشغيل، يطلب خادمك رمز OTP ويسلّم الصفحة embed_url. اقرأ التشغيل الآمن.

غيّر المفتاحنسخ رابط القسم

إذا تسرّب المفتاح، أو غادر فريقك شخصٌ كان يعرفه، فاستبدله:

1. انتقل إلى الواجهة البرمجية والتضمين ← الخادم المخصّص.
2. اختر أعد إنشاء المفتاح… ثم أكّد بـ أعد إنشاء المفتاح.
3. انسخ المفتاح الجديد وحدّثه على خادمك.

يتوقف المفتاح القديم عن العمل فور إنشاء المفتاح الجديد، فتحصل الطلبات التي ما زالت تستخدمه على 401. حدّث خوادمك فورًا.

الخطوة التاليةنسخ رابط القسم