Zewnętrzne żądania API

Zewnętrzne żądania API pozwalają zdefiniować szablony żądań, a następnie wywołać wychodzące połączenia do dowolnego API z poziomu procesów biznesowych. Dzięki nim możesz połączyć swój projekt z dowolną usługą strony trzeciej, nawet jeśli na rynku nie istnieje jeszcze dla niej żaden moduł.

Definicja

Zapoznaj się ze specyfikacją, jak powinno wyglądać żądanie w dokumentacji API usługodawcy, z którym chcesz się połączyć.

1. Aby zdefiniować nowy szablon żądania, przejdź do zakładki "Business Logic" na pasku bocznym (1), przełącz się na zakładkę "External API Requests" (2) i kliknij "New API Request" (3). 2.

2. Nadaj nowemu żądaniu nazwę i, opcjonalnie, opis.

3. Wybierz metodę HTTP żądania i jego adres URL.

4. Zdefiniować parametry URL, parametry zapytania (tylko dla żądań GET), nagłówki i treść żądania poprzez wprowadzenie nazwy parametru (1), jego typu (2) i kliknięcie "Add Param" (3).

Rzeczywista wartość tych parametrów zostanie określona w momencie wykonania procesu biznesowego, w którym wywołane jest żądanie.

Aby zrozumieć różnicę pomiędzy parametrami URL i parametrami zapytania, przeczytaj więcej tutaj. Niezależnie jednak od standardów, dokumentacja API dostawcy usług, z którym chcesz się połączyć, jest najlepszym źródłem informacji o tym, jak zbudować żądanie.

Możesz również automatycznie wypełnić nagłówki i ciało żądania, wprowadzając przykładowy JSON, system utworzy wszystkie niezbędne parametry automatycznie.

Nie musisz dodawać nowych parametrów na każdej karcie. Niektóre żądania mogą na przykład nie zawierać żadnych parametrów URL, nagłówków lub ciała w ogóle.

W przypadku, gdy żądanie zawiera obiekty (np. samochód -> kolor, rozmiar itp.), będziesz musiał stworzyć wirtualne modele, aby przetworzyć te obiekty później w procesach biznesowych. Zrób to, wybierając "Model" w selektorze typu parametru i wprowadzając elementy potomne, które będą potrzebne. Obiekty można zagnieżdżać dowolną ilość razy (tzn. obiekt w obiekcie) i tworzyć wirtualne tablice modeli. W przypadku, gdy skorzystałeś z autouzupełniania, proces ten został zakończony automatycznie.

5. Zmień ustawienia żądania, takie jak weryfikacja SSL, timeout i obsługa błędów w zakładce "Ustawienia".

6. Przetestuj żądanie, klikając "Test Request" i wprowadzając wszystkie wymagane parametry. Sprawdź odpowiedź z serwera i automatycznie wypełnij nagłówki i ciało odpowiedzi lub zrób to ręcznie.

7. Zapisz szablon żądania klikając "Save Request".

Użyj

Po zdefiniowaniu i zapisaniu nowego żądania, w Edytorze procesów biznesowych dostępny stanie się nowy blok, który pozwoli na jego uruchomienie.

Będziesz musiał dostarczyć mu wszystkie komponenty, które chciałbyś dodać do żądania (URL i parametry zapytania, nagłówki i ciało) jako modele danych, które mogą być wykonane za pomocą tych bloków. Na wyjściu będziesz mógł wyodrębnić sformatowane ciało odpowiedzi, jej nagłówki i status odpowiedzi. Możesz rozszerzyć te modele za pomocą tych bloków.

Nie musisz łączyć wszystkich wejść danych, aby żądanie zostało poprawnie uruchomione. Na przykład, jeśli masz żądanie bez parametrów URL, nie musisz tworzyć jego modelu i podłączać go.

Dla każdego wirtualnego modelu, który zdefiniowałeś, 2 nowe bloki zostaną dodane do edytora procesów biznesowych, aby go stworzyć i rozwinąć.

Monitorowanie

Za każdym razem, gdy uruchomisz żądanie API, system wyśle do logów jego typ i adres, treść żądania, kod statusu HTTP odpowiedzi oraz treść odpowiedzi. Możesz wyprowadzić inne informacje, takie jak określone pola ciała odpowiedzi lub opóźnienia do logów za pomocą bloku Write to Log.