Hướng dẫn sử dụng QBIS.VN
Tìm hiểu cách cấu hình phần mềm phù hợp với cơ cấu tổ chức, quy trình hoạt động và nội dung công việc của công ty bạn.
Tìm hiểu cách cấu hình phần mềm phù hợp với cơ cấu tổ chức, quy trình hoạt động và nội dung công việc của công ty bạn.
Tổng quan tích hợp API
QBIS hỗ trợ tích hợp linh hoạt với các hệ thống bên ngoài thông qua RESTful API sử dụng định dạng JSON chuẩn.
Nội dung
Kiến trúc
Toàn bộ giao tiếp giữa hệ thống bên ngoài và QBIS đều đi qua một lớp trung gian duy nhất là QBIS API Gateway — lớp này chịu trách nhiệm tiếp nhận, xác thực và chuyển tiếp request đến các module nghiệp vụ bên trong.
| Thành phần | Vai trò |
|---|---|
| Hệ thống bên ngoài | Phần mềm kế toán (MISA, FAST...), Website/Mobile App, Mini App, Sàn thương mại điện tử, Kênh bán hàng, Kênh chat — kết nối trao đổi dữ liệu với QBIS qua API |
| QBIS API Gateway | Lớp trung gian tiếp nhận, xác thực và điều phối request/response. Ghi log toàn bộ lịch sử giao tiếp, hỗ trợ versioning và rate limiting |
| QBIS Core Modules | Các phần mềm nghiệp vụ của QBIS: SPOS (Sửa chữa & Bán hàng), SSALE (Sales & CRM), STOUR (Du lịch), SCELL (Bảo hành), SGARA (Garage), HRM, ERP, Platform |
Cơ chế
QBIS hỗ trợ hai hướng giao tiếp, có thể dùng độc lập hoặc kết hợp cả hai trong cùng một hệ thống tích hợp.
Hệ thống bên ngoài chủ động gọi API của QBIS để lấy hoặc cập nhật dữ liệu. Phù hợp cho đồng bộ theo yêu cầu hoặc định kỳ.
QBIS chủ động gửi dữ liệu đến endpoint của đối tác khi có sự kiện phát sinh. Phù hợp cho thông báo real-time.
Giao thức
| 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 riêng. Key được đặt trong body data của request. |
| Giao thức | HTTPS |
Mọi giao tiếp đều thực hiện qua HTTPS để đảm bảo mã hóa và an toàn dữ liệu truyền tải. |
| Dữ liệu | JSON |
Định dạng dữ liệu chuẩn cho cả request và response. Hỗ trợ đầy đủ Unicode UTF-8. |
| HTTP Method | POST |
Tất cả API QBIS đều sử dụng HTTP POST, kể cả các thao tác đọc dữ liệu. |
body data của request, không đặt trong header Authorization.Request
Tất cả API đều theo phương thức HTTP POST với cấu trúc thống nhất:
| Trường | Giá trị | Mô tả |
|---|---|---|
| Phương thức | HTTP POST |
Bắt buộc dùng POST cho mọi endpoint |
| URL | https://api.qbis.vn/v1/{endpoint} |
Base URL + tên endpoint |
| Content-Type | application/json |
Bắt buộc khai báo trong header |
| Body data | JSON object |
Chứa tham số nghiệp vụ + 3 thông tin xác thực |
Ví dụ Request (cURL)
curl -X POST https://api.qbis.vn/v1/{endpoint} \
-H "Content-Type: application/json" \
-d '{
"api_key": "qbis_key_xxxx",
"secret_key": "qbis_secret_xxxx",
"store_key": "088287028781",
"param1": "value1"
}'
Cấu trúc Response
// Thành công
{ "success": true, "code": 200, "data": { ... } }
// Lỗi
{ "success": false, "code": 401, "message": "api_key không hợp lệ" }
API Push
Sử dụng tính năng Automation để cấu hình QBIS đẩy dữ liệu — không cần viết code phía QBIS.
Độ tin cậy
| Cơ chế | Trạng thái | Chi tiết |
|---|---|---|
| Retry tự động | Không hỗ trợ | Nếu push thất bại, QBIS sẽ không tự động thử lại. Hệ thống nhận cần xử lý idempotent. |
| Logging | ✓ Có | Toàn bộ lịch sử giao tiếp được ghi log và tra cứu trong màn hình Automation. |
| Versioning | ✓ Có | Hỗ trợ nhiều phiên bản API (/v1/, /v2/...) để đảm bảo ổn định khi nâng cấp. |
| Mã hóa | ✓ Có | Tất cả giao tiếp qua HTTPS/TLS. Không hỗ trợ HTTP thuần. |