Gå till innehållet

SMSBAT ChatHub API

ChatHub REST API hanterar Viber affärschattar, klientkonversationer och automatiseringsarbetsflöden för kundsupport.

Bas-URL

https://chatapi.smsbat.com

Swagger dokumentation

Interaktiv API-dokumentation finns tillgänglig på:

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

Autentisering

ChatHub använder ett Bearer-tokenbaserat autentiseringssystem med JWT-tokens. Tokens kan skickas på två sätt:

Metod 1: Auktoriseringshuvud

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

Metod 2: X-Authorization-Key Header

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

Autentiseringsflöde

ChatHub använder ett tokensystem på två nivåer:

  1. Company Token - Åtkomsttoken på organisationsnivå
  2. Operator Token - Individuell operatörsåtkomsttoken

Arbetsflöde

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

Huvudslutpunkter

Metod Slutpunkt Beskrivning
POST /api/företag/get-token Skaffa företagets auktoriseringstoken
FÅ /api/företag/organisation Hämta organisationslista
FÅ /api/operator Lista operatörer efter organisation
POST /api/operator/synchronize Lägg till nya operatörer
POST /api/operatör/status Ändra operatörsstatus
POST /api/operatör/get-token Generera operatörstokens (max 24 timmars utgång)
POST /api/operator/validate-token Verifiera tokens giltighet

Nyckelfunktioner

Company Token Management

Skaffa och hantera tokens på organisationsnivå för API-åtkomst.

Organisationsledning

  • Lista alla organisationer
  • Hämta organisationsinformation
  • Hantera organisationsinställningar

Operatörshantering

  • Lista operatörer efter organisation
  • Lägg till nya operatörer
  • Ändra operatörsstatus (aktiv/inaktiv/raderad)
  • Generera operatörsspecifika tokens (max 24 timmar)
  • Validera operatörstokens

Widget-integration

Integrera ChatHub-widgeten i webbapplikationer för kundsupport i realtid.

Snabbstart

  1. Autentisering - Skaffa ditt företags- och operatörstoken
  2. Organisationer - Hantera organisationer
  3. Operatorer - Lägg till och hantera operatörer
  4. Widget-integration - Integrera chattwidget

Begärformat

Alla förfrågningar använder JSON-format:

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

Svarsformat

Lyckade svar returnerar:

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

Felhantering

HTTP-statuskoder:

  • 200 OK - Begäran lyckades
  • 400 Bad Request - Ogiltigt format för begäran
  • 401 obehörig - Autentisering misslyckades
  • 403 Förbjudet - Otillräckliga behörigheter
  • 404 Not Found - Resurs hittades inte
  • 500 Internt serverfel - Serverfel

Tokens utgång

Tokens har en utgångstid. När en token löper ut:

  1. API:et returnerar "401 obehörig".
  2. Begär en ny token med autentiseringens slutpunkt
  3. Uppdatera din applikation med den nya token

Nästa steg