developer.allegro.pl Open in urlscan Pro
185.31.27.185  Public Scan

Submitted URL: https://api.allegro.pl.allegrosandbox.pl/
Effective URL: https://developer.allegro.pl/tutorials/informacje-podstawowe-b21569boAI1
Submission: On June 23 via api from US — Scanned from US

Form analysis 1 forms found in the DOM

GET /search

<form action="/search" method="get" autocomplete="off" class="mp7g_oh mp0t_0a mpof_ki mwdn_1 mwdn_0_s" data-role="article-search-form"><input type="search" name="phrase" data-role="search-query" placeholder="Szukaj w Allegro REST API"
    class="mgmw_wo m0qj_5r m7er_k4 mupj_mm msts_pt mjyo_6x mp4t_0 m3h2_0 munh_0 mx7m_1 m911_co mnyp_co mdwl_co mlkp_ag mefy_5r msbw_2 mtag_2 m9tr_5r mse2_48 mryx_16 mryx_0_s _93711_SOPEQ" value="">
  <div class="mp7g_oh msa3_z4 msts_pt mp4t_0 m3h2_0 munh_0 mx7m_1 m911_co mnyp_co mdwl_co mlkp_ag mefy_5r mryx_16 mryx_0_s _93711_IMbfP mpof_5r" data-role="article-search-filters">
    <div class="mpof_ki mgmw_wo m7f5_sf m389_6m mqen_m6 _93711_XXP6Y" data-role="article-search-current-filter">Cały portal</div>
    <div class="mp7g_f6 mpof_5r mjb5_1 mp4t_0 msa3_z4 msts_pt mx7m_1 m911_co mefy_co mnyp_co mdwl_co mlkp_ag _93711_fDCsW" data-role="apron-filters">
      <div class="mgn2_13 m9qz_yr mqu1_1 mtsp_ib mp4t_0 m3h2_0 mryx_0 munh_0 mgmw_91">gdzie?</div><input id="article-search-everywhere" class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio" name="category" data-role="search-filter" value=""
        checked=""><label for="article-search-everywhere" class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">Cały portal</label><input id="b6c17949-b13c-49eb-b777-fcef6b2adfe0" class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio"
        name="category" data-role="search-filter" value="b6c17949-b13c-49eb-b777-fcef6b2adfe0"><label for="b6c17949-b13c-49eb-b777-fcef6b2adfe0" class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">Jak zacząć</label><input
        id="eb4e8721-c9c7-4c3b-b624-9487cfed555d" class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio" name="category" data-role="search-filter" value="eb4e8721-c9c7-4c3b-b624-9487cfed555d"><label for="eb4e8721-c9c7-4c3b-b624-9487cfed555d"
        class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">Poradniki</label><input id="1d8b2aa6-1609-45c7-af6e-ab00d99411d2" class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio" name="category" data-role="search-filter"
        value="1d8b2aa6-1609-45c7-af6e-ab00d99411d2"><label for="1d8b2aa6-1609-45c7-af6e-ab00d99411d2" class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">Co nowego</label><input id="d1332ae1-cef2-479e-96fb-e49a0c527744"
        class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio" name="category" data-role="search-filter" value="d1332ae1-cef2-479e-96fb-e49a0c527744"><label for="d1332ae1-cef2-479e-96fb-e49a0c527744"
        class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">Dokumentacja</label><input id="0cd2887d-46c9-4dd3-ab0e-5e0d2fb5896c" class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio" name="category" data-role="search-filter"
        value="0cd2887d-46c9-4dd3-ab0e-5e0d2fb5896c"><label for="0cd2887d-46c9-4dd3-ab0e-5e0d2fb5896c" class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">FAQ</label><input id="e8023ed6-c86b-4b42-9378-6b24ce4b1148"
        class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio" name="category" data-role="search-filter" value="e8023ed6-c86b-4b42-9378-6b24ce4b1148"><label for="e8023ed6-c86b-4b42-9378-6b24ce4b1148"
        class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">Regulamin</label><input id="6f6d2817-76a4-4b69-896a-4821eab5b25d" class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio" name="category" data-role="search-filter"
        value="6f6d2817-76a4-4b69-896a-4821eab5b25d"><label for="6f6d2817-76a4-4b69-896a-4821eab5b25d" class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">Kontakt</label><input id="a8486812-025e-45eb-b18e-e1e359fe9e13"
        class="mp7g_f6 m9vn_gl _93711_F2SpC" type="radio" name="category" data-role="search-filter" value="a8486812-025e-45eb-b18e-e1e359fe9e13"><label for="a8486812-025e-45eb-b18e-e1e359fe9e13"
        class="mpof_z0 mgmw_3z mg9e_8 mj7a_8 meqh_en mqen_m6 m6ax_n4 _93711_qzUXe">Strona główna</label>
    </div>
  </div><input type="submit" value="Szukaj"
    class="mgn2_14 mp0t_0a m9qz_yp mp7g_oh mqu1_40 mtsp_ib mli8_k4 mp4t_0 m3h2_0 mryx_0 munh_0 m911_5r mefy_5r mnyp_5r mdwl_5r msbw_2 mldj_2 mtag_2 mm2b_2 mqvr_2 msa3_z4 mqen_m6 meqh_en m0qj_5r mh36_16 mvrt_16 mg9e_0 mj7a_0 mjir_sv m2ha_2 m8qd_qh mjt1_n2 btfbp mgmw_9u msts_enp mrmn_qo mrhf_u8 m31c_kb m0ux_fp bp6m4 mzaq_5r mse2_56 _93711_dfXPg">
  <div class="mj7u_0 mnjl_0 mp7g_f6 mjb5_zp mgn2_14 mp0t_0a mqu1_21 mgmw_wo mli8_k4 mx7m_1 m911_co mefy_co mnyp_co mdwl_co mlkp_ag msts_pt _93711_fDbds mpof_5r" data-role="article-search-suggestions">
    <div data-type="suggestions"></div>
  </div>
</form>

Text Content

REST API

Cały portal
gdzie?
Cały portalJak zacząćPoradnikiCo nowegoDokumentacjaFAQRegulaminKontaktStrona
główna


Polska | polski | PLN

Zaloguj
Jak zacząć
 * Informacje podstawowe
 * Główne procesy
 * Uwierzytelnianie i autoryzacja
 * Wzorzec Command
 * Glosariusz
 * Lista metod



Poradniki
 * Pierwsze kroki
 * Wystawianie oferty z produktem
 * Serwisy zagraniczne Allegro
 * Zarządzanie ofertami
 * Oferty wielowariantowe
 * Pasuje do
 * Zarządzanie zgłoszeniami ofert do kampanii
 * Rabaty i promocje
 * Zamówienia
 * Wysyłam z Allegro
 * One Fulfillment by Allegro
 * Dyskusje
 * Konto i dane użytkownika
 * Centrum wiadomości
 * Sprawdzanie opłat
 * Wystawianie ogłoszeń
 * Publiczne oferty



FAQ
Co nowego
 * Aktualności
 * Changelog

Dokumentacja
Regulamin
Kontakt
Zarządzaj API
 * Moje aplikacje
 * Moje aplikacje (sandbox)
 * Newsletter



 1. Allegro REST API
 2. Informacje podstawowe

REST API
Metody HTTP
Protokół komunikacyjny
Reprezentacja danych (JSON)
Dostęp do API
Uwierzytelnianie i autoryzacja
Parametry
Wersjonowanie zasobów
Metody w wersji beta
Wersja językowa
Statusy HTTP
Obsługa błędów
Stronicowanie
Filtrowanie
Sortowanie
Data i czas
Cena i waluta
Identyfikatory zasobów
Ograniczenie liczby zapytań (limity)
Środowisko testowe
Środowisko testowe - regulamin


INFORMACJE PODSTAWOWE

Co musisz wiedzieć, żeby rozpocząć pracę z REST API Allegro.

> 


REST API

Platforma Allegro udostępnia klientom funkcjonalności w ramach API w oparciu o
architekturę REST. Wykorzystuje do tego celu protokół HTTP wraz z jego metodami:
GET, POST, PUT, PATCH, DELETE. Elementy platformy Allegro zostały podzielone na
zasoby np. /sale/offers, /sale/categories, /order/checkout-forms, itd. Dostęp do
poszczególnych zasobów następuje poprzez wywołanie wybranej metody HTTP na
adres: https://api.allegro.pl, dodając ścieżkę do wybranego zasobu.

Przykładowe pobranie informacji o kategorii Allegro z identyfikatorem 2:

 GET https://api.allegro.pl/sale/categories/2

> 

Jeśli chcemy pobrać więcej niż jeden zasób, pomijamy w ścieżce identyfikator.
Przykładowe pobranie listy kategorii Allegro:

 GET https://api.allegro.pl/sale/categories

> 

Jeśli chcesz pobrać całą dokumentację zasobów w formie swagger.yaml kliknij
tutaj.




METODY HTTP

Każdy z zasobów API korzystać może z następujących metod HTTP:

 * GET: Wykorzystywana do pobierania danych. Wszystkie metody GET mogą być
   wołane wielokrotnie, gdyż nie modyfikują żadnych zasobów Allegro.
 * POST: Wykorzystywana do utworzenia nowego zasobu (np. utworzenie nowego
   draftu oferty tworzy zasób typu /sale/offers. Dwukrotne wywołanie metody POST
   na zasobie /sale/offers spowoduje stworzenie dwóch draftów ofert na Allegro.
 * PUT: Wykorzystywana do edycji zasobu (np. edycja opisu wystawionej na Allegro
   oferty). Dwukrotne wywołanie metody PUT na tym samym zasobie jest bezpieczne.
 * PATCH: Wykorzystywana do częściowej edycji zasobu (np. edycja ceny, bez
   konieczności przesyłania całego modelu oferty).
 * DELETE: Wykorzystywana do usuwania zasobów.


PROTOKÓŁ KOMUNIKACYJNY

Dostęp do REST API odbywa się poprzez połączenie HTTPS do serwera
api.allegro.pl. Wszystkie dane, wysyłane i odbierane z serwera są w formacie
JSON.

 $ curl -i https://api.allegro.pl

 HTTP/1.1 404 Not Found
 Connection: keep-alive
 Trace-Id: 99436185-4d7c-483b-a594-e56cbfcec360
 Content-Type: application/json; charset=utf-8
 Content-Length: 165
 Date: Tue, 08 Sep 2015 07:59:45 GMT
 X-Frame-Options: SAMEORIGIN

 {"errors":[{"code":"NotFoundException","message":"Not found","details":null,"path":null,"userMessage":"Funkcja niedostępna. Skontaktuj się z autorem aplikacji."}]}

> 

Każda odpowiedź zawiera m.in. nagłówek Trace-Id, którego wartość jednoznacznie
identyfikuje zapytanie HTTP klienta. W przypadku zgłaszania problemu z
zapytaniem HTTP należy przekazać wartość Trace-Id w zgłoszeniu.


REPREZENTACJA DANYCH (JSON)

Wszystkie dane wysyłane są i odbierane z API w formacie JSON. Podstawowym
elementem tego formatu jest pole, którego nazwa jest oddzielona od wartości pola
dwukropkiem. Pola rozdziela przecinek. Kolejnym elementem jest obiekt JSON,
zawierający się w nawiasach klamrowych. Tablice w formacie JSON są zapisywane z
wykorzystaniem nawiasów kwadratowych. Puste pola (z wartością null) są
każdorazowo załączane do odpowiedzi - nie są ukrywane.

 {
  "offers": [
    {
      "id": "123",
      "title": "test"
    },
    {
      "id": "456",
      "title": null
    }
  ]
 }

> 


DOSTĘP DO API

Dostęp do API uzyskasz po zarejestrowaniu swojej aplikacji.


UWIERZYTELNIANIE I AUTORYZACJA

Wszystkie żądania zasobów REST API wymagają przekazania tokena OAuth w nagłówku
Authorization. Więcej o autoryzacji za pomocą OAuth przeczytasz w dedykowanym
temu tematowi artykule.


PARAMETRY

Wiele metod API może przyjmować opcjonalne parametry. Zapytania HTTP typu GET
przyjmują parametry, które są umieszczone w adresie zasobu, którego dotyczy
zapytanie. Jeśli nazwa parametru odpowiada polu wewnątrz obiektu, części tej
nazwy są rozdzielone kropkami:

 https://api.allegro.pl/sale/offers?product.id.empty=true

> 

Pozostałe typy zapytań HTTP, takie jak POST i PUT, mają parametry umieszczone w
treści zapytania, a nie w adresie:

 curl -X POST \
 'https://api.allegro.pl/sale/offers'
 -H 'authorization: Bearer {token}' \
 -H 'accept: application/vnd.allegro.public.v1+json' \
 -H 'content-type: application/vnd.allegro.public.v1+json' \
 -d '{
     "name": "Suszarka do włosów z dyfuzorem jonizacja",
     "category": {
         "id": "257150"
     }
 }'

> 

Zapytania typu DELETE nie przyjmują parametrów umieszczonych w treści, jednak
może się zdarzyć, że przyjmą parametry w adresie zasobu.


WERSJONOWANIE ZASOBÓW

Metody REST mogą być wersjonowane. Wywołując metodę należy podać numer wersji
zasobu (można go podejrzeć w dokumentacji metody).

Wersję metody wybieramy przez ustawienie np. _v1_ w nagłowkach Accept lub
Content-Type:

 application/vnd.allegro.public.v1+json

> 

Wyjątkiem są metody DELETE oraz end-point OAuth (https://allegro.pl/auth), które
nie są wersjonowane.


METODY W WERSJI BETA

Metody w wersji beta, to zasoby nad którymi jeszcze pracujemy. Mogą one nie
realizować pełnej funkcjonalności, często być zmieniane oraz łamać
kompatybilność wsteczną.

Wersja beta metody oznaczona jest podobnie do wersji produkcyjnej. Jedyną
różnicą jest to, że w nazwie typu danych znajduje się słowo beta:

 application/vnd.allegro.beta.v1+json

> 

Zasoby w tej wersji są odpowiednio oznaczone w dokumentacji.

Przykład wywołania zasobu w wersji pierwszej, stabilnej:

 https://api.allegro.pl/sale/delivery-methods \
 -H 'Authorization: Bearer {token}' \
 -H 'accept: application/vnd.allegro.beta.v1+json'

> 

Przykład wywołania zasobu w wersji drugiej, beta:

 https://api.allegro.pl/sale/delivery-methods \
 -H 'Authorization: Bearer {token}' \
 -H 'accept: application/vnd.allegro.beta.v2+json'

> 


WERSJA JĘZYKOWA

Jeżeli chcesz być pewny, że wszystkie teksty zwracane będą w języku polskim,
wysyłaj z każdym żądaniem nagłówek:

 Accept-Language: pl-PL

> 

Natomiast jeżeli preferujesz język angielski, wysyłaj nagłówek:

 Accept-Language: en-US

> 


STATUSY HTTP

Każde żądanie do API zwraca status HTTP informujący o wyniku przetwarzania.
Poniższa lista zawiera najczęściej używane statusy:

 * 200 OK: Zwracany w przypadku powodzenia metody GET i PUT.
 * 201 Created: Potwierdza utworzenie dokumentu za pomocą metody POST.
 * 202 Accepted: Określa, że żądanie zostało zaakceptowane przez serwer, ale
   jego przetwarzanie jeszcze się nie zakończyło (dotyczy przetwarzania
   asynchronicznego).
 * 204 No Content: Zwracany przy powodzeniu operacji, kiedy żądanie nie zwraca
   żadnych danych (np. metoda DELETE).
 * 304 Not Modified: Oznacza brak zmian w żądaniu HTTP - brak przekierowania.
 * 400 Bad Request: Wysłano niepoprawne dane JSON.
 * 401 Unauthorized: Użytkownik nie jest uwierzytelniony - powinien zalogować
   się w Allegro, a następnie spróbować jeszcze raz wywołać żądanie.
 * 403 Forbidden: Użytkownik jest uwierzytelniony, ale nie ma praw do danego
   zasobu.
 * 404 Not Found: Odpytywany zasób nie istnieje w API.
 * 406 Not Acceptable: W nagłówku Accept przekazany został nieobsługiwany przez
   zasób typ danych.
 * 415 Unsupported Media Type: W nagłówku Accept przekazany został
   nieobsługiwany przez zasób typ danych.
 * 422 Unprocessable Entity: Wysłano niepoprawne wartości pól, np. walidacja
   obiektu zwróciła błąd, albo któreś z pól nie spełnia kryteriów nałożonych na
   nie przez zasób.
 * 429 Too Many Requests: Klient przekroczył limit liczby żądań.
 * 503 Service Unavailable: Połączenie z serwisem nie jest możliwe.


OBSŁUGA BŁĘDÓW

Każde błędne wywołanie API jest sygnalizowanie statusem odpowiedzi HTTP większym
lub równym 400 oraz treścią odpowiedzi. Wyróżniamy dwa możliwe formaty błędów.

Pierwszy z nich wystąpi w przypadku wszelkich problemów z żądaniem. Zawiera on
tablicę błędów errors, opisującą przyczynę problemu:

 {
    "errors": [
        {
            "code": "NotAcceptableException",
            "message": "An error has occurred",
            "details": null,
            "path": null,
            "userMessage": "Żądanie zawiera błędne dane. Skontaktuj się z autorem aplikacji."
        }
    ]
 } 

> 

Błędy w tym formacie opisane są następującymi polami:

 * message: Wewnętrzna informacja o błędzie dla programisty. Ułatwia
   zlokalizowanie przyczyny problemu.
 * code: Kod błędu reprezentowany jako string. Na jego podstawie aplikacja może
   zdecydować, czy błąd wymaga specjalnej obsługi (np. pokazania dialogu CAPTCHA
   przy błędnym podaniu hasła logowania).
 * userMessage: Informacja o błędzie przyjazna dla użytkownika aplikacji, w
   większości przypadków obsługa błędu będzie polegać na pokazaniu użytkownikowi
   komunikatu z tego pola.
 * path: Ścieżka do pola zawierającego błąd (pojawia się dla błędów walidacji
   pól i parametrów).
 * details: Szczegóły błędu (jeśli są dostępne).

Drugi format jest ściśle powiązany z uwierzytelnianiem według standardu OAuth2.
Może wystąpić np. kiedy spróbujesz pobrać zasób bez tokenu dostępowego. Więcej
informacji na temat standardu OAuth2 znajdziesz w naszym poradniku oraz w
specyfikacji OAuth2 definiującej poniższy format błędu.

 {
        "error": "unauthorized",
        "error_description": "Full authentication is required to access this resource"
 }

> 

Powyższe pola oznaczają:

 * error: Kod błędu ze specyfikacji OAuth2.
 * error_description: Dodatkowe informacje opisujące błąd w języku naturalnym.
   
   > 

Ten format odpowiedzi występuje wyłącznie w przypadku błędów 401 Unauthorized.




STRONICOWANIE

Do pobrania konkretnej strony listy wynikowej służą dwa parametry:

 * offset: Określa numer porcji zwracanych danych i jest numerowany od 0.
 * limit: Określa liczbę elementów na stronie, nie może być większy niż
   maksymalny limit obsługiwany przez zasób.

Przykład pobrania pierwszej paczki ofert:

 GET /sale/offers?limit=100&offset=0

> 

Przykład pobrania kolejnej paczki ofert:

 GET /sale/offers?limit=100&offset=100

> 


FILTROWANIE

Zasoby dostepne w API mogą realizować filtrowanie - polega ono na przekazaniu w
parametrach umieszczonych w adresie zasobu nazw pól, które biorą udział w
filtrowaniu.

Przykład wyświetlenia listy tylko aktywnych ofert:

 GET /sale/offers?publication.status=ACTIVE

> 


SORTOWANIE

Aby uruchomić wyszukiwanie z sortowaniem, przy wywołaniu zasobu należy przekazać
dodatkowo parametr sort (zakładając, że dany zasób obsługuje sortowanie jego
listy wynikowej). Jeżeli wynik sortowania ma zostać odwrócony, nazwę pola należy
poprzedzić myślnikiem. Jeśli wynik ma być posortowany po więcej niż jednym polu,
w parametrze należy przekazać listę pól rozdzielonych przecinkami.

Przykład pobrania listy ofert uszeregowanych rosnąco według liczby przedmiotów:

 GET /sale/offers?sort=stock.sold

> 

Przykład pobrania listy ofert uszeregowanych malejąco według liczby przedmiotów:

 GET /sale/offers?sort=-stock.sold

> 

Przykład pobrania listy ofert uszeregowanych malejąco według sprzedanej liczby
przedmiotów, a następnie rosnąco według dostępnej liczby przedmiotów:

 GET /sale/offers?sort=-stock.sold,stock.available

> 


DATA I CZAS

Wszystkie pola daty i czasu prezentowane są w standardzie ISO 8601:

 YYYY-MM-DDTHH:MM:SSZ

> 

Pomiędzy datą, jaką prezentujemy w Moim Allegro a REST API, występuje różnica 1
(czas zimowy) lub 2 (czas letni) godzin ze względu na różne strefy czasowe:

 * REST API: +00:00Z - “Czas Zulu”, czas uniwersalny;
 * Moje Allegro: +01:00 lub +02:00 - lokalna strefa czasowa.
   
   > 

Niektóre pola, np. "handlingTime" lub "duration" wymagają, abyś podał czas w
określonej formie - przykładowo: P3D (3 dni); P5D (5 dni); P7D (7 dni). Zanim
uzupełnisz strukturę sprawdź w dokumentacji danego zasobu jakie są dostępne
wartości w danym polu.




CENA I WALUTA

Cena i waluta przekazywane i zwracane są w postaci dwóch pól:

 * amount: Łańcuch znaków (string) wyrażający wartość liczbową – cenę.
 * currency: Trzyliterowy kod waluty, zgodny ze standardem ISO 4217.

Przykład:

 {
  "buyNowPrice": {
    "amount": "10.23",
    "currency": "PLN"
  }
 }

> 


IDENTYFIKATORY ZASOBÓW

API zwraca identyfikatory zasobów zawsze w postaci łańcuchów znaków, w
większości przypadków w formacie UUID. Zalecamy przechowanie identyfikatorów
właśnie w stringach, nawet jeśli API zwróci jako identyfikator liczbę w
cudzysłowach, ponieważ w przyszłości może to ulec zmianie.

Przykład:

 "bg645d84-75b4-431b-adb2-eb6b9e546059"

> 

Jeśli korzystasz z takich zasobów, które wymagają {commandId}, jak na przykład
zasób do grupowej edycji ofert - PUT
/sale/offer-modification-commands/{commandId} w polu commandId wskaż
identyfikator pod jakim zapiszemy to polecenie.



CommandId to identyfikator danego requesta, na jego podstawie sprawdzisz stan
realizacji twojego żądania. Wykorzystaj do tego odpowiedni zasób, np. GET
/sale/offer-modification-commands/{commandId}.

Pamiętaj, aby identyfikator polecenia był unikatowy. Wymagamy identyfikatorów w
standardzie UUID.

Więcej na ten temat znajdziesz tutaj.


OGRANICZENIE LICZBY ZAPYTAŃ (LIMITY)

W usłudze Allegro REST API (produkcyjnej oraz testowej) obowiązuje główny limit
nakładany na Client ID (lub Software Statement ID w przypadku DCR) - 9000
zapytań na minutę.

Gdy przekroczysz limit:

 * na minutę zablokujemy twój Client ID,
 * zwrócimy odpowiedź ze statusem: 429 Too Many Requests.

Po upływie wskazanego czasu automatycznie przywrócimy dostęp do usługi dla
twojego Client ID.

Dla niektórych zasobów stosujemy dodatkowe, niższe limity liczby żądań. W takich
przypadkach informacje o dodatkowym limicie znajdziesz w opisie zasobu w
dokumentacji REST API Allegro.

LEAKY BUCKET

Dla wybranych zasobów REST API stosujemy dodatkowy mechanizm, który ogranicza
liczbę zapytań dla danego użytkownika (user.id). Wykorzystujemy algorytm Leaky
Bucket. Gdy użytkownik przekroczy dozwoloną liczbę wywołań na minutę (RPM),
wydłużamy czas odpowiedzi. W przypadku zbyt dużej liczby równoległych zapytań w
imieniu tego samego użytkownika serwer odpowie błędem HTTP: 429 Too Many
Requests.


ŚRODOWISKO TESTOWE

CZYM JEST SANDBOX?

Allegro Sandbox to środowisko testowe. Możesz na nim bezpiecznie testować 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 (https://allegro.pl.allegrosandbox.pl),
 * 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.

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. Jeżeli masz
problem z aktywacją konta, skontaktuj się z nami na naszym forum.

Różnice między produkcyjnym a testowym REST API:

Produkcja:

 * Adres wywołania metod - https://api.allegro.pl/
 * Rejestracja aplikacji - https://apps.developer.allegro.pl/
 * Adres do autoryzacji - https://allegro.pl/auth/oauth/

Sandbox:

 * Adres wywołania metod - https://api.allegro.pl.allegrosandbox.pl/
 * Rejestracja aplikacji - https://apps.developer.allegro.pl.allegrosandbox.pl/
 * Adres do autoryzacji - https://allegro.pl.allegrosandbox.pl/auth/oauth/
   
   > 

 * Przestrzegaj zasad, które obowiązują w naszym serwisie testowym.
 * Pamiętaj o odpytywaniu odpowiedniego adresu wywoływania zasobów.
 * Na środowisku testowym obowiązują takie same limity liczby zapytań, jak w
   serwisie produkcyjnym.
 * Przerwy serwisowe zapowiadamy na stronie z aktualnościami.
 * Na środowisku testowym usuniemy dodane przez ciebie zdjęcia po 7 dniach.
 * Raz na kwartał aktualizujemy listę parametrów i kategorii. Usuwamy wtedy
   wszystkie oferty z Sandboxa.
 * Powiadomienia e-mail wysłane w ramach serwisu testowego mają tytuł "Message
   from WebAPI Sandbox environment", a sama treść powiadomienia załączona jest w
   pliku .eml w wiadomości.




ŚRODOWISKO TESTOWE - REGULAMIN

ZASADY KORZYSTANIA Z TESTOWEJ WERSJI INTERFEJSU PROGRAMISTYCZNEGO SERWISU
ALLEGRO

 1.  W ramach strony allegro.pl.allegrosandbox.pl masz możliwość nieodpłatnego
     testowania interfejsu programistycznego Serwisu Allegro (REST API) w ramach
     jednego środowiska (dalej “Usługa”).
 2.  Usługa świadczona jest przez Allegro sp. z o.o. z siedzibą w Poznaniu, przy
     ul. Wierzbięcice 1B, 61-569 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: 40 000 000 złotych, posiadająca numer
     identyfikacji podatkowej NIP 525-26-74-798, REGON 365331553 (dalej
     “Spółka”).
 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 Spółkę.
 5.  Spółka informuje, co rozumiesz i akceptujesz, iż dane w ramach Usługi nie
     podlegają żadnej formie kopii zapasowych.
 6.  Spółka 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. Działania, które możesz
     przeprowadzać to wyłącznie testy systemów bezpieczeństwa, jednakże pod
     warunkiem, że będą zgodne z naszym programem Bug Bounty
     (hackerone.com/allegro).
 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. Spółka 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: 26.10.2020 r.

--------------------------------------------------------------------------------

Zgłoś błąd lub zasugeruj zmianę

Czy ten artykuł był dla Ciebie przydatny?

Tak Nie