إعداد مستقبل ويب هوك

قبل أن تبدأ

• استخدم الشركة الصحيحة وحساباً نشطاً مخولاً لهذا المسار.

أين تذهب

التكاملات ← ويب هوك

الفئة المستهدفة

مالكو الشركات ومسؤولوها النشطون.

الصلاحيات

• استخدم صلاحيات حسابك الحالية؛ رابط المساعدة لا يمنح إذناً.

سير العمل

1. افتح التكاملات ← ويب هوك بصفتك مالك الشركة أو مسؤولاً نشطاً فيها. جهّز مستقبلاً على خادمك بعنوان HTTPS قابل للتوجيه علناً؛ تُرفض العناوين المحلية والخاصة.
2. افحص الوجهة ثم احفظ. تقبل PATCH /v1/vendor/<vendor-id>/callback-url الحالية الحقل callbackUrl؛ وتظهر الوجهة المحفوظة منفصلة عن الإدخال غير المحفوظ.
3. عاين محتوى الاختبار: type هو test_event وvendorId هو الشركة المختارة وsentAt وقت الحدث. احفظ التعديلات قبل الاختبار.
4. انقر إرسال حدث اختبار بإجراء صريح. لا يحمل POST /v1/vendor/<vendor-id>/callback-test وجهة في الجسم: يرسل الخادم إلى المستقبل المحفوظ لديه.
5. اقرأ حالة HTTP للمستقبل وسجله المنقح. استجابة 2xx تعني النجاح؛ أما delivered:true مع 4xx أو 5xx فتعني فشل المستقبل. delivered:false أو غياب حالة رقمية يعني نتيجة شبكية أو غير مؤكدة.
6. صحح المستقبل أو احفظ رابط HTTPS عاماً بديلاً، ثم أعد الاختبار صراحةً. لا يمكن فصل الاستدعاء برابط فارغ.
7. لا يوفّر هذا المسار أسرار توقيع أو رؤوساً مخصصة أو اشتراكات أحداث أو محاولات تلقائية أو إعادة إرسال أو سجلات تسليم دائمة أو وجهات متعددة. توقيعات مزود الدفع نظام منفصل.

النتيجة المتوقعة

اقرأ الحالة المحفوظة الحالية في مساحة العمل بعد الإجراء المسموح؛ المساعدة لا تنفذ الإجراء ولا تتحقق منه.

استكشاف الأخطاء وإصلاحها

المستقبل يعيد 404 أو 401/403 أو 429 أو 5xx أو فشل شبكة

تحقق من المسار المحفوظ ومتطلبات تفويض المستقبل وحدود الطلبات والاتصال العام. لا تضع أسرار التكامل في رابط الاستدعاء أو محتواه.

الحفظ يعيد 422

استخدم مضيف HTTPS عاماً يجتاز تحقق الخادم من الوجهة؛ العناوين الخاصة أو غير HTTPS غير مدعومة.

أمثلة للمطورين

حفظ وجهة المستقبل

curl -X PATCH https://api.crewlogix.app/v1/vendor/<vendor-id>/callback-url \
  -H "Authorization: Bearer <session-token>" \
  -H "Content-Type: application/json" \
  --data '{"callbackUrl":"https://receiver.example.com/hook"}'

إرسال اختبار إلى المستقبل المحفوظ

curl -X POST https://api.crewlogix.app/v1/vendor/<vendor-id>/callback-test \
  -H "Authorization: Bearer <session-token>"