Allegro WebAPI

Interfejs programistyczny platformy Allegro

Informacje ogólne

Przekrojowe informacje na temat Allegro WebAPI, które ułatwią Ci rozpoczęcie pracy z usługą.


WebAPI w pigułce

Allegro WebAPI jest usługą umożliwiającą dostęp do zasobów i logiki serwisu bez pośrednictwa warstwy interfejsu. Usługa przeznaczona jest dla programistów zainteresowanych budowaniem własnych rozwiązań korzystających z danych i mechanizmów udostępnianych przez serwis.
 
Działanie API serwisu zostało (w sposób uproszczony) przedstawione na poniższym schemacie:
 

Schemat przedstawiający metodę działania usługi Allegro WebAPI

Allegro WebAPI to usługa sieciowa opierająca swoje działanie na protokole SOAP, wykorzystująca język XML jako format tworzenia komunikatów oraz protokół RPC do ich przenoszenia pomiędzy klientem (aplikacją), a serwerem WebAPI. Usługa jest w pełni zgodna z obecnie obowiązującymi standardami SOAP.

Pełny opis usługi zdefiniowany został za pomocą języka WSDL i znaleźć go można pod adresem (dostępnym wyłącznie za pośrednictwem kanału szyfrowanego): https://webapi.allegro.pl/service.php?wsdl. WSDL kodowany jest w stylu Document/Literal (Wrapped) - zgodnym ze standardami WS-I.

Wykorzystanie protokółu RPC determinuje architekturę usługi. Allegro WebAPI składa się z szeregu metod, które stanowią odwzorowanie poszczególnych funkcjonalności serwisu. Za pomocą naszego API można m.in.:
  • wystawiać oferty na Allegro,
  • listować oferty wystawione w danych kategoriach oraz przez danych użytkowników,
  • obsługiwać wyszukiwarkę,
  • przeglądać informacje o ofertach wystawionych w serwisie,
  • pobierać dane kontaktowe użytkowników, którzy zakupili towar w ofertach danego użytkownika,
  • listować i wystawiać komentarze kontrahentom,
  • pobierać zawartość poszczególnych zakładek Mojego Allegro,
  • składać oferty kupna,
  • obsługiwać w pełni system zwrotów prowizji działający w serwisie,
  • pobierać informacje dot. statusu wpłat dokonywanych za pośrednictwem PayU.

Allegro WebAPI jest usługą wielojęzykową - odpowiednio parametryzując dane metody, można otrzymać zwracane informacje (również komunikaty błędów) w języku odpowiednim dla wybranego kraju.



Dane dostepowe

API udostępniamy za darmo dla każdego użytkownika serwisu, który ma niezablokowane konto. Jeżeli chcesz otrzymać dane dostępowe do API:
  • przejdź pod adres https://apps.developer.allegro.pl/,
  • kliknij w ‘Zarejestruj nową aplikację’,
  • wypełnij formularz (podaj nazwę aplikacji, opisz ją i podaj adres, na jaki mamy przekierować użytkowników po uwierzytelnieniu na stronie Allegro),
  • zaznacz, że zapoznałeś się z regulaminami naszych API i akceptujesz je,
  • kliknij w ‘Dodaj’.
Gdy przejdziesz ten proces, wygenerujemy dla Ciebie dane dostępowe (Client ID oraz Client Secret) do WebAPI i REST API. Dane te będą ważne bezterminowo. Jeżeli chcesz zarejestrować kolejne aplikacje, wystarczy że przejdziesz ten proces ponownie - możesz mieć wygenerowane dane do więcej niż jednej aplikacji. Za pomocą tych danych możesz korzystać z obu naszych API. W przypadku WebAPI, jako klucz WebAPI powinieneś podać treść Client ID.


Uwaga! Jeżeli generowałeś dane dostępowe przed 24 maja 2018 roku, zamiast Client ID posiadasz klucz WebAPI. Znajdziesz go pod tym samym adresem, pod którym są pozostałe dane dostępowe. Klucz WebAPI jest przyporządkowany do danego konta. Na jednym koncie może być wygenerowany tylko jeden klucz.

Zarówno klucz WebAPI, jak i Client ID oraz Client Secret, generujemy głównie na potrzeby uruchomienia aplikacji, które korzystają z naszych API. Jeżeli jesteś użytkownikiem takiej aplikacji, a nie jej twórcą, nie generuj tych danych.

Do każdego klucza WebAPI przypisany jest klucz wersji. Wartość klucza wersji zmienia się za każdym razem, gdy aktualizujemy dwa dynamiczne komponenty. Jest to struktura drzewa kategorii oraz pól formularza sprzedaży. Data ich aktualizacji jest jednocześnie znacznikiem czasu (timestampem), który stanowi wartość klucza wersji. Jeśli podasz nieaktualną wartość klucza wersji zwrócimy kod błędu - ERR_INVALID_VERSION_CAT_SELL_FIELDS - Niepoprawna wartość klucza wersji. Nowy, aktualny klucz wersji możesz pobrać za pomocą metody doQueryAllSysStatus.

Daty ostatnich aktualizacji komponentów znajdziesz w dolnej części strony głównej na stronie informacyjnej usługi.



Środowisko testowe Allegro Sandbox


Czym jest Sandbox?

Allegro Sandbox to środowisko testowe. Możesz na nim bezpiecznie testować WebAPI oraz REST API platformy Allegro. Środowisko odwzorowuje wszystkie najważniejsze funkcje serwisu Allegro - możesz m.in.:
  • aktywować konto,
  • wystawić ofertę,
  • przejść cały proces zakupowy,
  • korzystać z wyszukiwarki,
  • wystawić ocenę sprzedawcy.
Dzięki symulatorowi sprawdzisz na nim również szybkie płatności online.

Jak to działa?

Sandbox działa na tej samej zasadzie, co środowisko produkcyjne. Ze środowiska testowego możesz korzystać, tak jak z Allegro.pl:
  • przez interfejs graficzny (pod adresem https://allegro.pl.allegrosandbox.pl)
  • przez WebAPI (za pomocą WSDL-a https://webapi.allegro.pl.allegrosandbox.pl/service.php?wsdl)
  • przez REST API (za pomocą https://api.allegro.pl.allegrosandbox.pl)
Środowisko testowe udostępniliśmy dla wszystkich. Aby otrzymać stały dostęp do środowiska, przejdź pod jego adres i kliknij w "Załóż konto", a następnie aktywuj je. Klucz WebAPI do środowiska testowego możesz wygenerować na swoim koncie testowym w zakładce WebAPI w Moim Allegro.

Pamiętaj, by podczas aktywacji podać rzeczywiste dane adresowe. Czyli taki kod pocztowy, ulicę i miasto, które do siebie pasują, np:
  • ulica: Grunwaldzka 182,
  • kod pocztowy: 60-166,
  • miasto: Poznań.
W przeciwnym przypadku aktywacja może się nie udać.

Środowisko testowe jest odrębne względem środowiska produkcyjnego.

Ważne!

Zasady korzystania z testowych wersji interfejsów programistycznych Serwisu Allegro


  1. W ramach strony allegro.pl.allegrosandbox.pl masz możliwość nieodpłatnego testowania obu interfejsów programistycznych Serwisu Allegro (WebAPI i REST API) w ramach jednego środowiska (dalej “Usługa”).
  2. Usługa świadczona jest przez Allegro.pl sp. z o.o. z siedzibą w Poznaniu, przy ul. Grunwaldzkiej 182, 60-166 Poznań, wpisana do rejestru przedsiębiorców prowadzonego przez Sąd Rejonowy Poznań - Nowe Miasto i Wilda w Poznaniu, VIII Wydział Gospodarczy Krajowego Rejestru Sądowego pod numerem KRS: 0000635012, kapitał zakładowy: 34 000 000 złotych, posiadająca numer identyfikacji podatkowej NIP 525-26-74-798, REGON 365331553 (dalej “Allegro.pl”).
  3. Rozpoczęcie korzystania przez Ciebie z Usługi jest równoznaczne z akceptacją niniejszych Zasad.
  4. Celem Usługi jest umożliwienie Ci zapoznania się ze sposobem jej świadczenia przez Allegro.pl.
  5. Allegro.pl informuje, co rozumiesz i akceptujesz, iż dane w ramach Usługi nie podlegają żadnej formie kopii zapasowych.
  6. Allegro.pl ma prawo usunąć wszelkie przetwarzane przez Ciebie przy wykorzystaniu Usługi dane, w szczególności jeżeli naruszasz niniejsze Zasady.
  7. Nie możesz wykorzystywać Usługi do przetwarzania materiałów zawierających treści o charakterze bezprawnym, w szczególności materiałów stanowiących lub zawierających wirusy komputerowe lub jakiekolwiek inne oprogramowanie, którego działanie skutkuje naruszeniem prawa.
  8. Ponadto, nie możesz podejmować jakichkolwiek działań mających wpływ na systemy zabezpieczeń systemów informatycznych Serwisu Allegro lub osób trzecich, a także działać w sposób powodujący utratę stabilności pracy lub przeciążenie systemów informatycznych bezpośrednio lub pośrednio zaangażowanych przy świadczeniu Usługi.
  9. Pamiętaj, że ponosisz pełną odpowiedzialność za działania własne oraz osób, którym udostępniłeś w sposób celowy lub wskutek zaniedbania dane niezbędne do korzystania z Usługi.
  10. Allegro.pl zastrzega, że nie gwarantuje i nie ponosi jakiejkolwiek odpowiedzialności za jakiekolwiek szkody spowodowane utrudnieniem lub brakiem możliwości korzystania z Usługi, w tym także za utratę lub zniekształcenie jakichkolwiek danych przez Ciebie przetwarzanych przy wykorzystaniu Usługi.
  11. Z uwagi na specyfikę i charakter przedmiotowej Usługi, pamiętaj aby w formularzach nie podawać prawdziwych danych osobowych.


Ostatnia aktualizacja: 22.03.2018r.