Giới thiệu
  • Webhooks giúp bạn đăng kí lắng nghe các sự kiện phát sinh từ hệ thống của Nhanh.vn, VD như:
    • Khi có đơn hàng mới, khi đơn hàng thay đổi trạng thái.
    • Khi có sản phẩm mới, khi có cập nhật sản phẩm, khi xóa sản phẩm.
    • Khi có hóa đơn bán hàng mới.
    • Khi có phiếu bảo hành mới.
  • Với mỗi sự kiện Nhanh.vn sẽ gửi sang 1 request có Content type: application/json và request body là json string
    • event: để phân biệt loại sự kiện là gì.
    • businessId: ID doanh nghiệp trên nhanh.vn, dùng khi ứng dụng của bạn tích hợp cho nhiều doanh nghiệp, thì businessId giúp phân biệt dữ liệu của doanh nghiệp nào.
    • data: chứa dữ liệu đi kèm với sự kiện này.
1
[
2
'event': 'orderAdd', // sự kiện khi có đơn hàng mới
3
'businessId': int,
4
'data': [
5
// order's information
6
customerName: string,
7
customerMobile: string,
8
...
9
// order product's information
10
products: [
11
]
12
]
13
]
Copied!

Bật webhooks

  • Vào danh sách ứng dụng
  • Chọn ứng dụng muốn đăng kí webhooks
  • Sửa ứng dụng, kéo xuống mục webhooks, tích chọn Bật webhooks, điền verifyToken (giá trị này do bạn tự điền, Nhanh API sẽ gửi kèm header verifyToken này khi bắn webhooks giúp bạn có thể xác nhận chính xác dữ liệu là từ Nhanh API bắn sang).
  • Chọn các sự kiện muốn đăng kí nhận webhooks và nhấn Lưu.

Xử lý khi tiếp nhận webhooks

  • Hệ thống của bạn cần reponse http code 200 để Nhanh API xác nhận bạn đã xử lý thành công.
  • Nếu hệ thống của bạn không phản hồi, hoặc http code != 200, webhooks sẽ được bắn lại tối đa 3 lần, mỗi lần cách nhau 5, 10, 30 phút.
  • Nếu hệ thống của bạn xử lý webhooks với tỉ lệ thành công thấp, Nhanh API sẽ tự động tắt webhooks của ứng dụng của bạn, để sử dụng lại, bạn cần làm lại các bước bật webhooks như đã mô tả ở trên.
Last modified 5d ago