Logo

Giải pháp quản trị toàn diện cho doanh nghiệp hiện đại

Phần mềm Quản lý Doanh nghiệp – ERP & CRM

Phiên bản: 1.0

Ngày cập nhật: 20/04/2025

Tài liệu kết nối API cung cấp hướng dẫn chi tiết về cách tích hợp hệ thống của bạn với nền tảng phần mềm QBIS thông qua giao diện lập trình ứng dụng (API). Nội dung bao gồm danh sách các endpoint, phương thức HTTP, định dạng request/response, thông số đầu vào, mã lỗi và ví dụ minh họa thực tế. Tài liệu giúp lập trình viên dễ dàng đồng bộ dữ liệu, xây dựng các chức năng mở rộng và kết nối với các hệ thống phần mềm khác một cách hiệu quả, bảo mật.

  • Cơ chế tích hợp với QBIS
  • Các API kết nối
Trang 1

Cơ chế tích hợp với QBIS

  • Mô hình tích hợp dữ liệu với QBIS
  • Thông tin xác thực dùng cho API

Mô hình tích hợp dữ liệu với QBIS

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

QBIS nhận dữ liệu từ hệ thống ngoài / trả dữ lệu cho hệ thống ngoài

  • Hệ thống bên ngoài gọi các API endpoint của QBIS.

QBIS đẩy dữ liệu sang hệ thống ngoài

  • 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

Cơ chế đảm bảo dữ liệu

  • 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.

Thông tin xác thực dùng cho API

Người dùng truy cập vào chức năng Quản trị → Cấu hình phần mềm → API tích hợp QBIS → Bật lựa chọn Cho phép mở kết nối API vào phần mềm

  • Cho phép mở kết nối API vào phần mềm
  • API KEY: hệ thống sẽ tự sinh mã API dùng để xác thực kết nối
  • SECRET_KEY: hệ thống sẽ tự sinh key bảo mật API dùng để xác thực kết nối
  • STORE_KEY: mã định danh đơn vị sử dụng dùng để xác thực kết nối

 

 

 

Sử dụng API Key và Secret Key để lập trình kết nối tích hợp dữ liệu vào QBIS theo mô tả chi tiết ở mục API kết nối

Các API kết nối

  • Lead
  • Call center
  • Bảo hành điện tử
  • Tồn kho
  • Hệ thống
  • Automation

Lead

  • Thêm mới lead

Thêm mới lead

Trường thông tin Mô tả
Phương thức HTTP POST
Url https://db.qbis.vn/api/metadata/saveForm
Content type application/json
Body data {"functionid":"004M088287019","fields":[],"token":"SECRET_KEY","storeid":"STORE_KEY","userid":"API_KEY"}

Call center

  • Truyền cuộc gọi sang CRM để bật popup
  • Thông tin API cập nhật trạng thái CallId

Truyền cuộc gọi sang CRM để bật popup

Trường thông tin Mô tả
Phương thức HTTP POST
Url https://systemqbis.qbis.vn/callcenter
Content type application/json
Body data {"appid":"STORE_KEY","message":"callcenter;so_dien_thoai_den","userid":"USER_ID_NHẬN"}

Thông tin API cập nhật trạng thái CallId

Trường thông tin Mô tả
Phương thức HTTP POST
Url https://db.qbis.vn/api/metadata/saveForm
Content type application/json
Body data {"functionid":"002M088287090","fields":[{"label":"Trạng thái cuộc gọi","mafield":"input0882870601711", "type":"input","typeFix":"input","TypeKey":"input","value":"","id":5570306119368069653,"ObjectId":0},{"label":"Link file ghi âm","mafield":"url0882870601710","type":"url","typeFix":"url","TypeKey":"url","value":"", "id":5170632830618694170,"ObjectId":0}],"token":"","storeid":"","userid":"","id":""}

Bảo hành điện tử

  • Lấy dữ liệu tracking thông tin hạn bảo hành sản phẩm
  • Lấy dữ liệu tracking thông tin sản phẩm đang sửa chữa/bảo hành
  • Kích hoạt bảo hành điện tử
  • Mã nhúng iframe tích hợp các khung tra cứu bảo hành vào website

Lấy dữ liệu tracking thông tin hạn bảo hành sản phẩm

Lấy dữ liệu tracking thông tin sản phẩm đang sửa chữa/bảo hành

Kích hoạt bảo hành điện tử

Mã nhúng iframe tích hợp các khung tra cứu bảo hành vào website

Tồn kho

  • Lấy dữ liệu phiếu xuất nhập kho

Lấy dữ liệu phiếu xuất nhập kho

Hệ thống

  • API tải file backup dữ liệu

API tải file backup dữ liệu

Automation

  • Gửi tin zalo ZNS

Gửi tin zalo ZNS

Thuộc tính Chi tiết
Tên API Gửi tin zalo ZNS
Version v1
Endpoint URL

https://api.qbis.vn/api/zalo/zns?STORE_KEY=&API_KEY=&TRACKING_ID=&PHONE_NUMBER=&APP_CONNECT_ID=

STORE_KEY: lấy từ cấu hình tích hợp API

API_KEY: lấy từ cấu hình tích hợp API

TRACKING_ID: dữ liệu số

APP_CONNECT_ID: id app zalo ZNS trên QBIS

PHONE_NUMBER: số điện thoại của khách hàng
Phương thức (Method) POST
Định dạng dữ liệu body JSON
Xác thực Qua tham số request STORE_KEY và API_KEY
Request Body (mỗi tin nhắn có mẫu json riêng - liên hệ người tạo mẫu để lấy chi tiết json)

{

"phone": "",

"template_id": "", 

"template_data":

{

"name": "",

 ....

}

, "tracking_id":""

}
Response Body {"success":true,"message":""}

Logo

🎉 Cảm ơn bạn đã sử dụng phần mềm!

Chúng tôi hy vọng tài liệu này sẽ giúp bạn làm chủ hệ thống quản lý và tối ưu hiệu suất doanh nghiệp.

Nếu bạn cần hỗ trợ thêm, vui lòng liên hệ bộ phận CSKH:

  • Email: support@qbis.vn
  • Hotline: 024 7306 8956
  • Zalo: 0904 60 10 40

Chúc bạn thành công và phát triển bền vững!

📚 Mục lục tài liệu