I-skip tungo sa nilalaman

SMSBAT ChatHub API

Ang ChatHub REST API ay namamahala sa mga pakikipag-chat sa negosyo ng Viber, mga pag-uusap ng kliyente, at mga daloy ng trabaho sa automation ng suporta sa customer.

Base URL

https://chatapi.smsbat.com

Swagger Documentation

Available ang interactive na dokumentasyon ng API sa:

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

Pagpapatotoo

Gumagamit ang ChatHub ng Bearer token-based authentication system na may mga JWT token. Ang mga token ay maaaring maipasa sa dalawang paraan:

Paraan 1: Authorization Header

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

Paraan 2: X-Authorization-Key Header

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

Daloy ng Pagpapatotoo

Gumagamit ang ChatHub ng two-level token system:

  1. Token ng Kumpanya - Token sa pag-access sa antas ng organisasyon
  2. Token ng Operator - Token ng pag-access ng indibidwal na operator

Daloy ng Trabaho

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

Pangunahing Mga Endpoint

Paraan Endpoint Paglalarawan
POST /api/company/get-token Kumuha ng token ng awtorisasyon ng kumpanya
KUMUHA /api/kumpanya/organisasyon Kunin ang listahan ng organisasyon
KUMUHA /api/operator Maglista ng mga operator ayon sa organisasyon
POST /api/operator/synchronize Magdagdag ng mga bagong operator
POST /api/operator/status Baguhin ang katayuan ng operator
POST /api/operator/get-token Bumuo ng mga token ng operator (max 24h expiration)
POST /api/operator/validate-token I-verify ang bisa ng token

Mga Pangunahing Tampok

Pamamahala ng Token ng Kumpanya

Kumuha at pamahalaan ang mga token sa antas ng organisasyon para sa pag-access sa API.

Pamamahala ng Organisasyon

  • Ilista ang lahat ng mga organisasyon
  • Kunin ang mga detalye ng organisasyon
  • Pamahalaan ang mga setting ng organisasyon

Pamamahala ng Operator

  • Listahan ng mga operator ayon sa organisasyon
  • Magdagdag ng mga bagong operator
  • Baguhin ang katayuan ng operator (Aktibo/Hindi Aktibo/Tinanggal)
  • Bumuo ng mga token na partikular sa operator (max 24 na oras)
  • I-validate ang mga token ng operator

Pagsasama ng Widget

Isama ang ChatHub widget sa mga web application para sa real-time na suporta sa customer.

Mabilis na Pagsisimula

  1. Authentication - Kunin ang mga token ng iyong kumpanya at operator
  2. Mga Organisasyon - Pamahalaan ang mga organisasyon
  3. Operator - Magdagdag at mamahala ng mga operator
  4. Widget Integration - Isama ang chat widget

Format ng Kahilingan

Gumagamit ang lahat ng kahilingan sa format na JSON:

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

Format ng Tugon

Nagbabalik ang mga matagumpay na tugon:

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

Error sa Paghawak

Mga code ng status ng HTTP:

  • 200 OK - Matagumpay ang kahilingan
  • 400 Bad Request - Di-wastong format ng kahilingan
  • 401 Hindi awtorisado - Nabigo ang pagpapatunay
  • 403 Ipinagbabawal - Hindi sapat na mga pahintulot
  • 404 Not Found - Resource not found
  • 500 Internal Server Error - Server error

Pag-expire ng Token

Ang mga token ay may oras ng pag-expire. Kapag nag-expire ang isang token:

  1. Ibabalik ng API ang 401 Unawtorised
  2. Humiling ng bagong token gamit ang authentication endpoint
  3. I-update ang iyong aplikasyon gamit ang bagong token

Mga Susunod na Hakbang