Dokumentacja API w panelu Admnistratora

Dokumentacja API platformy Welyo jest dostępna bezpośrednio z poziomu panelu administratora. Zawiera opis dostępnych metod, parametrów oraz przykładowych zapytań i odpowiedzi, które pomagają w przygotowaniu integracji z systemami zewnętrznymi.

Jak otworzyć dokumentację API?

1. Zaloguj się do platformy Welyo jako administrator.
2. Przejdź do sekcji: Administracja >  Integracje  > Dokumentacja API (wersja online).

Po wykonaniu tych kroków w nowej karcie przeglądarki otworzy się strona z dokumentacją API dostępną dla Twojej platformy Welyo.

Jak korzystać z dokumentacji?

Na stronie dokumentacji znajduje się lista wszystkich dostępnych żądań API (endpointów). Wybierz z listy interesujące Cię zapytanie i rozwiń jego szczegóły.

Po rozwinięciu wybranego wiersza dostępne są trzy sekcje:

1. Parametry zapytania – opis parametrów, które można przekazać w zapytaniu (część z nich może być opcjonalna).
2. Przykładowe zapytanie (JSON / body) – przykładowa struktura danych pokazująca, jak może wyglądać wysyłane zapytanie.
3. Przykładowe odpowiedzi (Response) – przykłady odpowiedzi API, zarówno dla poprawnego wykonania operacji, jak i dla sytuacji, gdy wystąpi błąd.

Dostępne wersje dokumentacji

W dokumentacji API dostępne są różne wersje, które odpowiadają konfiguracji i funkcjonalnościom uruchomionym na platformie.

• Focus Contact Center – dla platform wykorzystujących kampanie telefoniczne, mailowe i chat, www, bez włączonej Bazy Rekordów (miniCRM) oraz bez obsługi zgłoszeń.
• Focus Desk – dla platform korzystających z kampanii z kanałem zgłoszeniowym, bez włączonej Bazy Rekordów (miniCRM).
• Focus Contact Center – API v4 – dla platform wykorzystujących kampanie telefoniczne, mailowe, www i chat z aktywną Bazą Rekordów (miniCRM), bez obsługi zgłoszeń.
• Focus Desk – API v4 – dla platform z aktywną Bazą Rekordów (miniCRM) oraz kampaniami wykorzystującymi kanał zgłoszeniowy.

Wybór odpowiedniej wersji dokumentacji API

Wybór odpowiedniej wersji dokumentacji API jest bardzo ważny. Jeśli na platformie aktywna jest Baza Rekordów (miniCRM), należy korzystać z dokumentacji API w wersji v4.

Korzystanie z dokumentacji Focus Contact Center / Focus Desk (bez v4) przy aktywnym miniCRM może powodować rozbieżności w identyfikatorach rekordów, w efekcie nieprawidłowe działanie integracji.

Dodatkowo w wersji API v4 zmieniona została struktura adresów URL – w endpointach pojawia się dodatkowy fragment: /v4/