INPUT REST API

Operator INPUT REST API służy do wywołania dowolnego serwisu (dostępnego w standardzie REST) odebrania danych zwracanych przez serwis i wprowadzenia danych na magistralę w formie tekstowej lub bitowej (aby dowiedzieć się więcej o konwersji danych tekstowych do bitów magistrali danych zapoznaj się z operatorem

CONVERT FORMAT TO BITS ).

PRZYKŁAD PROCESU Z UŻYCIEM OPERATORA

Proces zakłada samodzielne sprawdzenie StatusCode zwracanego przez wywołany serwis.

KONFIGURACJA MAGISTRALI WYJŚCIOWEJ

W przypadku użycia operatora INPUT REST API magistrala wyjściowa operatora będzie zawierać jeden rekord zbudowany z pola danych odebranych z serwisu (zwykle format JSON ale może to być równieź format XML czy czysty tekst) oraz w zależności od konfiguracji pola ze zwróconym StatusCode wykonania serwisu.

Na zakładce Execution należy ustawić sposób działania operatora po otrzymaniu odpowiedzi od wywołanej usługi.

New column with result → Nazwa kolumny (bitu) magistrali danych wyjściowej gdzie zostaną przekierowane dane odebrane z usługi sieciowej (web service).
Error checking → sposób zachowania operatora po odebraniu StatusCode oznaczającego błędne wykonanie serwisu.

Report an error when Status Code is invalid → w przypadku błędnego StatusCode proces zostaje zatrzymany i jako błąd zostanie wyświetlony komunikat z pola Body field with an error message
Send Status Code on the busbar → w tym wypadku proces nie zostanie zatrzymany, a StatusCode zostanie przekazany na magistralę danych w bicie o nazwie podanym w polu New column with status code i może zostać zweryfikowany w procesie przy użyciu operatora IF. Jeśli usługa zwraca szczegóły błędu są one dostepne w polu New column with result

Body field with an error message → komunikat błędu w przypadku przerwania działania procesu automatycznie gdy otrzymany jest niepoprawny StatusCode.
New coulumn with status code → kolumna (bit) do którego trafi StatusCode wykonania.

Pola Single execution oraz Result target są nieaktywne i używane tylko w operatorze

REST API CALL

KONFIGURACJA ADRESU USŁUGI

Aby skonfigurować połączenie do serwisu musisz na zakładce Request podać metodę HTTP jakiej używa serwis, adres pod jakim dostępny jest serwis i jeśli to jest wymagane metodę autoryzacji.

operator obsługuje następujące metody HTTP

GET
POST
PUT
DELETE
PUTCH

oraz podstawowe metody autoryzacji

Basic Auth
Api key
Simple auth
Bearer token

Ponieważ operator zapewnia pełen dostęp do tworzenia nagłówków żądania HTTP oraz pozwala na ich elastyczną budowę z wykorzystaniem parametrów możliwe jest użycie praktycznie każdego systemu uwierzytelniania.

Wpisując adres serwisu w polu Endpoint możesz wykorzystać parametry systemu. Klikając w przycisk obok pola.

Parametry wywołania możemy podać bezpośrednio w polu Endpoint w formacie [endpoint]?parName1=value&parName2=value lub wprowadzić je w formie nazwa → wartość na zakładce Query parameters

NAGŁÓWKI ZAPYTANIA HTTP

Zakładka Headers pozwala na podgląd dodawanie i modyfikacje nagłówków zapytania HTTP. Operator ustawia kilka standardowych nagłówków.

Jeśli chcesz zmodyfikować dowolny nagłówek kliknij dwukrotnie w jego wartość, aby ją poprawić.

Aby prowadzić nowy nagłówek kliknij w ostatni rekord i podaj nazwę i wartość nagłówka.

CONTENT ZAPYTANIA

Na zakładce Body możesz ustawić content wysyłany do serwisu.

Masz możliwość wysłania contentu na kilka sposobów

none → content nie jest wysyłany
form-data → content jest wysyłany jako para kluczy name/value. Dane nie są poddane kodowaniu a wartością może być również ciąg binarny.

Po wyborze tego typu możesz wpisać na liście nazwę klucza i jego wartość klikając w pusty rekord.

x-www-form-urlencoded → content wysyłany jest jako para kluczy name/value. Dane są poddawane kodowaniu tak samo jak parametry URL. W tym typie nie jest możliwe przesłanie danych binarnych.

Po wyborze tego typu możesz wpisać na liście nazwę klucza i jego wartość klikając w pusty rekord.

raw → jako content w tym typie może zostać wprowadzony dowolny ciąg znaków jednak w celu dobrania odpowiedniego nagłówka Content-Type możesz wybrać w jakim formacie wprowadzasz dane.

Text → dowolny ciąg
JavaScript → format zgodny z językiem JavaScript
JSON → ciąg zgodny z formatem JSON (JavaScript Object Notation)
HTML → format zgodny z jezykiem znaczników XML (HyperText Markup Language)
XML → Ciąg zgodny z formatem XML (Extensible Markup Language)

Wybierając odpowiedni typ contentu system automatycznie dodaje nagłówek Content-type zgodny z wybranym typem.