Preskočiť na obsah

SMSBAT ChatHub API

Rozhranie ChatHub REST API spravuje obchodné rozhovory Viber, konverzácie s klientmi a pracovné postupy automatizácie zákazníckej podpory.

Základná adresa URL

https://chatapi.smsbat.com

Swagger Documentation

Interaktívna dokumentácia API je dostupná na:

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

Autentifikácia

ChatHub používa autentifikačný systém založený na tokenoch Bearer s tokenmi JWT. Tokeny je možné odovzdať dvoma spôsobmi:

Metóda 1: Hlavička autorizácie

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

Metóda 2: Hlavička X-Authorization-Key

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

Tok overenia

ChatHub používa dvojúrovňový systém tokenov:

  1. Token spoločnosti – prístupový token na úrovni organizácie
  2. Token operátora – individuálny prístupový token operátora

Pracovný postup

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

Hlavné koncové body

Metóda Koncový bod Popis
Zverejniť /api/company/get-token Získať autorizačný token spoločnosti
ZÍSKAJTE "/api/spoločnosť/organizácia" Získať zoznam organizácií
ZÍSKAJTE /api/operator Zoznam prevádzkovateľov podľa organizácie
Zverejniť /api/operator/synchronize Pridať nových operátorov
Zverejniť /api/operator/status Zmeniť status operátora
Zverejniť /api/operator/get-token Generovať tokeny operátora (max. 24 hodín expirácie)
Zverejniť /api/operator/validate-token Overenie platnosti tokenu

Kľúčové vlastnosti

Správa tokenov spoločnosti

Získajte a spravujte tokeny na úrovni organizácie pre prístup k API.

Riadenie organizácie

  • Uveďte zoznam všetkých organizácií
  • Získajte podrobnosti o organizácii
  • Spravujte nastavenia organizácie

Správa operátora

  • Zoznam operátorov podľa organizácie
  • Pridajte nových operátorov
  • Zmeniť stav operátora (aktívny/neaktívny/odstránený)
  • Generovať tokeny špecifické pre operátora (max 24 hodín)
  • Overte tokeny operátora

Integrácia miniaplikácií

Integrujte widget ChatHub do webových aplikácií pre podporu zákazníkov v reálnom čase.

Rýchly štart

  1. Authentication – Získajte tokeny svojej spoločnosti a operátora
  2. Organizácie – Správa organizácií
  3. Operátori – Pridajte a spravujte operátorov
  4. Integrácia miniaplikácie – Integrácia miniaplikácie četu

Formát žiadosti

Všetky požiadavky používajú formát JSON:

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

Formát odpovede

Úspešné odpovede sa vrátia:

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

Spracovanie chýb

Stavové kódy HTTP:

  • 200 OK - Žiadosť bola úspešná
  • 400 Bad Request - Neplatný formát požiadavky
  • 401 Unauthorized - Autentifikácia zlyhala
  • 403 Zakázané - Nedostatočné povolenia
  • 404 Not Found - Zdroj sa nenašiel
  • 500 Interná chyba servera - Chyba servera

Vypršanie platnosti tokenu

Tokeny majú čas vypršania platnosti. Keď platnosť tokenu vyprší:

  1. API vráti 401 Unauthorized
  2. Požiadajte o nový token pomocou koncového bodu autentifikácie
  3. Aktualizujte svoju aplikáciu novým tokenom

Ďalšie kroky

– Autentifikácia – Zistite, ako overiť - Organizácie - Správa organizácií - Operátori - Pracujte s operátormi - Integrácia miniaplikácie - Integrácia miniaplikácie četu