Help Center SMSBAT ChatHub-API

SMSBAT ChatHub-API

ChatHub REST API beheert Viber zakelijke chats, klantgesprekken en automatiseringsworkflows voor klantenondersteuning.

Basis-URL

https://chatapi.smsbat.com

Swagger-documentatie

Interactieve API-documentatie is beschikbaar op:

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

Authenticatie

ChatHub maakt gebruik van een op Bearer-tokens gebaseerd authenticatiesysteem met JWT-tokens. Tokens kunnen op twee manieren worden doorgegeven:

Methode 1: Autorisatiekop

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

Methode 2: X-Authorization-Key Header

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

Authenticatiestroom

ChatHub gebruikt een tokensysteem met twee niveaus:

  1. Bedrijfstoken - Toegangstoken op organisatieniveau
  2. Operatortoken - Individueel operatortoegangstoken

Werkstroom

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

Belangrijkste eindpunten

WerkwijzeEindpuntBeschrijving
POST/api/company/get-tokenBedrijfsautorisatietoken verkrijgen
KRIJG/api/bedrijf/organisatieOrganisatielijst ophalen
KRIJG/api/operatorOperators per organisatie weergeven
POST/api/operator/synchroniserenNieuwe operatoren toevoegen
POST/api/operator/statusOperatorstatus wijzigen
POST/api/operator/get-tokenOperatortokens genereren (vervaltijd maximaal 24 uur)
POST/api/operator/validate-tokenTokengeldigheid verifiëren

Belangrijkste kenmerken

Beheer van bedrijfstokens

Verkrijg en beheer tokens op organisatieniveau voor API-toegang.

Organisatiebeheer

  • Lijst van alle organisaties
  • Organisatiegegevens ophalen
  • Beheer organisatie-instellingen

Operatorbeheer

  • Lijst met operators per organisatie
  • Voeg nieuwe operators toe
  • Operatorstatus wijzigen (actief/inactief/verwijderd)
  • Genereer operatorspecifieke tokens (max. 24 uur)
  • Valideer operatortokens

Widget-integratie

Integreer de ChatHub-widget in webapplicaties voor realtime klantenondersteuning.

Snelle start

  1. Authenticatie - Ontvang uw bedrijfs- en operatortokens
  2. Organisaties - Beheer organisaties
  3. Operators - Operators toevoegen en beheren
  4. Widget-integratie - Chatwidget integreren

Verzoekformaat

Alle verzoeken gebruiken het JSON-formaat:

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

Antwoordformaat

Succesvolle reacties retourneren:

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

Foutafhandeling

HTTP-statuscodes:

  • 200 OK - Verzoek succesvol
  • 400 Bad Request - Ongeldig verzoekformaat
  • 401 Niet geautoriseerd - Authenticatie mislukt
  • 403 Verboden - Onvoldoende rechten
  • 404 Not Found - Bron niet gevonden
  • 500 Interne serverfout - Serverfout

Tokenvervaldatum

Tokens hebben een vervaltijd. Wanneer een token verloopt:

  1. De API retourneert ‘401 Unauthorized’
  2. Vraag een nieuw token aan via het authenticatie-eindpunt
  3. Update uw applicatie met het nieuwe token

Volgende stappen