Pamiętaj, wkrótce wyłączymy WebAPI!

Podstawowym i rozwijanym API Allegro jest REST API. Skorzystaj z niego, jeśli tworzysz nową aplikację lub myślisz o rozwoju obecnej. WebAPI to stare rozwiązanie, które utrzymujemy głównie z uwagi na kompatybilność wsteczną z istniejącymi aplikacjami. Nie rozwijamy go już i planujemy jego wyłączenie. Wszelkie nowe funkcjonalności wdrażamy tylko na REST API.

Harmonogram wygaszania poszczególnych metod WebAPI znajdziesz tutaj.

Allegro WebAPI

Interfejs programistyczny platformy Allegro

FAQ

Odpowiedzi na najczęściej zadawane pytania związane z WebAPI.

  1. Czy mogę uzyskać więcej informacji na temat sesji?
    Identyfikator sesji, otrzymany w wyniku wywołania metod doLogin(Enc), zachowuje ważność przez jedną godzinę od momentu jego utworzenia. Dodatkowo - sesja ma charakter odnawialny. Oznacza to, że wywołanie jakiejkolwiek metody wymagającej podania identyfikatora sesji spowoduje, że czas trwania tej sesji będzie naliczany od nowa.

    Dla każdego użytkownika obowiązuje limit maksimum 10 jednocześnie otwartych sesji. W przypadku otwarcia 11-tej z kolei, ta najwcześniej utworzona zostanie automatycznie zamknięta.
  2. Czy na wywoływanie metod nałożone są jakieś limity?

    W WebAPI obowiązuje główny limit nakładany na klucz WebAPI - 9000 zapytań na minutę.

    Jeśli go przekroczysz zablokujemy klucz WebAPI na minutę, a w odpowiedzi otrzymasz błąd: ERR_MINUTE_LIMIT_EXCEEDED.

  3. Jakie maksymalnej długości hasło mogę przekazać przy logowaniu się za pośrednictwem WebAPI?
    Tak naprawdę przekazać można hasło dowolnej długości, jednak po stronie serwera WebAPI odczytane zostanie jedynie pierwsze 16 znaków (aktualny limit na długość hasła w serwisie) - pozostałe znaki zostaną zignorowane.
  4. Jak działają i co oznaczają maski dla opcji oferty?

    Maski te (zwracane przez metody doMyAccount2, doGetItemsInfo oraz doShowItemInfoExt), to - przedstawione w systemie dziesiętnym - sumy logiczne wartości (będących kolejnymi potęgami dwójki), wskazujących na opcje wybrane dla oferty. Wartości te oznaczają kolejno:

    • 1 - oferta jest promowana przez pogrubienie tytułu na listingach,
    • 2 - oferta jest promowana przez wyróżnienie na listingach,
    • 4 - oferta jest promowana przez miniaturkę wyświetlaną na listingach,
    • 8 - oferta sklepowa,
    • 16 - maska zdezaktualizowana (zawsze wyłączona),
    • 32 - maska zdezaktualizowana (zawsze włączona),
    • 64 - maska zdezaktualizowana (zawsze wyłączona),
    • 128 - wybrana forma płatności: zwykły przelew,
    • 256 - wybrana forma płatności: płatność przy odbiorze,
    • 512 - maska zdezaktualizowana (zawsze wyłączona),
    • 1024 - maska zdezaktualizowana (zawsze wyłączona),
    • 2048 - przynajmniej jedna z opcji wysyłki jest darmowa,
    • 4096 - maska zdezaktualizowana (zawsze wyłączona),
    • 8192 - maska zdezaktualizowana (zawsze wyłączona),
    • 16384 - sprzedający zgadza się na wysyłkę za granicę,
    • 32768 - podano dodatkowe informacje o przesyłce i płatności,
    • 65536 - oferta została utworzona z czasem do wystawienia w przyszłości,
    • 131072 - maska zdezaktualizowana (zawsze wyłączona),
    • 262144 - oferta jest promowana przez podświetlenie na listingach,
    • 524288 - maska zdezaktualizowana (zawsze wyłączona),
    • 1048576 - maska zdezaktualizowana (zawsze wyłączona),
    • 2097152 - maska zdezaktualizowana (zawsze wyłączona),
    • 4194304 - wybrana opcja dostawy: przesyłka pocztowa ekonomiczna,
    • 8388608 - wybrana opcja dostawy: przesyłka pocztowa priorytetowa,
    • 16777216 - wybrana opcja dostawy: przesyłka kurierska,
    • 33554432 - wybrana opcja dostawy: odbiór osobisty,
    • 67108864 - maska zdezaktualizowana (zawsze wyłączona),
    • 134217728 - przedmioty w ramach oferty są sprzedawane w kompletach,
    • 268435456 - oferta będzie wznowiona z pełnym zestawem przedmiotów,
    • 536870912 - oferta będzie wznowiona tylko z niesprzedanymi przedmiotami,
    • 1073741824 - maska zdezaktualizowana (zawsze wyłączona).

    Aby odczytać poszczególne opcje, najprościej zamienić otrzymaną maskę na postać binarną i sprawdzić ustawienia kolejnych bitów.
  5. Podczas wywoływania metody otrzymuje błąd ERR_NO_SESSION, chociaż jestem pewny że identyfikator sesji który podaje jest poprawny i aktualny.
    Błąd ten może być wynikiem jednego z zabezpieczeń, które stosowane jest w WebAPI. Podczas wywoływania metody wykorzystującej identyfikator sesji, sprawdzane jest czy IP z którego wywoływana jest metoda jest tym samym IP z poziomu którego sesja była uprzednio utworzona. Należy upewnić się, że obie metody wywoływane są z poziomu tego samego IP.
  6. Co to oznacza, że daną metodę oznaczyliśmy jako deprecated
    Jeśli metodę oznaczyliśmy jako deprecated, oznacza to, że uznaliśmy ją za przestarzałą i wdrożyliśmy już nowsze rozwiązanie. W takiej sytuacji nie zalecamy już korzystania z takiej metody, ale nadal przez jakiś czas będzie jeszcze dostępna, by zachować kompatybilność wsteczną.

    Ważne! Nie gwarantujemy poprawnego działania metody oznaczonej jako deprecated.