توثيق الويب هوكس
استلم إشعارات HTTP موقعة فورية عند وقوع أحداث الأوردرات في حساب وينجز.
أحداث فورية
التحقق من توقيع HMAC
تخصيص محتوى الطلب
دليل الربط
اربط خادمك بويب هوكس وينجز وعالج أحداث الأوردرات بأمان.
نظرة عامة
تتيح لك ويب هوكس وينجز استلام إشعارات HTTP فورية عند وقوع أحداث الأوردرات في حسابك. سجّل رابطاً لكل نوع حدث؛ نرسل طلباً موقّعاً ببيانات الأوردر.
- أضف رابط webhook واختر الإجراء (مثل order-create).
- انسخ مفتاح التوقيع المعروض مرة واحدة — واحفظه بأمان على سيرفرك.
- عند وقوع الحدث، يرسل وينجز بيانات JSON إلى رابطك مع رؤوس HMAC.
- تحقق من التوقيع، ثم عالج بيانات الأوردر.
- أرجع استجابة HTTP 2xx بسرعة؛ واستخدم سجل الويب هوك لتتبع التسليم.
الأحداث المتاحة
| معرّف الحدث | متى يُطلق |
|---|---|
order-create |
فور حفظ أوردر جديد في حسابك. |
order-update |
كلما تم تحديث أي حقل في الأوردر. |
order-status-changed |
عند تغيير حالة الأوردر (إضافةً إلى تحديث الأوردر). |
order-delete |
عند الحذف الناعم للأوردر. |
طلب HTTP
| الطريقة | POST, PUT, أو PATCH (يُحدد لكل ويب هوك)
|
|---|---|
| Content-Type | application/json |
| User-Agent | Wingezz-Webhooks/1.0 |
| المهلة | ينتظر وينجز حتى 20 ثانية لاستجابة سيرفرك. |
ترويسات الطلب
| الترويسة | الوصف |
|---|---|
X-Wingezz-Hmac-Sha256 |
توقيع HMAC-SHA256 مشفر بـ Base64 لجسم الطلب باستخدام سر توقيع الويب هوك. |
X-Wingezz-Event |
معرّف الحدث (مثال: order-create). |
X-Wingezz-Webhook-Id |
معرّف إعداد الويب هوك الخاص بك. |
X-Wingezz-Delivery-Id |
معرّف فريد لمحاولة التسليم هذه. |
التحقق من التوقيعات
احسب HMAC-SHA256 لجسم الطلب باستخدام سر التوقيع ثم شفّره بـ Base64. قارنه برأس X-Wingezz-Hmac-Sha256 بمقارنة آمنة زمنياً.
// PHP example
$secret = 'your_webhook_signing_secret';
$rawBody = file_get_contents('php://input');
$expected = base64_encode(hash_hmac('sha256', $rawBody, $secret, true));
$provided = $_SERVER['HTTP_X_WINGEZZ_HMAC_SHA256'] ?? '';
if (!hash_equals($expected, $provided)) {
http_response_code(401);
exit('Invalid signature');
}
مثال على البيانات الافتراضية
إذا لم تضبط تعيين محتوى مخصص، سيتم إرسال البيانات الافتراضية كاملة:
{
"event": "order-create",
"sent_at": "2026-09-02T10:30:00+03:00",
"order": {
"id": 12345,
"serial_no": "WNG-12345",
"reference_no": "REF-001",
"type": "Delivery",
"status": "جديد",
"status_en": "New",
"customer_name": "Ahmed",
"customer_phone": "201012345678",
"govern": "Cairo",
"area": "Nasr City",
"cost": 150,
"deliver_cost": 30,
"source": "api",
"created_at": "2026-09-02T10:00:00+03:00"
}
}
تخصيص محتوى الطلب
يمكنك تعريف مفاتيح JSON خاصة وربطها بحقول الأوردر. تُحوَّل المفاتيح الخارجية إلى قيم مقروءة (اسم الحالة بدل معرّفها، واسم المحافظة بدل govern_id، إلخ). لا تُعرض المعرّفات الداخلية أو الحقول الحساسة أبداً.
يمكنك أيضاً إضافة رؤوس HTTP مخصصة (مثل Authorization أو X-Api-Key) من صفحة إعدادات الويب هوك. رؤوس توقيع وينجز تُضبط تلقائياً ولا يمكن تجاوزها.
أدر الويب هوكس من لوحة وينجز تحت الويب هوكس، أو من إعدادات ملف التاجر.
ملاحظات أمنية
- تحقق دائماً من توقيع HMAC قبل معالجة بيانات الويب هوك.
- الويب هوكس تتضمن فقط بيانات الأوردرات التابعة لحساب التاجر الخاص بك.
- يُسمح فقط بحقول الأوردر المعتمدة في البيانات المخصصة.
- احفظ سر التوقيع بأمان؛ وأعد إنشاؤه إذا تم اختراقه.
- يجب أن تستخدم روابط الويب هوك بروتوكول HTTPS ولا يمكن أن تستهدف شبكات خاصة أو نقاط بيانات سحابية.