Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetCatsDataLimit

Ostatnia zmiana: 07.03.2013 r.
Dostępność:
Metoda pozwala na pobranie w porcjach pełnego drzewa kategorii dostępnych we wskazanym kraju. Domyślnie zwracanych jest 50 pierwszych kategorii. Rozmiar porcji pozwala regulować parametr package-element, a sterowanie pobieraniem kolejnych porcji danych umożliwia parametr offset.

  1. country-id | int | wymagany
    Identyfikator kraju (listę identyfikatorów krajów uzyskać można za pomocą metody doGetCountries).
  2. local-version | long | niewymagany
    Parametr zdezaktualizowany (należy przekazać dowolną wartość, odpowiednią dla typu parametru).
  3. webapi-key | string | wymagany
    Klucz WebAPI użytkownika.
  4. offset | int | niewymagany
    Parametr pozwalający na sterowanie pobieraniem kolejnych porcji danych (numery porcji indeksowane są od 0).
  5. package-element | int | niewymagany
    Parametr pozwalający na określenie rozmiaru porcji zwracanych danych (zakres 1-5000; domyślnie 5000).
  6. onlyLeaf | boolean | niewymagany
    Jeśli ustawisz jego wartość na true / 1 (boolean), w odpowiedzi otrzymasz tylko kategorie najniższego rzędu.



Orientacyjna struktura wywołania metody

$dogetcatsdatalimit_request = array(
   'country-id' => 1,
   'local-version' => 0,
   'webapi-key' => 'g2fe408289',
   'offset' => 1,
   'package-element' => 2
);

  1. cats-list | CatInfoType[]
    Tablica struktur zawierających informacje o każdej kategorii.
    1. cat-id | int
      Identyfikator kategorii.
    2. cat-name | string
      Nazwa kategorii.
    3. cat-parent | int
      Identyfikator kategorii nadrzędnej (lub 0 dla kategorii głównych).
    4. cat-position | int
      Pozycja kategorii wobec innych kategorii tego samego rzędu (indeksowana od 0).
    5. cat-is-product-catalogue-enabled | int
      Pole zdezaktualizowane (zawsze będzie zwracać 0).
    6. isLeaf | boolean
      Dla kategorii najniższego rzędu, otrzymasz true / 1 (boolean).
  2. ver-key | long
    Wartość klucza wersji odpowiednia dla wybranego kraju i przekazanego klucza WebAPI.
  3. ver-str | string
    Wersja komponentu struktury drzewa kategorii odpowiednia dla przekazanego klucza WebAPI.



Orientacyjna struktura odpowiedzi serwera

$dogetcatsdatalimit_response = array(
   'cats-list' => array(
      array(
         'cat-id' => 19732,
         'cat-name' => 'Biżuteria i Zegarki',
         'cat-parent' => 0,
         'cat-position' => 2,
         'cat-is-product-catalogue-enabled' => 0),
      array(
         'cat-id' => 73973,
         'cat-name' => 'Delikatesy',
         'cat-parent' => 0,
         'cat-position' => 3,
         'cat-is-product-catalogue-enabled' => 0)),
   'ver-key' => 16551276,
   'ver-str' => '1.2.63'
);
 

  • ERR_INPUT_COUNTRY_ERROR
    Niepoprawny identyfikator kraju (wskazany kraj nie jest obsługiwany lub w parametrze przekazano zerową/pustą wartość).
  • ERR_NO_DATABASE
    Problemy z bazą danych Allegro.
  • ERR_WEBAPI_EXPIRED
    Data ważności klucza WebAPI została przekroczona.
  • ERR_WEBAPI_KEY
    Niepoprawna wartość klucza WebAPI lub klucz został zablokowany.
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI został zdezaktywowany (nie zaakceptowano warunków Regulaminu WebAPI).
  • ERR_WEBAPI_NOT_AVAIL
    Problemy z usługą Allegro WebAPI.