Bỏ qua

API SMSBAT ChatHub

API ChatHub REST quản lý các cuộc trò chuyện kinh doanh trên Viber, cuộc trò chuyện với khách hàng và quy trình tự động hóa hỗ trợ khách hàng.

URL cơ sở

https://chatapi.smsbat.com

Tài liệu vênh vang

Tài liệu API tương tác có sẵn tại:

https://chatapi.smsbat.com/index.html

Xác thực

ChatHub sử dụng hệ thống xác thực dựa trên mã thông báo Bearer với mã thông báo JWT. Token có thể được chuyển theo hai cách:

Cách 1: Tiêu đề ủy quyền

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "Authorization: Bearer your-jwt-token"

Cách 2: Tiêu đề X-Authorization-Key

curl -X GET https://chatapi.smsbat.com/api/company/organization \
  -H "X-Authorization-Key: your-jwt-token"

Luồng xác thực

ChatHub sử dụng hệ thống mã thông báo hai cấp:

  1. Mã thông báo công ty - Mã thông báo truy cập cấp tổ chức
  2. Mã thông báo của nhà điều hành - Mã thông báo truy cập của nhà điều hành cá nhân

Quy trình làm việc

graph LR
    A[Get Company Token] --> B[List Organizations]
    B --> C[List/Add Operators]
    C --> D[Get Operator Token]
    D --> E[Integrate Widget]

Điểm cuối chính

Phương pháp Điểm cuối Mô tả
ĐĂNG /api/công ty/get-token Nhận mã thông báo ủy quyền của công ty
NHẬN /api/công ty/tổ chức Truy xuất danh sách tổ chức
NHẬN /api/toán tử Liệt kê các nhà khai thác theo tổ chức
ĐĂNG /api/toán tử/đồng bộ hóa Thêm toán tử mới
ĐĂNG /api/toán tử/trạng thái Thay đổi trạng thái nhà điều hành
ĐĂNG /api/toán tử/get-token Tạo mã thông báo toán tử (hết hạn tối đa 24 giờ)
ĐĂNG /api/toán tử/xác thực-mã thông báo Xác minh tính hợp lệ của mã thông báo

Tính năng chính

Quản lý mã thông báo công ty

Nhận và quản lý mã thông báo cấp tổ chức để truy cập API.

Quản lý tổ chức

  • Liệt kê tất cả các tổ chức
  • Truy xuất thông tin chi tiết về tổ chức
  • Quản lý cài đặt tổ chức

Quản lý người vận hành

  • Danh sách các nhà khai thác theo tổ chức
  • Thêm toán tử mới
  • Thay đổi trạng thái nhà điều hành (Hoạt động/Không hoạt động/Đã xóa)
  • Tạo mã thông báo dành riêng cho nhà điều hành (tối đa 24 giờ)
  • Xác thực mã thông báo của nhà điều hành

Tích hợp tiện ích

Tích hợp tiện ích ChatHub vào ứng dụng web để hỗ trợ khách hàng theo thời gian thực.

Bắt đầu nhanh

  1. Xác thực - Nhận mã thông báo của công ty và nhà điều hành của bạn
  2. Tổ chức - Quản lý tổ chức
  3. Toán tử - Thêm và quản lý toán tử
  4. Tích hợp tiện ích - Tích hợp tiện ích trò chuyện

Định dạng yêu cầu

Tất cả các yêu cầu đều sử dụng định dạng JSON:

{
  "login": "your-login",
  "password": "your-password"
}

Định dạng phản hồi

Phản hồi thành công trả về:

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expiration": "2025-01-24T12:00:00Z"
}

Xử lý lỗi

Mã trạng thái HTTP:

  • 200 OK - Yêu cầu thành công
  • 400 Yêu cầu Không hợp lệ - Định dạng yêu cầu không hợp lệ
  • 401 Không được phép - Xác thực không thành công
  • 403 Bị cấm - Không đủ quyền
  • 404 Not Found - Không tìm thấy tài nguyên
  • 500 Lỗi Máy chủ Nội bộ - Lỗi máy chủ

Mã thông báo hết hạn

Token có thời gian hết hạn. Khi mã thông báo hết hạn:

  1. API sẽ trả về 401 trái phép
  2. Yêu cầu mã thông báo mới bằng điểm cuối xác thực
  3. Cập nhật ứng dụng của bạn bằng mã thông báo mới

Các bước tiếp theo