Přeskočit obsah

SMSBAT ChatHub API

ChatHub REST API spravuje obchodní chaty Viber, konverzace s klienty a pracovní postupy automatizace zákaznické podpory.

Základní URL

https://chatapi.smsbat.com

Swagger Documentation

Interaktivní dokumentace API je k dispozici na:

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

Autentizace

ChatHub používá ověřovací systém založený na tokenech Bearer s tokeny JWT. Tokeny lze předávat dvěma způsoby:

Metoda 1: Autorizační záhlaví

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

Metoda 2: X-Authorization-Key Header

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

Průběh autentizace

ChatHub používá dvouúrovňový systém tokenů:

  1. Token společnosti – přístupový token na úrovni organizace
  2. Token operátora – individuální pří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

Metoda Koncový bod Popis
PŘÍSPĚVEK /api/company/get-token Získejte autorizační token společnosti
ZÍSKEJTE /api/společnost/organizace Načíst seznam organizací
ZÍSKEJTE /api/operator Seznam operátorů podle organizace
PŘÍSPĚVEK /api/operator/synchronize Přidat nové operátory
PŘÍSPĚVEK /api/operator/status Změnit status operátora
PŘÍSPĚVEK /api/operator/get-token Generovat tokeny operátora (vypršení max. 24 hodin)
PŘÍSPĚVEK /api/operator/validate-token Ověřte platnost tokenu

Klíčové vlastnosti

Správa firemních tokenů

Získejte a spravujte tokeny na úrovni organizace pro přístup k rozhraní API.

Řízení organizace

  • Seznam všech organizací
  • Získejte podrobnosti o organizaci
  • Správa nastavení organizace

Správa operátora

  • Seznam operátorů podle organizace
  • Přidejte nové operátory
  • Změnit stav operátora (aktivní/neaktivní/smazaný)
  • Generování tokenů specifických pro operátora (max 24 hodin)
  • Ověřte tokeny operátora

Integrace widgetů

Integrujte widget ChatHub do webových aplikací pro podporu zákazníků v reálném čase.

Rychlý start

  1. Authentication – Získejte tokeny vaší společnosti a operátora
  2. Organizace – Správa organizací
  3. Operátoři – Přidejte a spravujte operátory
  4. Integrace widgetu – Integrujte widget chatu

Formát požadavku

Všechny požadavky používají formát JSON:

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

Formát odpovědi

Úspěšné odpovědi se vrátí:

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

Zpracování chyb

Stavové kódy HTTP:

  • 200 OK - Žádost byla úspěšná
  • 400 Bad Request - Neplatný formát požadavku
  • 401 Unauthorized - Autentizace se nezdařila
  • 403 Zakázáno - Nedostatečná oprávnění
  • 404 Nenalezeno - Zdroj nenalezen
  • 500 Internal Server Error - Chyba serveru

Vypršení platnosti tokenu

Tokeny mají dobu platnosti. Když token vyprší:

  1. Rozhraní API vrátí 401 Unauthorized
  2. Požádejte o nový token pomocí koncového bodu ověřování
  3. Aktualizujte svou aplikaci novým tokenem

Další kroky

– Authentication – Přečtěte si, jak provést ověření – Organizace – Správa organizací - Operátoři - Práce s operátory – Integrace widgetu – Integrujte widget chatu