Autoryzacja operatora i głębokie linki
W tym przewodniku wyjaśniono, jak uzyskać ważny token autoryzacyjny dla operatorów w systemie za pośrednictwem API oraz jak korzystać z precyzyjnych linków, aby przejść do panelu czatu.
Bazowy adres URL API: https://chatapi.smsbat.com/
Swagger: https://chatapi.smsbat.com/index.html
Uwaga: Możesz użyć nagłówka „X-Authorization-Key” ze swoim tokenem (dostępnym w Twoim profilu w panelu kontrolnym) zamiast autoryzacji „Bearer” w przypadku żądań na poziomie firmy.
1. Zdobądź token firmy
Aby otrzymać token firmy, wyślij żądanie HTTP POST do /api/company/get-token zawierające dane logowania firmy.
Prośba
- Metoda: POST
- URL: https://chatapi.smsbat.com/api/company/get-token
- Nagłówki: Typ zawartości: aplikacja/json
Ciało: KOD_BLOKU_0
Odpowiedź - Kod stanu: 200 (OK) - Treść: Token ciągu („twój_token_string”)
Uwaga: Zachowaj otrzymany token na potrzeby kolejnych żądań.
2. Pobierz listę organizacji
Wyślij żądanie GET do /api/company/organization, używając tokena firmy, aby wyświetlić listę swoich organizacji.
Prośba
- Metoda: GET
- URL: https://chatapi.smsbat.com/api/company/organization
- Nagłówki:
- Autoryzacja: okaziciel {token}
- Akceptuj: tekst/zwykły
Odpowiedź - Kod stanu: 200 (OK) - Ciało: KOD_BLOKU_1
3. Pobierz operatorów według organizacji
Wyślij żądanie GET do /api/operator przy użyciu parametru organizationId.
Prośba
- Metoda: GET
- URL: https://chatapi.smsbat.com/api/operator?organizationId={id}
- Nagłówki:
- Autoryzacja: okaziciel {token}
- Akceptuj: tekst/zwykły
Odpowiedź - Kod stanu: 200 (OK) - Ciało: KOD_BLOKU_2
4. Dodaj operatorów do systemu
Użyj tokena firmy, aby uzyskać dostęp do tego punktu końcowego i zsynchronizować operatorów z systemem.
Prośba
- Metoda: POST
- URL: https://chatapi.smsbat.com/api/operator/synchronize
- Nagłówki:
- Autoryzacja: okaziciel {token}
- Typ zawartości: aplikacja/json
Ciało: KOD_BLOKU_3
Odpowiedź - Kod stanu: 200 (OK) - Ciało: KOD_BLOKU_4
Możliwe statusy operatora:
- Aktywny: 0
- Nieaktywne: 1
- Usunięto: 2
5. Zdobądź token operatora
Autoryzuj tokenem firmowym, aby uzyskać token dla konkretnego operatora.
Prośba
- Metoda: POST
- URL: https://chatapi.smsbat.com/api/operator/get-token
- Nagłówki:
- Autoryzacja: okaziciel {token}
- Typ zawartości: aplikacja/json
Ciało:
KOD_BLOKU_5
expiresAt jest wymagany i określa czas trwania sesji operatora (maks. +24 godziny).
Odpowiedź - Kod stanu: 200 (OK) - Treść: Token ciągu
6. Zweryfikuj token operatora
Zweryfikuj ważność tokena operatora.
Prośba
- Metoda: POST
- URL: https://chatapi.smsbat.com/api/operator/validate-token
- Nagłówki:
- Autoryzacja: okaziciel {token}
- Typ zawartości: aplikacja/json
Treść: „operator_token_string”
Ważna odpowiedź (200 OK): KOD_BLOKU_6
7. Głębokie linkowanie do panelu czatu operatora
Systemy zewnętrzne (CRM, ERP, strony wewnętrzne) mogą bezpośrednio otwierać panel Czat, wykorzystując głębokie linki, przekazując jako parametr token Operatora JWT. Jeżeli token jest nieprawidłowy lub wygasł, użytkownik zostanie przekierowany do interfejsu logowania.
Format 1: Według identyfikatora czatu
KOD_BLOKU_7
Format 2: według numeru telefonu
KOD_BLOKU_8 Numer telefonu musi być w międzynarodowym formacie E.164.
Format 3: według nazwy alfa i telefonu
KOD_BLOKU_9
Format 4: Uzupełnij szczegóły celu
Określ dokładnie, z którego źródła chcesz przechwytywać wiadomości:
KOD_BLOKU_10
Źródła czatu:
- 0 - Vibera
- 1 - ViberBot
- 2 - TelegramBot
- 3 - Whatsapp
- 4 - Widżet
- 5 - Rozetka
- 6 - Facebook
- 7 - Instagram