Pereiti prie turinio

SMSBAT ChatHub API

ChatHub REST API valdo Viber verslo pokalbius, klientų pokalbius ir klientų aptarnavimo automatizavimo darbo eigas.

Bazinis URL

https://chatapi.smsbat.com

Swagger dokumentacija

Interaktyviąją API dokumentaciją galite rasti adresu:

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

Autentifikavimas

„ChatHub“ naudoja „Bearer“ prieigos rakto autentifikavimo sistemą su JWT prieigos raktais. Žetonus galima perduoti dviem būdais:

1 būdas: autorizacijos antraštė

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

2 būdas: X autorizavimo rakto antraštė

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

Autentifikavimo srautas

„ChatHub“ naudoja dviejų lygių prieigos raktų sistemą:

  1. Įmonės prieigos raktas – organizacijos lygio prieigos raktas
  2. Operatoriaus prieigos raktas – individualus operatoriaus prieigos raktas

Darbo eiga

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

Pagrindiniai galutiniai taškai

Metodas Galutinis taškas Aprašymas
POST „/api/company/get-token“ Gaukite įmonės leidimo žetoną
GAUTI "/api/įmonė/organizacija" Nuskaityti organizacijų sąrašą
GAUTI "/api/operatorius" Operatorių sąrašas pagal organizacijas
POST „/api/operator/sinchronizuoti“ Pridėti naujų operatorių
POST "/api/operatorius/statusas" Keisti operatoriaus būseną
POST „/api/operator/get-token“ Generuoti operatoriaus žetonus (galiojimo laikas iki 24 val.)
POST „/api/operator/validate-token“ Patikrinkite prieigos rakto galiojimą

Pagrindinės savybės

Įmonės žetonų valdymas

Gaukite ir tvarkykite organizacijos lygio prieigos raktus API.

Organizacijos valdymas

  • Išvardykite visas organizacijas
  • Gaukite organizacijos informaciją
  • Tvarkyti organizacijos nustatymus

Operatoriaus valdymas

  • Išvardykite operatorius pagal organizacijas
  • Pridėkite naujų operatorių
  • Keisti operatoriaus būseną (aktyvus / neaktyvus / ištrintas)
  • Generuokite konkretaus operatoriaus prieigos raktus (maks. 24 val.)
  • Patvirtinkite operatoriaus žetonus

Valdiklių integravimas

Integruokite ChatHub valdiklį į žiniatinklio programas, kad galėtumėte palaikyti klientus realiuoju laiku.

Greita pradžia

  1. Autentifikavimas – Gaukite įmonės ir operatoriaus prieigos raktus
  2. Organizacijos – tvarkykite organizacijas
  3. Operatoriai – pridėkite ir tvarkykite operatorius
  4. Valdiklio integravimas – Integruokite pokalbių valdiklį

Užklausos formatas

Visos užklausos naudoja JSON formatą:

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

Atsakymo formatas

Sėkmingi atsakymai grąžinami:

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

Klaidų tvarkymas

HTTP būsenos kodai:

– „200 gerai“ – užklausa įvykdyta – „400 netinkama užklausa“ – netinkamas užklausos formatas – „401 Neteisėtas“ – Autentifikavimas nepavyko - "403 Draudžiama" - Nepakankami leidimai - „404 nerastas“ – išteklius nerastas - „500 vidinė serverio klaida“ – serverio klaida

Žetono galiojimo laikas

Žetonai turi galiojimo laiką. Kai baigiasi prieigos rakto galiojimo laikas:

  1. API pateiks „401 Unauthorized“.
  2. Pateikite naujo prieigos rakto užklausą naudodami autentifikavimo galutinį tašką
  3. Atnaujinkite programą naudodami naują prieigos raktą

Kiti žingsniai

– Autentifikavimas – Sužinokite, kaip autentifikuoti – Organizacijos – Tvarkyti organizacijas – Operatoriai – Darbas su operatoriais – Valdiklio integravimas – Integruokite pokalbių valdiklį