Welcome to QBIS Docs
Dễ dàng sử dụng
Dễ dàng triển khai
Dễ dàng tích hợp
QBIS hỗ trợ tích hợp linh hoạt với các hệ thống bên ngoài thông qua giao thức RESTful API sử dụng định dạng dữ liệu JSON. Các hệ thống có thể gửi yêu cầu (Request) đến QBIS hoặc nhận dữ liệu từ QBIS theo các cơ chế sau:
API Pull: Hệ thống bên ngoài chủ động gọi API của QBIS để lấy / cập nhật dữ liệu.
API Push: QBIS chủ động gửi dữ liệu đến API endpoint của hệ thống đối tác khi có sự kiện phát sinh.
Mô hình tổng quát: [Hệ thống bên ngoài] <---> [QBIS API Gateway] <---> [QBIS Core Modules]
Hệ thống bên ngoài: CRM, ERP, Website, Mobile App, v.v. của đối tác
QBIS API Gateway: Trung gian tiếp nhận, xác thực và xử lý request/response.
QBIS Core Modules: Các phân hệ nghiệp vụ xử lý dữ liệu bên trong QBIS.
Phương thức giao tiếp:
| Thành phần | Phương thức | Mô tả |
|---|---|---|
| Xác thực | API Key | Mỗi hệ thống cần được cấp quyền truy cập thông qua API Key. |
| Giao thức | HTTPS | Mọi giao tiếp đều thực hiện qua HTTPS để đảm bảo an toàn. |
| Dữ liệu | JSON | Định dạng dữ liệu chuẩn, hỗ trợ Unicode (UTF-8). |
Tất cả API đều theo phương thức HTTP POST, với mô tả chung như sau:
| Trường thông tin | Mô tả |
|---|---|
| Phương thức | HTTP POST |
| Url | |
| Content type | application/json |
| Body data |
Thông tin xác thực sẽ nằm trong body data
Hệ thống bên ngoài gọi các API endpoint của QBIS.
QBIS cấu hình webhook hoặc API push thông qua cấu hình các app connect ở màn hình tính năng automation
Dữ liệu sẽ được gửi theo sự kiện thông qua việc cấu hình Activity ở màn hình tính năng automation
Retry tự động: Nếu push dữ liệu thất bại, QBIS sẽ không tự động retry.
Logging: Ghi log toàn bộ lịch sử giao tiếp.
Versioning: Hỗ trợ nhiều phiên bản API để đảm bảo tính ổn định.