Hướng dẫn cấu hình
Tổng quan về cấu hình webhook
Có hai cách để cấu hình webhook: bạn có thể cấu hình trên Partner Center hoặc sử dụng Event API.
Yêu cầu
- Bạn đã quen thuộc với cách webhook hoạt động.
- Bạn đã xác thực với TikTok Shop API
- Bạn có các quyền cần thiết cho các topic mà bạn đang đăng ký.
Yêu cầu về Webhook URL
- Sử dụng scheme
https:// - Sử dụng TLS v1.2+
- Webhook URL chỉ có thể là tên miền, không phải địa chỉ IP, và không được có cổng (port)
- Thành công trả về 200, và xác thực thất bại trả về 401
Cách 1: Cấu hình webhook trên Partner Center
Bước 1: Cấu hình webhook URL trên Partner Center
- Thêm một HTTP Server URL trong tab 'Developing' dưới mục 'Basic information' để nhận thông báo webhook.
Bước 2: Quyết định topic webhook nào cần đăng ký
TikTok Shop Partner Center tự động đăng ký app của bạn nhận các thông báo webhook mặc định. Bạn có thể quản lý các đăng ký webhook trong tab 'Developing' để chọn các sự kiện và hành động cụ thể mà bạn muốn nhận thông báo.
Bước 3: Nhận webhook
TikTok Shop gửi một yêu cầu HTTP POST đến URL đã được chỉ định mỗi khi sự kiện đó xảy ra. Các tham số của yêu cầu HTTP POST chứa dữ liệu JSON liên quan đến sự kiện đã kích hoạt yêu cầu.
TikTok Shop xác minh các chứng chỉ SSL khi gửi payload đến các địa chỉ webhook HTTPS. Hãy đảm bảo máy chủ của bạn được cấu hình đúng để hỗ trợ HTTPS với một chứng chỉ SSL hợp lệ.
Để xác thực các thông báo webhook đến, TikTok Shop bao gồm một mã chữ ký trong trường 'Authorization' của header yêu cầu HTTP. Nhà phát triển nên xác minh chữ ký này, và hướng dẫn để tạo nó có thể được tìm thấy tại đây.
Bước 4: Phản hồi webhook
Để xác nhận đã nhận thành công một thông báo webhook, HTTP server url cần cung cấp một phản hồi phù hợp để khai báo rằng đã nhận thông báo thành công.
Các phản hồi HTTP được chấp nhận bao gồm những phản hồi dưới đây:
| Header | Body | Response Interval |
|---|---|---|
| 200 | NULL / empty | trong vòng 3 giây cho mỗi thông báo |
| 401 | NULL / empty | trong vòng 3 giây cho mỗi thông báo |
Việc không làm như vậy sẽ dẫn đến việc TikTok Shop gửi lại thông báo webhook. Sẽ không có thêm lần thử nào sau lần thử lại thứ 4 thất bại.
| Retry | Trigger |
|---|---|
| 1st Retry | 2 phút sau khi lần gửi ban đầu thất bại |
| 2nd Retry | 30 phút sau khi lần thử lại thứ 1 thất bại |
| 3rd Retry | 3 giờ sau khi lần thử lại thứ 2 thất bại |
| 4th Retry | 12 giờ sau khi lần thử lại thứ 3 thất bại |
Cách 2: Cấu hình webhook bằng Event API
Dưới đây là các Event API mà bạn có thể sử dụng để cấu hình webhook:
- Update Shop Webhook: Sử dụng API này để tạo một webhook đặc biệt cho một shop cho một sự kiện nhất định. Việc này tương đương với bước 1 và 2 nếu bạn cấu hình webhook trong Partner Center.
- Get Shop Webhooks: Sử dụng API này để lấy tất cả các cấu hình webhook của shop
- Delete Shop Webhook: Sử dụng API này để hủy webhook của một shop cho một sự kiện nhất định
Làm thế nào để kiểm tra lịch sử sự kiện webhook?
TikTok Shop Partner Center cũng cung cấp một cổng để giám sát tất cả các log gửi webhook, cho phép bạn debug và xác nhận việc nhận webhook thành công bởi máy chủ URL của bên nhận. Để truy cập tính năng này, hãy vào Partner Console >> Development Kits >> Webhook Log. Từ đó, chọn app cụ thể mà bạn muốn xem log webhook.