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

تسجيل نقطة Webhook

تسجيل نقطة Webhook

POST/v1/projects/{projectId}/webhook-endpoints

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

يسجّل عنوان HTTPS ويعرض secret مرة واحدة، ولا يخزّن سوى نسخة مغلّفة بـ AES-256-GCM. يُرفض العنوان إذا حلّ إلى شبكة خاصة أو loopback أو link-local أو CGNAT أو عنوان بيانات سحابية منعًا لـ SSRF. يحتاج المفتاح إلى write.

حد المعدّل: 60 طلبًا لكل 60 ثانية لكل مستدعٍ.

رموز الخطأ: unauthorized (401), insufficient_scope (403), not_found (404), invalid_url (400), invalid_body (400), endpoint_limit_reached (409), webhooks_unconfigured (503).

المصادقة

  • apiKey — مفتاح المشروع في ترويسة Authorization: Bearer بصيغة vh_live_... للوضع الفعلي أو vh_test_... للوضع التجريبي، ويحمل صلاحية read و/أو write.
  • sessionCookie — ملف ارتباط جلسة لوحة التحكم الذي يضبطه POST /v1/auth/login. تتطلب مسارات الفيديو والتشغيل أيضًا معامل projectId عند استخدام الجلسة.

المعاملات

الاسمالموضعالنوعإلزاميالوصف
projectIdpathstring (Ulid)نعم—

جسم الطلب

إلزامي

نوع المحتوى: application/json

المخطّط: WebhookEndpointCreateRequest

{
  "url": "https://example.com/webhooks/videohati",
  "description": "Production receiver"
}

الاستجابات

الرمزالمعنى
201سُجّلت النقطة. خزّن secret الآن لأنه لن يُعرض مرة أخرى.
400فشل التحقق من جسم الطلب أو معاملاته. يذكر وصف العملية قيم error.code الدقيقة.
401لم تُقدَّم بيانات اعتماد صالحة.
403بيانات الاعتماد صالحة لكنها لا تسمح بهذا الإجراء. يذكر وصف العملية قيم error.code الدقيقة.
404المورد غير موجود أو غير مرئي لهذا المستدعي.
409يتعارض الطلب مع الحالة الحالية للمورد. يذكر وصف العملية قيم error.code الدقيقة.
429تم تجاوز حد المعدّل.

مثال على الطلب

{
  "url": "https://example.com/webhooks/videohati",
  "description": "Production receiver"
}

جرّبها

POST
/v1/projects/{projectId}/webhook-endpoints
وضع الاختبار فقط

منصة API التفاعلية

أرسل طلبًا حيًا إلى api.videohati.com بمفتاح وضع الاختبار.

تحجب هذه المنصة مفاتيح vh_live_. استخدم مفتاحًا يبدأ بـ vh_test_ فقط؛ لن يغادر أي طلب بمفتاح حي متصفحك.

يُحفظ المفتاح في متصفحك على docs.videohati.com فقط.

https://api.staging.videohati.com/v1/projects/{projectId}/webhook-endpoints

في هذه الصفحة

المصادقةالمعاملاتجسم الطلبالاستجاباتمثال على الطلبجرّبها