ThueAPITạo Hook
Token là gì ?
Token được sinh ra ở bước Tạo Hook trên ThueAPI.com.
Token giúp xác minh dữ liệu giao dịch là chính xác được gửi từ ThueAPI qua hệ thống của bạn thông qua các endpoint được khai báo.
Lưu ý
Token này được sinh ra một lần duy nhất ở bước Tạo Hook trên ThueAPI.
Cách tạo Hook + Token
Đầu tiên các bạn truy cập vào khu vực Hooks -> chọn Hooking -> Thêm sẽ thấy giao diện như sau:
Các tham số tạo Hook:
- Tài khoản
- Provider
- Endpoint
- Tiêu đề thông báo nhận tiền / chuyển tiền
- Token
- Phương thức
- Sự kiện
- Gửi kèm thông tin số dư
Tài khoản
Đây là mục cho phép bạn chọn tài khoản muốn Hook gửi dữ liệu giao dịch đi sang hệ thống khác. Tài khoản này được thêm ở phần Liên kết trên hệ thống ThueAPI.
Nghĩa là bạn cần phải liên kết tài khoản trước khi chuyển qua bước Tạo Hook này !
Provider
Đây là chính là các kênh thông báo mà ThueAPI hiện đang hỗ trợ: Slack, Telegram, Larksuite, Webhook...
Endpoint
Là địa chỉ sẽ nhận dữ liệu được ThueAPI gửi tới theo điều kiện thiết lập. Bạn có thể chỉ định tùy ý đầu nhận dữ liệu ở mục này.
- Đối với Slack, endpoint chính là địa chỉ Webhook bạn nhận được khi tạo app và thêm chúng vào Workspace Channel của bạn.
- Đối với Telegram, bạn cần khởi tạo 1 Channel và tiến hành tạo @username cho channel của bạn. Sau đó tìm và thêm @Codetaybot vào channel vừa tạo để bot có thể gửi thông báo vào channel này, lúc này endpoint chính là @username của channel của bạn.
- Đối với Larksuite, endpoint chính là địa chỉ Webhook khi bạn thêm chatbot vào Messenger Group của bạn.
Đối với các bạn sử dụng plugins của ThueAPI thì endpoint sẽ được khai báo theo cú pháp tương ứng đối với từng plugins như sau:
WooCommerce:
https://website.com/wc-api/thueapiEasy Digital Downloads:
https://website.com/wp-json/thueapi/eddWHMCS:
https://website.com/modules/gateways/callback/ThueAPICallback.php
Tùy thuộc vào website của bạn có sử dụng SSL hay không mà lựa chọn http hoặc https cho phù hợp!
Token
Là chuỗi độ dài tối đa 50 ký tự và dùng để định danh dữ liệu gửi đi từ ThueAPI tới Endpoint của bạn là hợp lệ.
Chuỗi này là duy nhất và chỉ hiển thị một lần khi bạn tạo Hook do đó bạn cần copy ngay chuỗi này để sử dụng sau này.
Tiêu đề thông báo nhận tiền / chuyển tiền
Khi bạn sử dụng các kênh thông báo: Slack, Telegram, Larksuite... (trừ Webhook) thì đây sẽ là tiêu đề để phân biệt 2 loại giao dịch nhận tiền và chuyển tiền trên tài khoản
Phương thức
Bạn có thể chỉ định phương thức mà ThueAPI sẽ dùng để gửi dữ liệu sang Endpoint, phương thức hỗ trợ là POST hoặc GET
Sự kiện
Sự kiện chính là dữ liệu mà bạn muốn ThueAPI sẽ gửi sang Endpoint. Dữ liệu này có thể là:
- All (tất cả sự kiện)
- Payment (cả in + out)
- In (nhận tiền)
- Out (chuyển tiền)
- Change (thay đổi thông tin)
Gửi kèm thông tin số dư
Cho phép số dư tài khoản lúc giao dịch có được gửi kèm qua hook hay không
Cycle gửi dữ liệu
Mặc định dữ liệu sẽ được check tuần tự 60s/lần và được gửi ngay sau đó.