Keri sisuni

SMSBAT ChatHubi API

ChatHub REST API haldab Viberi ärivestlusi, kliendivestlusi ja klienditoe automatiseerimise töövooge.

Baas-URL

https://chatapi.smsbat.com

Swaggeri dokumentatsioon

Interaktiivne API dokumentatsioon on saadaval aadressil:

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

Autentimine

ChatHub kasutab JWT žetoonidega kandemärgipõhist autentimissüsteemi. Märke saab edastada kahel viisil:

1. meetod: autoriseerimispäis

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

2. meetod: X-Authorization-Key päis

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

Autentimisvoog

ChatHub kasutab kahetasemelist märgisüsteemi:

  1. Ettevõtte tunnus – organisatsiooni tasemel juurdepääsuluba
  2. Operator Token – individuaalse operaatori juurdepääsuluba

Töövoog

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

Peamised lõpp-punktid

Meetod Lõpp-punkt Kirjeldus
POSTITUS "/api/ettevõte/get-token" Hankige ettevõtte autoriseerimismärk
SAADA "/api/ettevõte/organisatsioon" Organisatsioonide loendi toomine
SAADA "/api/operaator" Loetlege operaatorid organisatsioonide kaupa
POSTITUS `/api/operaator/sünkroonimine' Lisa uusi operaatoreid
POSTITUS "/api/operaator/staatus" Muuda operaatori staatust
POSTITUS "/api/operator/get-token" Loo operaatorimärgid (maksimaalselt 24h aegumine)
POSTITUS "/api/operator/validate-token" Kontrollige märgi kehtivust

Põhifunktsioonid

Ettevõtte märgihaldus

Hankige ja hallake API juurdepääsuks organisatsiooni tasemel žetoone.

Organisatsiooni juhtimine

  • Loetlege kõik organisatsioonid
  • Hankige organisatsiooni üksikasjad
  • Hallake organisatsiooni seadeid

Operaatorhaldus

  • Nimetage operaatorid organisatsioonide kaupa
  • Lisage uusi operaatoreid
  • Muutke operaatori olekut (aktiivne/mitteaktiivne/kustutatud)
  • Looge operaatoripõhiseid märke (maksimaalselt 24 tundi)
  • Kinnitage operaatori märgid

Vidinate integreerimine

Integreerige ChatHubi vidin veebirakendustesse reaalajas klienditoe jaoks.

Kiire algus

  1. Autentimine – hankige oma ettevõtte ja operaatori märgid
  2. Organisatsioonid – organisatsioonide haldamine
  3. Operaatorid – operaatorite lisamine ja haldamine
  4. Vidinate integreerimine – integreerige vestlusvidin

Taotle vormingut

Kõik taotlused kasutavad JSON-vormingut:

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

Vastusevorming

Edukad vastused tagastatakse:

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

Vigade käsitlemine

HTTP olekukoodid:

  • "200 OK" - taotlus õnnestus – „400 vigane taotlus” – taotluse vorming on kehtetu
  • "401 Volitamata" - Autentimine ebaõnnestus
  • "403 Keelatud" - Ebapiisavad õigused
  • "404 ei leitud" - ressurssi ei leitud
  • "500 sisemine serveri viga" - serveri viga

Tokeni aegumine

Tokenidel on aegumisaeg. Kui luba aegub:

  1. API tagastab "401 Volitamata".
  2. Taotlege autentimise lõpp-punkti abil uut luba
  3. Värskendage oma rakendust uue märgiga

Järgmised sammud