فيديوهاتيالتوثيق

مرجع الواجهة البرمجية

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

تعيش واجهة فيديوهاتي البرمجية تحت https://api.videohati.com/v1. يغطّي هذا المرجع ما يستدعيه المطوّر بمفتاح الواجهة البرمجية: الفيديوهات، وتدفّق الرفع المُجزّأ، وإنشاء جلسة البثّ، وإدارة نقاط وصول خطافات الويب. مضيف التجربة هو https://api.staging.videohati.com.

المصادقة

كل نداء تجريه يستخدم بيانات اعتماد واحدة:

  • مفتاح الواجهة البرمجيةAuthorization: Bearer vh_live_... (الوضع المباشر) أو Authorization: Bearer vh_test_... (وضع التجربة). المفاتيح مقيَّدة بمشروع واحد وتحمل صلاحيتَي read و/أو write. تنشئ المفاتيح وتديرها من لوحة التحكّم.

يصادق المشغّل نداءاته بنفسه برمز الجلسة قصير العمر الذي ينشئه خادمك — ولا تستدعي تلك النقاط بنفسك أبدًا.

ترسل ساحة التجربة داخل الصفحة طلبات مباشرة بمفتاح vh_test_. وترفض مفاتيح vh_live_ كي لا تُشغّل طلبًا في الوضع المباشر من التوثيق.

ابدأ من البداية السريعة للحصول على مفتاح تجربة من أوّله لآخره، أو اختر عميلًا من حزم SDK لترى كيف تتولّى كلّ لغة هذا الأمر نيابةً عنك.

الأخطاء

يستخدم كل خطأ مغلِّفًا واحدًا:

{ "error": { "code": "<machine_code>", "message": "<human text>" } }

راجع الأخطاء لخريطة رموز الحالة والرموز المشتركة.

التصفّح

تقبل نقاط وصول القوائم limit (من 1 إلى 100، الافتراضي 25) ومؤشّرًا مبهمًا cursor. تحمل الاستجابة nextCursor عند وجود صفحات إضافية.

حدود المعدّل

تعيد العمليات المحدودة بالمعدّل الرمز 429 مع الترويسات X-RateLimit-Limit وX-RateLimit-Remaining وRetry-After. تذكر صفحات كل عملية الحدّ المطبَّق.

خطافات الويب

تستقبل نقاط الوصول المسجَّلة عمليات تسليم أحداث موقَّعة بـ HMAC. راجع الأحداث للاطّلاع على المغلِّف وأسماء الأحداث وكيفية التحقّق من التوقيع.