Cấu hình
Cấu hình địa chỉ đích và đăng ký sự kiện của tổ chức qua Platform hoặc API.
Mỗi tổ chức có một địa chỉ đích webhook và một signing secret (khóa ký) đang hoạt động. Cấu hình trong Platform hoặc từ server của bạn.
| Thông tin | Giá trị |
|---|---|
| Base URL | https://api.sandbox.tapaya.com cho sandbox, https://api.tapaya.com cho production |
| Xác thực | Server Secret Token trong Authorization. Xem Xác thực. |
| Phạm vi | Một địa chỉ đích cho mỗi tổ chức |
| Hướng dẫn liên quan | Xác thực và kiểm tra |
Cấu hình trong Platform
Mở API Keys của tổ chức bạn và tìm Webhooks.
- Nhập URL HTTPS công khai của bạn.
- Chọn các sự kiện bạn cần, hoặc bật Subscribe to all webhook types.
- Bật Enable và nhấp Save.
- Sao chép signing secret và lưu trên server của bạn.
- Gửi một webhook kiểm tra.
Signing secret chỉ hiển thị một lần
Sao chép giá trị này khi bạn tạo hoặc xoay vòng địa chỉ đích; bạn không thể lấy lại sau đó. Giá trị này chỉ dùng để xác thực các webhook đến. Server Secret Token của bạn cấp quyền cho các yêu cầu cấu hình.
Tất cả thao tác
| Thao tác | Dùng để |
|---|---|
| Lưu địa chỉ đích | Tạo hoặc thay thế đăng ký hiện tại, hoặc xoay vòng signing secret của đăng ký. |
| Đọc địa chỉ đích | Lấy URL hiện tại, chế độ đăng ký và trạng thái bật. |
| Xóa địa chỉ đích | Xóa đăng ký cùng hàng đợi và lịch sử gửi. |
Quản lý địa chỉ đích
Quy tắc địa chỉ đích
Thay đổi thiết lập
| Khi bạn | Điều gì xảy ra |
|---|---|
| Thay đổi URL, sự kiện hoặc signing secret | Sự kiện mới dùng thiết lập mới. Các sự kiện trong hàng đợi giữ URL và signing secret cũ, vì vậy hãy giữ cả hai hoạt động cho đến khi hàng đợi được xử lý hết. |
| Tắt webhook | Các lần gửi trong hàng đợi tạm dừng và không ghi nhận sự kiện mới. Bật lại sẽ tiếp tục xử lý hàng đợi, nhưng các thay đổi bị bỏ lỡ không được bổ sung hồi tố. Webhook kiểm tra vẫn hoạt động. |
| Xóa địa chỉ đích | Các sự kiện trong hàng đợi và lịch sử gửi bị xóa. Yêu cầu đang được gửi vẫn có thể đến. Tạo lại địa chỉ đích sẽ tạo signing secret mới. |
Yêu cầu đối với URL
- HTTPS công khai trên cổng 443. Localhost và mạng riêng bị từ chối, và DNS được kiểm tra lại ở mỗi lần kết nối.
- Không có thông tin đăng nhập nhúng, không có phần fragment và không đi theo chuyển hướng.
- Không có header cấp quyền tùy chỉnh. Thay vào đó, hãy xác thực chữ ký Tapaya, hoặc đặt một bộ chuyển tiếp phía server ở trước URL yêu cầu khóa riêng.
Lỗi
Các yêu cầu cấu hình thất bại với những phản hồi sau. Bên nhận từ chối hoặc bỏ lỡ một lần gửi là một vấn đề khác; xem Xử lý lỗi.
| Phản hồi | Ý nghĩa |
|---|---|
400 khi PUT | URL không hợp lệ, loại sự kiện không được hỗ trợ, thiếu trường bắt buộc hoặc danh sách chọn sự kiện cụ thể rỗng. |
401 | Server Secret Token bị thiếu hoặc không hợp lệ. |
404 khi GET | Tổ chức sở hữu Server Secret Token chưa có địa chỉ đích. |
Tiếp tục với xác thực chữ ký và gửi kiểm tra.
Trang này còn thiếu điều gì?Đề xuất tính năng. Chúng tôi sẽ đính kèm trang này để đội ngũ nắm được bối cảnh.