Thulium — konfiguracja, integracje

Thulium API to interfejs REST dostępny dla każdego systemu założonego na thulium.com.¹ Ten poradnik prowadzi od konfiguracji dostępu i pierwszego żądania po integrację ze sklepem lub CRM. Wyjaśnia też, jak odróżnić błąd żądania od awarii usługi.
Na oficjalnej stronie Thulium opisano pięć przykładowych zastosowań API.¹

Jak uzyskać dostęp do API Thulium i skonfigurować uwierzytelnianie?

Thulium wymaga przygotowania dostępu do API oraz przekazania danych uwierzytelniających zgodnie z opisem żądania. Zacznij od ustalenia metody uwierzytelniania. Potem skonfiguruj klienta HTTP, czyli program, który będzie wysyłał żądania.
Błędna nazwa użytkownika lub hasło powodują odpowiedź z kodem HTTP 401.²

• Metodę uwierzytelniania Thulium odczytaj z dokumentacji API, zanim przygotujesz połączenie.
• Uprawnienia dostępu dopasuj do operacji, które integracja będzie wykonywać na danych systemu.
• Dane uwierzytelniające przekaż w żądaniu tak, jak wymaga tego API Thulium.
• Sekret integracji trzymaj poza kodem aplikacji; nie zapisuj go w publicznym repozytorium ani w logach.

Po skonfigurowaniu uwierzytelniania możesz wysłać żądanie do API Thulium. Warto zacząć od operacji opisanej w dokumentacji i sprawdzić odpowiedź serwera.

Jak wysłać żądanie do API Thulium i odczytać odpowiedź?

Żądanie do API Thulium wyślij klientem HTTP. Podaj adres zasobu, metodę oraz dane uwierzytelniające wymagane dla wybranej operacji. Odczyt odpowiedzi zacznij od statusu HTTP: mówi on, jak serwer obsłużył żądanie.
Poprawne żądanie GET zwracające dane otrzymuje według dokumentacji kod HTTP 200.²

• Adres zasobu wybierz według operacji, którą ma wykonać integracja.
• Metodę HTTP ustaw zgodnie z opisem operacji dla tego zasobu.
• Nagłówki i treść żądania przygotuj w formacie wymaganym przez wybraną operację.
• Żądanie wyślij klientem HTTP wraz z danymi uwierzytelniającymi.
• Status i treść odpowiedzi sprawdź osobno. Status podaje wynik żądania, a treść zawiera dane albo opis błędu.

Wynik żądania do Thulium oceniaj po statusie HTTP i treści odpowiedzi. Samo wysłanie danych nie oznacza jeszcze sukcesu. Jeśli dane nie przejdą walidacji, API zwróci kod HTTP 400.²

Jak połączyć Thulium ze sklepem lub CRM przez API?

Integrację Thulium ze sklepem lub CRM oprzyj na danych wymienianych między systemami i zdarzeniach, które uruchamiają wymianę. API pozwala też połączyć Thulium z wewnętrznym CRM, ERP albo firmową bazą danych.³
Thulium podaje, że oferuje ponad 70 integracji z różnymi systemami, w tym platformami sklepowymi i CRM.⁴

Przepływ danych najlepiej rozpisać przed rozpoczęciem prac. Poniższa lista porządkuje decyzje dotyczące celu i sposobu wymiany.

• Cel integracji nazwij konkretnie, na przykład jako powiązanie zgłoszenia z zamówieniem klienta.
• Identyfikator rekordu dobierz tak, by oba systemy rozpoznawały tę samą osobę, zamówienie lub sprawę.
• Kierunek wymiany ustal dla każdego pola: wskaż źródło danych i system, który je otrzyma.
• Mapowanie pól oprzyj na nazwach i formatach danych używanych w obu systemach.
• Moment synchronizacji powiąż ze zdarzeniem, na przykład zapisem zamówienia albo zmianą danych klienta.

Integracja Thulium ma jasno określony zakres, gdy każdej wymienianej informacji przypiszesz źródło, identyfikator i moment synchronizacji. Tak przygotowany opis wskazuje, co oba systemy mają ze sobą wymieniać.

Do czego służy API Thulium i jakie dane udostępnia?

API Thulium pozwala pobierać dane operacyjne i uruchamiać wybrane działania związane z telefoniczną obsługą klienta. Oficjalny opis wymienia pięć zastosowań: kampanie wychodzące, kolejkę połączeń, przewidywany czas oczekiwania, inicjowanie rozmów oraz powiadomienia o zdarzeniach.¹ Każde z nich odpowiada na inną potrzebę integracji.

Jakie operacje dotyczące kampanii outbound udostępnia API Thulium?

Thulium pozwala przez API tworzyć i zasilać kampanie outbound, czyli kampanie połączeń wychodzących.¹ Firmowy system może przekazywać tą drogą dane kampanii. To jedno z pięciu zastosowań API opisanych przez Thulium.

Jak pobierać informacje o kolejce, IVR i czasie oczekiwania?

Thulium udostępnia przez API listę osób oczekujących w kolejce oraz na IVR, czyli w interaktywnym menu głosowym.¹ Osobno można pobrać przewidywany czas oczekiwania.¹ Lista pokazuje, kto czeka; prognoza mówi, jak długo.
W przykładowej odpowiedzi API czas ma format godzin:minut:sekund, np. „00:00:30”, a nie postać liczby sekund.⁵

Jak działa click to call przez API Thulium?

Thulium umożliwia zestawienie połączenia przez API za pomocą click to call. Rozmowa rozpoczyna się po wybraniu akcji w aplikacji.¹ Firmowy interfejs może udostępnić tę akcję pracownikowi przy danych klienta.

Jak otrzymywać powiadomienia o zdarzeniach z Thulium?

Thulium umożliwia otrzymywanie przez API notyfikacji, czyli powiadomień o zdarzeniach w systemie.¹ Integracja powinna przypisać otrzymanemu zdarzeniu konkretną czynność w procesie obsługi klienta. Dzięki temu powiadomienie ma określone zastosowanie.

Zakres integracji z Thulium zależy od operacji wykonywanej przez firmowy system.⁶ Pięć opisanych zastosowań można uporządkować według trzech rodzajów operacji:

Gdzie znaleźć dokumentację API Thulium i opisy zasobów?

Dokumentację API Thulium znajdziesz w indywidualnej dokumentacji systemu; zawiera ona przykłady.¹ Oficjalna strona przedstawia pięć zastosowań API. Zanim napiszesz kod integracji, odczytaj opis zasobu, metody, wymaganych danych i odpowiedzi.

Jak uzyskać właściwą dokumentację API Thulium?

Dokumentację API Thulium dobierz do systemu, z którym ma łączyć się integracja. Administratorowi odpowiedzialnemu za dostęp wskaż ten system i planowaną operację. Przy pracy nad żądaniem porównaj przykład z wymaganiami opisanymi dla zasobu.

Opis zasobu jest punktem odniesienia przy tworzeniu żądań API Thulium. Pomaga też odczytać odpowiedź i zestawić ją z wynikiem oczekiwanym dla danej operacji.

Jak przetestować połączenie i odróżnić błąd żądania od awarii Thulium?

Połączenie z API Thulium przetestuj poprawnie przygotowanym żądaniem. Jeśli wystąpi błąd, porównaj status i treść odpowiedzi z wynikiem ponownej próby.
Sam błąd integracji nie oznacza awarii Thulium.⁷

• Żądanie testowe wyślij do zasobu opisanego w dokumentacji. Użyj właściwej metody i danych uwierzytelniających.
• Odpowiedź API zapisz razem ze statusem HTTP i treścią błędu. Ułatwi to ustalenie, czy serwer przyjął żądanie i dlaczego mógł je odrzucić.
• Parametry żądania porównaj z opisem operacji, jeśli odpowiedź wskazuje błąd danych wejściowych lub uprawnień.
• Połączenie sieciowe zbadaj po stronie klienta, gdy żądanie nie otrzymuje żadnej odpowiedzi HTTP.
• Stan usługi Thulium oceniaj dopiero po wykluczeniu błędu żądania i problemu z siecią. Jedna nieudana operacja nie potwierdza awarii systemu.

Diagnozę integracji Thulium zacznij od ustalenia, czy problem dotyczy żądania, sieci czy odpowiedzi usługi. Te sytuacje wymagają różnych działań.
Kod HTTP 500 oznacza wewnętrzny błąd serwera podczas przetwarzania żądania.²