صفحه کجاست

- ۱گروه «اتصال و سامانه» در بخش تنظیمات منوی کناری
- ۲«وبهوکها» — همین صفحه
- ۳«کلیدهای API» — راهنمای کلیدهای API
- ۴«وضعیت سامانه» — راهنمای وضعیت سامانه
نمای صفحه

- ۱عنوان صفحه: «وبهوکها»
- ۲کادر «راهنمای وبهوک»
- ۳شمار وبهوکهای ثبتشده
- ۴«ارسال تست» — یک رویداد آزمایشی به همهٔ وبهوکهای فعال میفرستد
- ۵«وبهوک جدید»
- ۶پیام «هنوز وبهوکی ثبت نکردهاید» (حالت دمو)
برای هر وبهوک ثبتشده یک کارت میآید: نشانی، رویدادهای اشتراک (یا «همهٔ رویدادها»)، «شکست پیاپی»، «آخرین کد» پاسخ، «آخرین ارسال»، یک سوییچ فعال/غیرفعال و سه دکمه: «چرخش کلید امضا»، ویرایش و حذف.
ساختن وبهوک

- ۱«آدرس مقصد (URL)» — نشانی کامل با http یا https؛ بهتر است https باشد
- ۲«رویدادهای اشتراک» — روی هر رویداد بزنید تا انتخاب شود
- ۳رویداد انتخابشده تیره میشود
- ۴«بدون انتخاب = همهٔ رویدادها»
- ۵«ساخت وبهوک» — پس از ساخت، کلید امضا یک بار نمایش داده میشود
- ۶«لغو»
پس از «ساخت وبهوک» پنجرهٔ «کلید امضای وبهوک» باز میشود. با «کپی کلید» آن را بردارید و به برنامهنویس بدهید؛ پس از بستن پنجره دیگر نمایش داده نمیشود. اگر گم شد یا لو رفت، «چرخش کلید امضا» کلید تازه میسازد و کلید قبلی از همان لحظه بیاعتبار است.
کدام رویدادها ارسال میشوند
| رویداد | چه وقت | در data |
|---|---|---|
ORDER_CREATED | ثبت سفارش تازه | سفارش |
ORDER_UPDATED | ویرایش سفارش | سفارش |
ORDER_KITCHEN_STATUS_UPDATED | تغییر وضعیت آشپزخانه | orderId، kitchenStatus، branchId |
ORDER_PAYMENT_STATUS_UPDATED | تسویه یا تغییر وضعیت پرداخت | orderId، status، branchId |
ORDER_DELIVERY_STATUS_UPDATED | تغییر وضعیت ارسال پیک | orderId، deliveryStatus، branchId |
ORDER_ETA_UPDATED | ثبت زمان آماده شدن سفارش | orderId، estimatedReadyAt، branchId |
MENU_ITEM_AVAILABILITY_CHANGED | ناموجود یا دوباره موجود شدن آیتم منو | menuItemId، isAvailable، stock، branchId (خالی یعنی همهٔ شعبهها) |
RESERVATION_CREATED | ثبت رزرو، از پنل یا از منوی مهمان | رزرو |
RESERVATION_STATUS_UPDATED | تأیید، نشستن، لغو یا تغییر دیگر وضعیت رزرو | id، status، tableId |
SETTINGS_UPDATED | ذخیرهٔ تنظیمات مجموعه یا پیکربندی منو | settingId، updatedAt |
آنچه برنامهنویس لازم دارد
| مورد | مقدار |
|---|---|
| روش | POST با بدنهٔ JSON: { "event": "...", "restaurantId": ..., "timestamp": ..., "data": {...} } |
| سرایندها | X-Qzin-Event (نام رویداد)، X-Qzin-Timestamp (زمان به میلیثانیه)، X-Qzin-Signature |
| امضا | HMAC_SHA256(secret, "<timestamp>.<raw body>") بهصورت hex. گیرنده باید امضا را با کلید خودش بسازد و مقایسه کند |
| پاسخ موفق | هر کد ۲xx |
| مهلت | ده ثانیه برای هر تلاش |
| تلاش دوباره | تا سه بار: فوری، دو ثانیه بعد، ده ثانیه بعد |
| ترتیب | ارسالها همزمان و مستقلاند؛ ترتیب رسیدن تضمین نمیشود. از timestamp برای مرتب کردن استفاده کنید |
خطا و غیرفعال شدن خودکار
اگر هر سه تلاش یک رویداد ناموفق شود، «شکست پیاپی» یکی بالا میرود و کارت زرد میشود؛ یک ارسال موفق آن را صفر میکند. پس از ۲۰ شکست پیاپی، وبهوک خودکار غیرفعال میشود و دیگر چیزی نمیفرستد. پس از رفع مشکل سمت گیرنده، سوییچ کارت را روشن کنید؛ پیام «وبهوک فعال شد و شمارندهٔ خطا صفر شد» میآید.
رویدادهایی که در زمان غیرفعال بودن یا خرابی گیرنده رخ دادهاند دوباره ارسال نمیشوند. اگر چیزی از دست رفته، آن را با کلید API از فهرست سفارشها بخوانید.
| پیام | چه کنید |
|---|---|
| آدرس معتبر با http یا https وارد کنید | نشانی کامل را با https:// وارد کنید |
| ذخیرهٔ وبهوک ناموفق بود | دوباره تلاش کنید؛ اگر ماند، با پشتیبانی تماس بگیرید |
دسترسی و پلن
صفحه در پلن تجاری و زنجیرهای است، و در پلن حرفهای با افزودنی «API و Webhook».
| کار | نقشها |
|---|---|
| دیدن، ساختن، ویرایش، چرخش کلید و حذف | مالک، مدیر |
مطالب مرتبط
نقشها: مالک و مدیر
همهٔ مقالههای این بخش