Help Center SMSBAT API ChatHub

SMSBAT API ChatHub

ChatHub REST API zarządza czatami biznesowymi Viber, rozmowami z klientami i przepływami pracy automatyzacji obsługi klienta.

Podstawowy adres URL

https://chatapi.smsbat.com

Dokumentacja Swaggera

Dokumentacja interaktywnego API jest dostępna pod adresem:

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

Uwierzytelnianie

ChatHub korzysta z systemu uwierzytelniania opartego na tokenach Bearer z tokenami JWT. Tokeny można przekazywać na dwa sposoby:

Metoda 1: Nagłówek autoryzacji

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

Metoda 2: Nagłówek klucza autoryzacji X

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

Przepływ uwierzytelniania

ChatHub wykorzystuje dwupoziomowy system tokenów:

  1. Token firmowy – Token dostępu na poziomie organizacji
  2. Token Operatora - Indywidualny token dostępu operatora

Przepływ pracy

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

Główne punkty końcowe

MetodaPunkt końcowyOpis
POST/api/company/get-tokenUzyskaj token autoryzacyjny firmy
OTRZYMAJ/api/firma/organizacjaPobierz listę organizacji
OTRZYMAJ/api/operatorLista operatorów według organizacji
POST/api/operator/synchronizacjaDodaj nowe operatory
POST/api/operator/statusZmień status operatora
POST/api/operator/get-tokenGeneruj tokeny operatora (maks. ważność 24h)
POST/api/operator/validate-tokenSprawdź ważność tokena

Kluczowe funkcje

Zarządzanie tokenami firmy

Uzyskuj tokeny na poziomie organizacji umożliwiające dostęp do interfejsu API i zarządzaj nimi.

Zarządzanie organizacją

  • Wymień wszystkie organizacje
  • Pobierz szczegóły organizacji
  • Zarządzaj ustawieniami organizacji

Zarządzanie operatorami

  • Lista operatorów według organizacji
  • Dodaj nowych operatorów
  • Zmień status operatora (Aktywny/Nieaktywny/Usunięty)
  • Generuj tokeny specyficzne dla operatora (maks. 24 godziny)
  • Zweryfikuj tokeny operatora

Integracja widgetów

Zintegruj widżet ChatHub z aplikacjami internetowymi, aby uzyskać obsługę klienta w czasie rzeczywistym.

Szybki start

  1. Uwierzytelnianie - Zdobądź tokeny swojej firmy i operatora
  2. Organizacje – Zarządzaj organizacjami
  3. Operatorzy - Dodawaj operatorów i zarządzaj nimi
  4. Integracja widgetu - Zintegruj widget czatu

##Format żądania

Wszystkie żądania używają formatu JSON:

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

##Format odpowiedzi

Pomyślne odpowiedzi zwracają:

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

Obsługa błędów

Kody stanu HTTP:

  • 200 OK - Żądanie powiodło się
  • 400 Bad Request - Nieprawidłowy format żądania
  • 401 Nieautoryzowane - Uwierzytelnienie nie powiodło się
  • 403 Zabronione - Niewystarczające uprawnienia
  • 404 Not Found - Nie znaleziono zasobu
  • 500 Wewnętrzny błąd serwera - Błąd serwera

Wygaśnięcie tokena

Tokeny mają określony czas ważności. Kiedy token wygaśnie:

  1. API zwróci komunikat „401 Nieautoryzowany”.
  2. Poproś o nowy token, korzystając z punktu końcowego uwierzytelniania
  3. Zaktualizuj swoją aplikację o nowy token

Następne kroki