رفتن به محتوای اصلی
چهارده روز رایگان، فعال‌سازی فوری

راهنمای صفحه

وب‌هوک‌ها

رویدادهای سفارش، رزرو، موجودی منو و تنظیمات مجموعه را لحظه‌ای به نرم‌افزار خودتان (حسابداری، انبار، داشبورد) بفرستید؛ هر درخواست امضا دارد تا جعل نشود.

به‌روزرسانی: ۱۱ آبان ۱۴۰۵هماهنگ با نسخهٔ 0.232.1 پنلمسیر در پنل: /admin/settings/webhooksپلن: تجاری و زنجیره‌ای

صفحه کجاست

گروه اتصال و سامانه در بخش تنظیمات منوی کناری،‏ وب‌هوک‌ها،‏ کلیدهای API، و وضعیت سامانه
  1. ۱گروه «اتصال و سامانه» در بخش تنظیمات منوی کناری
  2. ۲«وب‌هوک‌ها» — همین صفحه
  3. ۳«کلیدهای API» — راهنمای کلیدهای API
  4. ۴«وضعیت سامانه» — راهنمای وضعیت سامانه

نمای صفحه

عنوان صفحه: وب‌هوک‌ها،‏ کادر راهنمای وب‌هوک،‏ شمار وب‌هوک‌های ثبت‌شده،‏ ارسال تست،‏ وب‌هوک جدید، و پیام هنوز وب‌هوکی ثبت نکرده‌اید (حالت دمو)
  1. ۱عنوان صفحه: «وب‌هوک‌ها»
  2. ۲کادر «راهنمای وب‌هوک»
  3. ۳شمار وب‌هوک‌های ثبت‌شده
  4. ۴«ارسال تست» — یک رویداد آزمایشی به همهٔ وب‌هوک‌های فعال می‌فرستد
  5. ۵«وب‌هوک جدید»
  6. ۶پیام «هنوز وب‌هوکی ثبت نکرده‌اید» (حالت دمو)

برای هر وب‌هوک ثبت‌شده یک کارت می‌آید: نشانی، رویدادهای اشتراک (یا «همهٔ رویدادها»)، «شکست پیاپی»، «آخرین کد» پاسخ، «آخرین ارسال»، یک سوییچ فعال/غیرفعال و سه دکمه: «چرخش کلید امضا»، ویرایش و حذف.

ساختن وب‌هوک

آدرس مقصد (URL)،‏ رویدادهای اشتراک،‏ رویداد انتخاب‌شده تیره می‌شود،‏ بدون انتخاب = همهٔ رویدادها،‏ ساخت وب‌هوک، و لغو
  1. ۱«آدرس مقصد (URL)» — نشانی کامل با http یا https؛ بهتر است https باشد
  2. ۲«رویدادهای اشتراک» — روی هر رویداد بزنید تا انتخاب شود
  3. ۳رویداد انتخاب‌شده تیره می‌شود
  4. ۴«بدون انتخاب = همهٔ رویدادها»
  5. ۵«ساخت وب‌هوک» — پس از ساخت، کلید امضا یک بار نمایش داده می‌شود
  6. ۶«لغو»

پس از «ساخت وب‌هوک» پنجرهٔ «کلید امضای وب‌هوک» باز می‌شود. با «کپی کلید» آن را بردارید و به برنامه‌نویس بدهید؛ پس از بستن پنجره دیگر نمایش داده نمی‌شود. اگر گم شد یا لو رفت، «چرخش کلید امضا» کلید تازه می‌سازد و کلید قبلی از همان لحظه بی‌اعتبار است.

کدام رویدادها ارسال می‌شوند

رویدادچه وقتدر 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».

کارنقش‌ها
دیدن، ساختن، ویرایش، چرخش کلید و حذفمالک، مدیر

مطالب مرتبط

نقش‌ها: مالک و مدیر

همهٔ مقاله‌های این بخش