SMSBAT ChatHub-API

Die ChatHub-REST-API verwaltet Viber-Geschäftschats, Kundengespräche und Automatisierungsworkflows für den Kundensupport.

Basis-URL

https://chatapi.smsbat.com

Swagger-Dokumentation

Die interaktive API-Dokumentation ist verfügbar unter:

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

Authentifizierung

ChatHub verwendet ein Bearer-Token-basiertes Authentifizierungssystem mit JWT-Tokens. Token können auf zwei Arten weitergegeben werden:

Methode 1: Autorisierungsheader

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"

Authentifizierungsablauf

ChatHub verwendet ein zweistufiges Token-System:

1. Unternehmenstoken – Zugriffstoken auf Organisationsebene
2. Operator-Token – Individuelles Operator-Zugriffstoken

Arbeitsablauf

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

Hauptendpunkte

Methode	Endpunkt	Beschreibung
POST	/api/company/get-token	Erhalten Sie das Autorisierungstoken des Unternehmens
GET	/api/company/organization	Organisationsliste abrufen
GET	/api/operator	Operatoren nach Organisation auflisten
POST	/api/operator/synchronize	Neue Operatoren hinzufügen
POST	/api/operator/status	Betreiberstatus ändern
POST	/api/operator/get-token	Operator-Tokens generieren (maximal 24 Stunden Ablauf)
POST	/api/operator/validate-token	Gültigkeit des Tokens überprüfen

Hauptmerkmale

Unternehmens-Token-Management

Erhalten und verwalten Sie Token auf Organisationsebene für den API-Zugriff.

Organisationsmanagement

• Listen Sie alle Organisationen auf
• Organisationsdetails abrufen
• Organisationseinstellungen verwalten

Betreiberverwaltung

• Listen Sie die Betreiber nach Organisation auf
• Neue Operatoren hinzufügen
• Betreiberstatus ändern (Aktiv/Inaktiv/Gelöscht)
• Generieren Sie betreiberspezifische Token (maximal 24 Stunden)
• Validieren Sie Operator-Tokens

Widget-Integration

Integrieren Sie das ChatHub-Widget in Webanwendungen für Kundensupport in Echtzeit.

Schnellstart

1. Authentifizierung – Holen Sie sich Ihre Unternehmens- und Betreiber-Tokens
2. Organisationen – Organisationen verwalten
3. Operatoren – Operatoren hinzufügen und verwalten
4. Widget-Integration – Chat-Widget integrieren

Anforderungsformat

Alle Anfragen verwenden das JSON-Format:

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

Antwortformat

Erfolgreiche Antworten geben Folgendes zurück:

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

Fehlerbehandlung

HTTP-Statuscodes:

• „200 OK“ – Anfrage erfolgreich
• „400 Bad Request“ – Ungültiges Anforderungsformat
• „401 Unauthorized“ – Authentifizierung fehlgeschlagen
• „403 Forbidden“ – Unzureichende Berechtigungen
• „404 Not Found“ – Ressource nicht gefunden
• „500 Internal Server Error“ – Serverfehler

Token-Ablauf

Token haben eine Ablaufzeit. Wenn ein Token abläuft:

1. Die API gibt „401 Unauthorized“ zurück
2. Fordern Sie über den Authentifizierungsendpunkt ein neues Token an
3. Aktualisieren Sie Ihre Anwendung mit dem neuen Token

Nächste Schritte

– Authentifizierung – Erfahren Sie, wie Sie sich authentifizieren - Organisationen – Organisationen verwalten - Operatoren – Arbeiten Sie mit Operatoren - Widget-Integration – Integrieren Sie das Chat-Widget