Skip to content

SMSBAT ChatHub API

ChatHub REST API gestionează conversațiile de afaceri Viber, conversațiile cu clienții și fluxurile de lucru de automatizare a asistenței pentru clienți.

URL de bază

https://chatapi.smsbat.com

Documentația Swagger

Documentația interactivă API este disponibilă la:

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

Autentificare

ChatHub folosește un sistem de autentificare bazat pe jetoane Bearer cu jetoane JWT. Jetoanele pot fi transmise în două moduri:

Metoda 1: Antet de autorizare

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

Metoda 2: Antet X-Authorization-Key

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

Flux de autentificare

ChatHub folosește un sistem de simboluri pe două niveluri:

  1. Company Token - Token de acces la nivel de organizație
  2. Token operator - Jeton de acces operator individual

Flux de lucru

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

Puncte finale principale

Metoda Punct final Descriere
POST /api/company/get-token Obțineți un simbol de autorizare a companiei
GET /api/company/organization Preluați lista organizației
GET /api/operator Listați operatorii după organizație
POST /api/operator/synchronize Adăugați noi operatori
POST /api/operator/status Modificați starea operatorului
POST /api/operator/get-token Generați jetoane de operator (expirare maxim 24 de ore)
POST /api/operator/validate-token Verificați validitatea simbolului

Caracteristici cheie

Managementul jetoanelor companiei

Obțineți și gestionați jetoane la nivel de organizație pentru accesul la API.

Managementul organizației

  • Listați toate organizațiile
  • Preluați detaliile organizației
  • Gestionați setările organizației

Managementul operatorului

  • Listați operatorii după organizație
  • Adăugați noi operatori
  • Modificați starea operatorului (Activ/Inactiv/Șters)
  • Generați jetoane specifice operatorului (maxim 24 de ore)
  • Validați jetoanele de operator

Integrare widget

Integrați widgetul ChatHub în aplicațiile web pentru asistență clienților în timp real.

Pornire rapidă

  1. Autentificare - Obțineți jetoane pentru companie și operator
  2. Organizații - Gestionați organizațiile
  3. Operatori - Adăugați și gestionați operatori
  4. Integrare widget - Integrați widgetul de chat

Format de solicitare

Toate cererile folosesc formatul JSON:

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

Format de răspuns

Răspunsurile de succes revin:

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

Gestionarea erorilor

Codurile de stare HTTP:

  • 200 OK - Solicitare reușită
  • 400 Solicitare greșită - Format de solicitare nevalid
  • 401 Neautorizat - Autentificarea eșuată
  • 403 Interzis - Permisiuni insuficiente
  • 404 Not Found - Resursa nu a fost găsită
  • 500 Internal Server Error - Eroare de server

Expirarea simbolului

Jetoanele au un timp de expirare. Când un token expiră:

  1. API-ul va returna 401 Unauthorized
  2. Solicitați un nou token utilizând punctul final de autentificare
  3. Actualizați-vă aplicația cu noul token

Următorii pași