Preskoči na sadržaj

SMSBAT ChatHub API

ChatHub REST API upravlja Viber poslovnim razgovorima, razgovorima s klijentima i radnim procesima automatizacije korisničke podrške.

Osnovni URL

https://chatapi.smsbat.com

Swagger dokumentacija

Interaktivna API dokumentacija dostupna je na:

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

Autentifikacija

ChatHub koristi sustav provjere autentičnosti temeljen na nositelju tokena s JWT tokenima. Tokeni se mogu proslijediti na dva načina:

Metoda 1: Zaglavlje autorizacije

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

Metoda 2: Zaglavlje X-Authorization-Key

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

Tijek provjere autentičnosti

ChatHub koristi dvorazinski sustav tokena:

  1. Token tvrtke - Token za pristup na razini organizacije
  2. Operator Token - Individualni token za pristup operatera

Tijek rada

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

Glavne krajnje točke

Metoda Krajnja točka Opis
OBJAVI /api/company/get-token Nabavite autorizacijski token tvrtke
DOBITI /api/tvrtka/organizacija Dohvati popis organizacija
DOBITI /api/operator Popis operatera prema organizaciji
OBJAVI /api/operator/synchronize Dodaj nove operatore
OBJAVI /api/operator/status Promjena statusa operatera
OBJAVI /api/operator/get-token Generirajte operatorske tokene (maks. 24h isteka)
OBJAVI /api/operator/validate-token Provjerite valjanost tokena

Ključne značajke

Upravljanje tokenima tvrtke

Nabavite i upravljajte tokenima na razini organizacije za API pristup.

Upravljanje organizacijom

  • Navedite sve organizacije
  • Dohvaćanje pojedinosti o organizaciji
  • Upravljanje postavkama organizacije

Upravljanje operaterom

  • Popis operatera po organizaciji
  • Dodajte nove operatere
  • Promjena statusa operatera (Aktivan/Neaktivan/Izbrisan)
  • Generirajte tokene specifične za operatera (maksimalno 24 sata)
  • Provjera tokena operatora

Integracija widgeta

Integrirajte ChatHub widget u web aplikacije za korisničku podršku u stvarnom vremenu.

Brzi početak

  1. Autentifikacija - Nabavite tokene svoje tvrtke i operatera
  2. Organizacije - Upravljanje organizacijama
  3. Operatori - Dodajte operatore i upravljajte njima
  4. Integracija widgeta - Integrirajte widget za chat

Format zahtjeva

Svi zahtjevi koriste JSON format:

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

Format odgovora

Uspješni odgovori vraćaju se:

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

Rješavanje grešaka

HTTP statusni kodovi:

  • 200 OK - Zahtjev uspješan
  • 400 Bad Request - Nevažeći format zahtjeva
  • 401 Unauthorized - Autentifikacija nije uspjela
  • 403 Zabranjeno - Nedovoljne dozvole
  • 404 Not Found - Resurs nije pronađen
  • 500 Internal Server Error - Greška poslužitelja

Istek tokena

Tokeni imaju vrijeme isteka. Kada token istekne:

  1. API će vratiti 401 Unauthorized
  2. Zatražite novi token pomoću krajnje točke provjere autentičnosti
  3. Ažurirajte svoju aplikaciju novim tokenom

Sljedeći koraci