Skoči na vsebino

SMSBAT ChatHub API

ChatHub REST API upravlja poslovne klepete Viber, pogovore s strankami in poteke dela za avtomatizacijo podpore strankam.

Osnovni URL

https://chatapi.smsbat.com

Swaggerjeva dokumentacija

Interaktivna dokumentacija API je na voljo na:

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

Preverjanje pristnosti

ChatHub uporablja sistem za preverjanje pristnosti, ki temelji na nosilnem žetonu, z žetoni JWT. Žetone je mogoče posredovati na dva načina:

1. način: avtorizacijska glava

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

2. način: glava X-Authorization-Key

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

Potek preverjanja pristnosti

ChatHub uporablja dvonivojski sistem žetonov:

  1. Žeton podjetja - Žeton za dostop na ravni organizacije
  2. Operator Token - Žeton za dostop posameznega operaterja

Potek dela

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

Glavne končne točke

Metoda Končna točka Opis
OBJAVI /api/company/get-token Pridobite avtorizacijski žeton podjetja
PRIDOBITE /api/podjetje/organizacija Pridobi seznam organizacij
PRIDOBITE /api/operator Seznam operaterjev po organizaciji
OBJAVI /api/operator/synchronize Dodaj nove operaterje
OBJAVI /api/operator/status Spremeni status operaterja
OBJAVI /api/operator/get-token Ustvari žetone operaterja (največ 24 ur)
OBJAVI /api/operator/validate-token Preverite veljavnost žetona

Ključne lastnosti

Upravljanje žetonov podjetja

Pridobite in upravljajte žetone na ravni organizacije za dostop API.

Upravljanje organizacije

  • Navedite vse organizacije
  • Pridobite podrobnosti organizacije
  • Upravljajte nastavitve organizacije

Upravljanje operaterja

  • Seznam operaterjev po organizaciji
  • Dodajte nove operaterje
  • Spremenite status operaterja (aktiven/neaktiven/izbrisan)
  • Ustvari žetone, specifične za operaterja (največ 24 ur)
  • Preverjanje operaterskih žetonov

Integracija pripomočkov

Integrirajte gradnik ChatHub v spletne aplikacije za podporo strankam v realnem času.

Hitri začetek

  1. Avtentikacija - Pridobite žetone svojega podjetja in operaterja
  2. Organizacije - Upravljanje organizacij
  3. Operatorji - Dodajanje in upravljanje operaterjev
  4. Integracija gradnika - Integrirajte gradnik za klepet

Oblika zahteve

Vse zahteve uporabljajo format JSON:

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

Oblika odgovora

Uspešni odgovori vrnejo:

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

Obravnava napak

Statusne kode HTTP:

  • 200 OK - Zahteva uspešna
  • 400 Bad Request - Neveljavna oblika zahteve
  • 401 Nepooblaščeno - Preverjanje pristnosti ni uspelo
  • 403 Prepovedano - Nezadostna dovoljenja
  • 404 Not Found - vira ni bilo mogoče najti
  • 500 Internal Server Error - Napaka strežnika

Potek žetona

Žetoni imajo čas poteka. Ko žeton poteče:

  1. API bo vrnil 401 nepooblaščeno
  2. Zahtevajte nov žeton z uporabo končne točke preverjanja pristnosti
  3. Posodobite svojo aplikacijo z novim žetonom

Naslednji koraki

– Preverjanje pristnosti – Naučite se preverjati pristnost - Organizacije - Upravljanje organizacij - Operatorji - Sodelujte z operaterji – Integracija gradnika – Integrirajte gradnik za klepet