Pāriet uz saturu

SMSBAT ChatHub API

ChatHub REST API pārvalda Viber biznesa tērzēšanu, klientu sarunas un klientu atbalsta automatizācijas darbplūsmas.

Pamata URL

https://chatapi.smsbat.com

Swagger dokumentācija

Interaktīvā API dokumentācija ir pieejama:

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

Autentifikācija

ChatHub izmanto uz nesēju balstītu autentifikācijas sistēmu ar JWT marķieriem. Tokenus var nodot divos veidos:

1. metode: autorizācijas galvene

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

2. metode: X-Autorizācijas atslēgas galvene

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

Autentifikācijas plūsma

ChatHub izmanto divu līmeņu marķieru sistēmu:

1. Uzņēmuma pilnvara — organizācijas līmeņa piekļuves pilnvara 2. Operatora pilnvara — individuāla operatora piekļuves pilnvara

Darbplūsma

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

Galvenie galapunkti

Metode Galapunkts Apraksts
POST "/api/uzņēmums/get-token" Iegūt uzņēmuma pilnvaras marķieri
SAŅEMT "/api/uzņēmums/organizācija" Izgūt organizāciju sarakstu
SAŅEMT "/api/operators" Operatoru saraksts pēc organizācijas
POST `/api/operators/sinhronizēt' Pievienot jaunus operatorus
POST "/api/operators/statuss" Mainīt operatora statusu
POST "/api/operator/get-token" Ģenerēt operatora pilnvaras (ilgums 24 h)
POST "/api/operator/validate-token" Pārbaudiet marķiera derīgumu

Galvenās funkcijas

Uzņēmuma marķieru pārvaldība

Iegūstiet un pārvaldiet organizācijas līmeņa marķierus API piekļuvei.

Organizācijas vadība

  • Uzskaitiet visas organizācijas
  • Izgūt informāciju par organizāciju
  • Pārvaldīt organizācijas iestatījumus

Operatoru vadība

  • Saraksts operatoriem pēc organizācijas
  • Pievienojiet jaunus operatorus
  • Mainīt operatora statusu (aktīvs/neaktīvs/dzēsts)
  • Ģenerēt operatoram raksturīgus marķierus (maks. 24 stundas)
  • Validējiet operatora žetonus

Logrīku integrācija

Integrējiet ChatHub logrīku tīmekļa lietojumprogrammās, lai nodrošinātu klientu atbalstu reāllaikā.

Īsā sākšana

  1. Autentifikācija — iegūstiet sava uzņēmuma un operatora pilnvaras
  2. Organizācijas — pārvaldiet organizācijas
  3. Operatori — pievienojiet un pārvaldiet operatorus
  4. Logrīku integrācija — integrējiet tērzēšanas logrīku

Pieprasīt formātu

Visi pieprasījumi izmanto JSON formātu:

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

Atbildes formāts

Atgriežas veiksmīgās atbildes:

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

Kļūdu apstrāde

HTTP statusa kodi:

  • 200 OK - Pieprasījums ir veiksmīgs - 400 slikts pieprasījums — nederīgs pieprasījuma formāts
  • 401 Neautorizēts - Autentifikācija neizdevās
  • 403 Aizliegts - Nepietiekamas atļaujas
  • 404 nav atrasts - resurss nav atrasts
  • "500 Iekšējā servera kļūda" - servera kļūda

Žetona derīguma termiņš

Žetoniem ir derīguma termiņš. Kad marķiera derīguma termiņš beidzas:

1. API atgriezīs “401 Neautorizēts”. 2. Pieprasiet jaunu pilnvaru, izmantojot autentifikācijas galapunktu 3. Atjauniniet savu lietojumprogrammu ar jauno pilnvaru

Nākamie soļi