Allegro WebAPI

Interfejs programistyczny platformy Allegro

Tutoriale

< < Powrót do listy tutoriali

Pierwsze kroki w Allegro WebAPI

Wykorzystane technologie: WebAPI
Komentarze: 0
Data dodania: 7 czerwca 2016
Ostatnia aktualizacja: 13 listopada 2017

Jeżeli wygenerowałeś sobie klucz WebAPI i chcesz go użyć, by zintergrować swój sklep lub inny system z Allegro.pl, a nie wiesz tylko jak to zrobić - zapoznaj się z tym poradnikiem. Poniżej znajdziesz kilka informacji o tym, jakie metody oraz w jaki sposób możesz wykorzystać. Pamiętaj także o dokumentacji naszej usługi - w poniższym poradniku wielokrotnie się będziemy do niej odwoływać.


Logowanie do serwisu


Pierwsza czynność którą należy opanować, to logowanie do serwisu. Bez tego nie będziesz miał dostępu do Twoich danych, ofert oraz żadnych innych elementów znajdujących się na koncie użytkownika. Do tego celu, poza kluczem WebAPI, danymi do logowania oraz wskazaniem serwisu do którego chcesz się zalogować musisz mieć także tzw. klucz wersji. Jest to ciąg cyfr, który zmienia się za każdym razem, gdy w Allegro WebAPI odświeżane jest drzewo kategorii (kategorie są usuwane, dodawana, modyfikowane, itp) i/lub modyfikowane są pola formularza sprzedaży (np. parametry).

Gdy przy logowaniu za pomocą doLogin / doLoginEnc dostajesz komunikat ERR_INVALID_VERSION_CAT_SELL_FIELDS - Niepoprawna wartość klucza wersji to znaczy, że jeden ze wspomnianych komponentów się zmienił, a ty powinieneś pobrać nowy klucz wersji za pomocą metody doQueryAllSysStatus. Mając te dane, możesz za pomocą wcześniej wymienionych metod bez problemu logować się do serwisu (czyli w przypadku API - tworzyć sesję zalogowania).


Wystawianie oferty


Kolejną, a jednocześnie jedną z najważniejszych funkcjonalności oferowanych przez Allegro.pl jest wystawianie ofert. Można tego dokonywać również za pomocą WebAPI. Na początku należy jednak poznać pojęcie fida. Otóż fid to odpowiednik pola z formularza sprzedaży na stronie WWW serwisu Allegro. Każde pole z formularza to osobny fid w API, w którym należy przekazywać dane jakie miały by się znaleźć w tym polu. Czyli np. w fid = 1 przekazujemy treść tytułu oferty (tak jak w pierwszym polu na formularzu).

Aby dowiedzieć się jakie fidy są dostępne do wykorzystania, wywołaj metodę:

W powyższych metodach każdy fid jest opisany szeregiem informacji np. na temat obligatoryjności, wymaganego typu, przyjmowanych wartości, itp. Szczegóły na temat zwracanych przez powyższe metody pól są dostępne w podlinkowanej wyżej dokumentacji.

Znając już wszystkie fidy potrzebne do wystawienia oferty w wybranej kategorii, możesz wystawić ofertę za pomocą doNewAuctionExt. W tej metodzie na wejściu należy podać wszystkie fidy wymagane w danej kategorii oraz niewymagane, których także chcesz użyć. O tych i innych możliwościach metody możesz poczytać w jej dokumentacji.

Warto sprawdzić także bliźniaczą metodę - doCheckNewAuctionExt, która służy do sprawdzania kosztów wystawienia oferty..

Natomiast jeśli chcesz wyświetlić ofertę lub po prostu pobrać widoczne na niej dane, skorzystaj z metody doShowItemInfoExt lub doGetItemsInfo. Jeśli jednak potrzebujesz danych z oferty w formie pól formularza sprzedaży (fidów), użyj w takim przypadku doGetItemFields.


Kontrola sprzedaży


Warto na bieżąco monitorować sprzedaż w swoich ofertach. Często Użytkownicy wywołują po prostu doGetBidItem2 dla swoich ofert, ale jest to czasochłonne oraz wymaga dużej ilości zapytań, co może spowodować przekroczenie limitów w usłudze. Dlatego zalecamy korzystanie z dzienników:

W obu metodach są pola pozwalające na sterowanie miejscem, z którego ma rozpocząć się pobieranie danych (odpowiednio startingPoint i journalStart). Dzienniki te zwracają wszystkie informacje na temat zmian w ofertach i formularzach pozakupowych, przez co zapewniają komplet informacji potrzebnych do monitorowania sprzedaży.


Pobieranie formularzy pozakupowych


Teraz, gdy wiadomo w jakich ofertach nastąpiła sprzedaż i dla których zakupów wypełniono formularze pozakupowe, pora by poznać dane potrzebne do przeprocesowania sprzedaży do końca.

Dla zakupów z wypełnionymi formularzami opcji dostawy (FOD) warto użyć metody doGetPostBuyFormsIds. Zwróci ona identyfikatory tych formularzy, a dzięki systemowi dynamicznych filtrów na wejściu, pozwoli na precyzyjne filtrowanie pobieranych danych. Identyfikatory można także pobrać z dziennika - są one zwracane w polu dealTransactionId dla dealEventType = 2.

Mając te identyfikatory, możesz podać je na wejściu metody doGetPostBuyFormsDataForSellers. Zwraca ona komplet informacji potrzebnych do obsłużenia sprzedaży, które podał kupujący wypełniając formularz oraz które są wynikiem procesowania się zamówienia (np. statusy płatności).

A jeśli po zakupie nie wypełniono formularza? Wtedy można pobrać dane kupującego bezpośrednio za pomocą metody doGetPostBuyData.

Na sam koniec jeszcze możesz wystawić kontrahentowi komentarz, np. za pomocą doFeedback lub doFeedbackMany. Oczywiście wcześniej możesz sprawdzić za pomocą doGetWaitingFeedbacks czy jakieś komentarze od kupujących już otrzymałeś.

Komentarze [0]rozwiń

  • Przed dodaniem komentarza zaloguj się w serwisie.
  • Po dodaniu komentarza nie będziesz miał możliwości jego edycji ani usunięcia.
  • W uzasadnionych przypadkach możemy wymoderować Twój komentarz.