Webhooks والأحداث
Webhook هو خدمة إشعارات منهجية تتيح التكامل غير المتزامن بين الأنظمة — تُخطر Unico IDCloud الخادم الخلفي الخاص بك في كل مرة تتغير فيها حالة عملية ما، بحيث لا تحتاج إلى الاستعلام المتكرر عن التحديثات.
يغطي هذا القسم الأمور الأربعة التي تحتاجها لدمج webhooks: كيفية إعداد endpoint والمصادقة، والأحداث التي ترسلها Unico، واستراتيجية الاحتياطي، وأنماط الأمان والموثوقية التي يجب أن يطبقها endpoint الخاص بك.
متى تستخدم Webhooks
تُعدّ Webhooks الطريقة الموصى بها للحصول على إشعار عند اكتمال العملية. وهي ذات أهمية خاصة في:
- تدفقات Web وSDK غير المتزامنة — للحصول على إشعار عند انتهاء معالجة
POST /client/v1/processعلى جانب Unico. - التدفقات طويلة الأمد التي تجمع قدرات متعددة (مثل تحليل المستندات + المراجعة اليدوية). تُطلَق Webhooks فقط عند الحالة النهائية (
PROCESS_STATE_FINISHED)؛ ولا يتم تسليم أي أحداث تقدم وسيطة.
تكمّل Webhooks endpoints GetProcess، لكنها لا تحل محلها. راجع الاحتياطي.
في هذا القسم
- الإعداد — تسجيل endpoint وطرق المصادقة (OAuth2 وBasic وAPI Key) وإعدادات إعادة المحاولة.
- أنواع الأحداث — الأحداث التي ترسلها Unico وبنية الحمولة.
- الأمان — التعامل مع الطلبات المتكررة وحد التزامن ومعدل الأخطاء.
- الاحتياطي — كيفية استرداد نتيجة العملية عندما يكون webhook غير متاح.