WebAPI Sandbox

Środowisko deweloperskie dla programistów WebAPI platformy Allegro

czym jest sandbox

Sandbox to zamknięte, odizolowane środowisko deweloperskie, pozwalające na bezpieczne testowanie aplikacji działających w oparciu o WebAPI platformy Allegro. Ś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.

jak to działa

Korzystanie z Sandboxa odbywa się dokładnie na tej samej zasadzie, jak korzystanie ze środowisk produkcyjnych. Ze środowiska deweloperskiego korzystać można zarówno odpytując je po WebAPI (pamiętając jedynie o odpytywaniu odpowiedniego endpointa), jak i klasycznie - za pośrednictwem jego GUI.

Aby otrzymać stały dostęp do środowiska, należy udać się do zakładki WebAPI w produkcyjnym Moim Allegro, gdzie - po skorzystaniu z przycisku Wygeneruj dane dostępowe - zostanie utworzone konto, za pośrednictwem którego będzie można rozpocząć testy. Konta dostępowe (wraz z kluczami) utworzone w taki sposób są każdorazowo przywracane po cyklicznych przerwach serwisowych, mających miejsce na Sandboxie.

Użytkownicy, oferty, transakcje, itd. nie są współdzielone pomiędzy Sandboxem, a środowiskiem produkcyjnym. W związku z powyższym, na środowisku deweloperskim można utworzyć dowolną, zależną od bieżących potrzeb, liczbę dodatkowych użytkowników, ofert czy transakcji, pamiętając jedynie o fakcie cyklicznych przerw serwisowych oraz ich konsekwencjach.

przerwy serwisowe

Z uwagi na charakter środowiska i w celu zapewnienia odpowiedniej jakości jego funkcjonowania, cyklicznie (zazwyczaj raz w miesiącu), wykonywane są na środowisku prace techniczne, skutkujące przerwą w dostępie do środowiska, a także permanentnym usunięciem wszelkich danych utworzonych wcześniej na Sandboxie (dodatkowi użytkownicy, oferty, transakcje kupna, komentarze, płatności, etc). Jedynymi odtwarzanymi danymi, są użytkownicy wraz z przypisanymi do nich kluczami WebAPI, wygenerowani z poziomu zakładki WebAPI w produkcyjnym Moim Allegro.

Wystąpienie przerwy serwisowej każdorazowo zapowiadane jest w Aktualnościach na stronie informacyjnej WebAPI.

odświeżanie środowiska

Sandbox doprowadzany jest do stanu zgodnego z produkcyjnym raz na dwa tygodnie. Fakt odświeżania Sandboxa nie łączy się z niedostępnością środowiska lub usuwaniem jakichkolwiek danych i zazwyczaj nie jest odczuwalny dla użytkowników środowiska.

co jeszcze warto wiedzieć

  1. Sandboxowy WSDL dostępny jest pod adresem:
    https://webapi.allegro.pl.webapisandbox.pl/service.php?wsdl
  2. Na Sandboxie występują pewne różnice w działaniu pomiędzy nim a serwisami produkcyjnymi:
    • W formularzach pozakupowych nie są aktywne metody płatności: Konto PayU oraz Raty PayU
    • W wyszukiwarce nie działa opcja: „szukaj też w opisach i parametrach”
    • Strefa okazji jest pusta
    • Na stronie głównej oraz na liście i stronach działów nie są wyświetlane grafiki reklamowe
    • Nie jest dostępny Regulamin oraz mobilne wersje serwisów
    • Nie działa Pomoc, formularz kontaktowy oraz strony informacyjne
    • Z poziomu zakładki WebAPI w Moim Allegro na Sandboxie nie ma możliwości wygenerowania użytkownika sandboxowego
    • Wychodzące ze środowiska maile są dodatkowo opakowywane (szczegóły poniżej)
  3. Ze względów bezpieczeństwa, wszystkie wiadomości wychodzące ze środowiska są dodatkowo opakowywane w email informujący o tym, że dana wiadomość pochodzi ze środowiska deweloperskiego WebAPI. Każdy taki email (w angielskiej wersji językowej), zawiera załącznik w postaci pliku EML, w którym znajduje się oryginalna wiadomość.
  4. Na środowisko nałożone są limity wywołań:
    • Limit minutowy (na klucz WebAPI): maks. 600 wywołań na minutę (po jego przekroczeniu następuje 5-minutowa blokada klucza, podczas której każde wywołanie metody kończyło się będzie błędem: ERR_MINUTE_LIMIT_EXCEEDED).
    • Limit sekundowy (na IP): maks. 10 połączeń na sekundę (możliwy do zdjęcia, poprzez poprawne wypełnienie CAPTCHA z poziomu WWW dla zablokowanego IP; po jego przekroczeniu dla każdego wywołania metody zwracany jest błąd: ERR_IP_LIMIT_EXCEEDED).