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.



Klucze

Usługa dostępna jest w pełni za darmo dla każdego użytkownika serwisu (pod warunkiem posiadania w pełni aktywowanego, zarejestrowanego w serwisie Allegro.pl i niezablokowanego konta bez statusu Junior). Aby otrzymać klucz dostępowy, należy wejść do zakładki WebAPI: Generowanie klucza i skorzystać z dostępnego formularza. Należy w nim wskazać charakterystykę przyszłego posiadacza klucza, krótko opisać plany na jego wykorzystywanie oraz zaakceptować Regulamin usługi. Po poprawnym wykonaniu tych czynności, unikalny i niezmienny klucz dostępowy do Allegro WebAPI (jednoznacznie identyfikujący użytkownika w usłudze), zostanie wygenerowany. Klucz ten jest ważny bezterminowo.

Klucz WebAPI zostaje przyporządkowany do danego konta w momencie jego generowania, jednak nie jest to równoznaczne z ograniczeniem możliwości korzystania z niego tylko do wskazanego konta. Każdy użytkownik Allegro znając klucz API innego użytkownika może użyć go, otwierając sobie w ten sposób dostęp do usługi (a punkt III.2. Regulaminu WebAPI jasno wskazuje na zakres odpowiedzialności w takim przypadku). Dlatego należy unikać bezpośredniego udostępniania wartości naszego klucza użytkownikom postronnym.

Dodatkowo warto pamiętać, że klucze API są case sensitive – podanie X123Y456Z w miejsce x123y456z skutkowało będzie zwróceniem przez serwer informacji o nieprawidłowej wartości klucza.

W momencie wygenerowania stałego klucza API otwierającego dostęp do usługi, użytkownik otrzymuje także komplet kluczy wersji – po jednym dla każdego z krajów, w których udostępniamy API (na chwilę obecną jest ich 3). Wartość kluczy wersji – w odróżnieniu od klucza API, zmienia się każdorazowo gdy zaktualizowane zostaną dwa dynamiczne komponenty, które ulegają zmianie z uwagi na swoją naturę ( dotyczy to struktury drzewa kategorii oraz pól formularza sprzedaży). Data takiej aktualizacji jest jednocześnie timestampem, który stanowi wartość klucza wersji w danym kraju. Fakt zmiany kluczy jest zgłaszany przez usługę w ramach przygotowanego specjalnie na tę okoliczność kodu błędu. Daty ostatnich aktualizacji wymienionych komponentów podejrzeć można np. w dolnej części strony głównej na stronie informacyjnej usługi.

Podsumowując temat kluczy:

  Klucz WebAPI
Klucze wersji
Rola Dostęp do usługi
Informowanie o zmianach w komponentach
Liczba kluczy 1 3
Zmienność Nie Tak
Podgląd wartości
Moje Allegro > WebAPI
Metoda doQueryAllSysStatus  



Środowisko developerskie WebAPI Sandbox


Aby umożliwić użytkownikom testowanie API poza serwisem produkcyjnym, udostępniamy odizolowane środowisko deweloperskie Sandbox , pozwalające na bezpieczne testowanie aplikacji działających w oparciu o WebAPI Allegro.pl. Środowisko odwzorowuje wszystkie najistotniejsze produkcyjne funkcjonalności serwisów działających na platformie Allegro, jak również pozwala na przeprowadzenie symulowanych płatności w systemie PayU. Sandbox pozwala m.in. na:
  • wystawianie ofert w serwisie,
  • listowanie ofert wystawionych w danych kategoriach oraz przez danych użytkowników,
  • obsługę wyszukiwarki,
  • przeglądanie informacji o ofertach wystawionych w serwisie,
  • listowanie i wystawianie komentarzy kontrahentom,
  • pobieranie zawartości poszczególnych zakładek testowej wersji Mojego Allegro,
  • składanie ofert kupna.
Co najważniejsze – wszelkie możliwe operacje dokonywane na Web API Sandbox są darmowe. Nie obowiązują tutaj także żadne zakazy i ograniczenia zawarte w Regulaminie Allegro, które są w mocy na serwisach produkcyjnych. Więcej informacji na temat Web API Sandbox znajdzuje się tutaj .


Ostatnia aktualizacja: 08.09.2016 r.