Kalo te përmbajtja

SMSBAT ChatHub API

ChatHub REST API menaxhon bisedat e biznesit Viber, bisedat me klientët dhe flukset e punës të automatizimit të mbështetjes së klientit.

URL bazë

https://chatapi.smsbat.com

Dokumentacioni Swagger

Dokumentacioni interaktiv i API është i disponueshëm në:

KODI_BLOCK_1

Autentifikimi

ChatHub përdor një sistem vërtetimi të bazuar në token Bearer me argumentet JWT. Shenjat mund të kalohen në dy mënyra:

Metoda 1: Kreu i autorizimit

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

Metoda 2: X-Autorization-Key Header

KODI_BLOCK_3

Rrjedha e vërtetimit

ChatHub përdor një sistem token me dy nivele:

  1. Company Token - Token aksesi në nivel organizate
  2. **Token Operatori ** - Shenja e aksesit individual të operatorit

Rrjedha e punës

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

Pikat kryesore përfundimtare

Metoda Pika fundore Përshkrimi
POST /api/company/get-token Merrni shenjën e autorizimit të kompanisë
MERRNI /api/kompani/organizatë Merr listën e organizatave
MERRNI /api/operator Listoni operatorët sipas organizatës
POST /api/operator/sinkronizo Shto operatorë të rinj
POST /api/operator/status Ndrysho statusin e operatorit
POST /api/operator/get-token Gjeneroni shenja të operatorit (skadimi maksimal 24 orë)
POST /api/operator/validate-token Verifiko vlefshmërinë e shenjës

Karakteristikat kryesore

Menaxhimi i Tokenit të Kompanisë

Merrni dhe menaxhoni argumentet e nivelit të organizatës për qasje në API.

Menaxhimi i Organizatës

  • Listoni të gjitha organizatat
  • Merrni detajet e organizatës
  • Menaxho cilësimet e organizatës

Menaxhimi i Operatorit

  • Listoni operatorët sipas organizatës
  • Shtoni operatorë të rinj
  • Ndrysho statusin e operatorit (Aktiv/Joaktiv/I fshirë)
  • Gjeneroni argumente specifike për operatorin (maksimumi 24 orë)
  • Verifikoni shenjat e operatorit

Integrimi i widget-it

Integroni miniaplikacionin ChatHub në aplikacionet në ueb për mbështetjen e klientit në kohë reale.

Fillimi i shpejtë

  1. Vërtetimi - Merrni shenjat e kompanisë dhe operatorit tuaj
  2. Organizatat - Menaxho organizata
  3. Operatorët - Shtoni dhe menaxhoni operatorët
  4. Integrimi i Widget-it - Integroni miniaplikacionin e bisedës

Formati i kërkesës

Të gjitha kërkesat përdorin formatin JSON:

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

Formati i përgjigjes

Përgjigjet e suksesshme kthehen:

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

Trajtimi i gabimeve

Kodet e statusit HTTP:

  • 200 OK - Kërkesa me sukses
  • 400 Kërkesë e keqe - Format i pavlefshëm i kërkesës
  • 401 i paautorizuar - Autentifikimi dështoi
  • 403 Ndaluar - Leje të pamjaftueshme
  • 404 Nuk u gjet - Burimi nuk u gjet
  • 500 Gabim i brendshëm i serverit - Gabim serveri

Skadimi i Tokenit

Shenjat kanë një kohë skadimi. Kur skadon një shenjë:

  1. API do të kthejë "401 të paautorizuar".
  2. Kërkoni një shenjë të re duke përdorur pikën përfundimtare të vërtetimit
  3. Përditësoni aplikacionin tuaj me tokenin e ri

Hapat e ardhshëm