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

تدوير سر نقطة Webhook

تدوير سر نقطة Webhook

POST/v1/projects/{projectId}/webhook-endpoints/{id}/rotate-secret

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

ينشئ سر توقيع جديدًا ويعرضه مرة واحدة؛ ويتوقف السر السابق عن توقيع التسليمات فورًا. يحتاج مفتاح المشروع إلى write.

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

رموز الخطأ: unauthorized (401), insufficient_scope (403), endpoint_not_found (404), webhooks_unconfigured (503).

المصادقة

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

المعاملات

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

جسم الطلب

لا تأخذ هذه العملية جسم طلب.

الاستجابات

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

جرّبها

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

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

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

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

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

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