Przejdź do treści

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

KOD_BLOKU_0

Dokumentacja Swaggera

Dokumentacja interaktywnego API jest dostępna pod adresem:

KOD_BLOKU_1

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

KOD_BLOKU_2

Metoda 2: Nagłówek klucza autoryzacji X

KOD_BLOKU_3

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

KOD_BLOKU_4

Główne punkty końcowe

Metoda Punkt końcowy Opis
POST /api/company/get-token Uzyskaj token autoryzacyjny firmy
OTRZYMAJ /api/firma/organizacja Pobierz listę organizacji
OTRZYMAJ /api/operator Lista operatorów według organizacji
POST /api/operator/synchronizacja Dodaj nowe operatory
POST /api/operator/status Zmień status operatora
POST /api/operator/get-token Generuj tokeny operatora (maks. ważność 24h)
POST /api/operator/validate-token Sprawdź 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:

KOD_BLOKU_5

Format odpowiedzi

Pomyślne odpowiedzi zwracają:

KOD_BLOKU_6

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