W tym artykule skonfigurujesz metodę do pobrania listy zamówień z API Shoper w BPA Platform.
Dodajemy metodę z API Shoper
W artykule: Konfiguracja API Shoper Premium w BPA Platform, utworzyliśmy pierwszą metodę, która służy do autoryzacji w API Shoper.
Jako następną operację, którą dodamy, wybrałem pobieranie zamówień. Zatem wykorzystam 2 operacje, pobiorę listę zamówień oraz szczegóły poszczególnych zamówień z listy.
Pierwszą operację Orders: list znajdziesz tutaj = https://developers.shoper.pl/developers/api/resources/orders/list
My skonfigurujemy ją następująco:
- najpierw przejdziemy na zakładkę URL
- zaznaczamy opcję Use the connection URL, tym samym będziemy mieli podstawę do budowania request’u
- w Imput parameters dodajemy parametry, po których parametryzowana request do Shoper
- możemy zaznaczyć, które z parametrów są obligatoryjne, które nie
- następnie poniżej budujemy cały url = dodane parametry możemy przeciągnąć-i-upuścić w odpowiednie miejsca w adresie. (są to wartości w nawiasach klamrowych).
- zaznaczamy Encode the parameters in the URL
- klikamy przycisk Advanced, gdzie w kolejnym okienku dodajemy do nagłówka zapis autoryzacji po tokenie ({token} będzie widoczny w Web Service Connector jako dodatkowy parametr)
Jeszcze nie zapisujmy operacji, sprawdźmy czy odpowiada. Będziemy potrzebowali token.
Przechodzimy do zakładki Output Data. Zaznaczamy Output required, a następnie klikamy przycisk Send test message.
Pojawi się nam okno Test Web Service Configuration. Tutaj wybieramy wcześniej przygotowaną metodę, następnie na liście parametrów, przypisujemy im wartości. Mamy odpowiednio:
- token = token API Shoper
- limit = ilość zwracanych wierszy, domyślny jest 50
- pages = od której strony wyników chcemy zacząć, dajmy 1
- filtry, pomijam
Są to parametry przez nas wcześniej skonfigurowane. Klikamy przycisk Test.
W odpowiedzi powinniśmy zobaczyć w Results odpowiedź z API Shoper.
Po kliknięciu w przycisk Close, wrócimy do okna Define HTTP Operation na zakładkę Output Data. Teraz otrzymany komunikat przekształcimy w schemat, który operacja będzie wykorzystywała podczas wywołania operacji w Tasku. API Shoper zwróciło nam wynik w JSON.
Klikamy kolejno przycisk Infer schema from XML or JSON, otrzymujemy w polu z JSON schemat, a następnie walidujemy schemat odpowiedzi klikając przycisk Validate Schema.
Teraz możemy kliknąć przycisk OK i zakończyć definiowane operacji.
Możemy wrócić do okna dodawania kolejnych nowych operacji lub możemy zapisać Web Service i przejść do tworzenia Taska z wykorzystaniem zdefiniowanej metody.
Podsumowanie
W tym artykule dowiedziałeś się jak utworzyć metodę pobierania zamówień z API Shoper Premium.
