Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetCatsData

Ostatnia zmiana: 07.03.2013 r.
Dostępność:
Metoda pozwala na pobranie pełnego drzewa kategorii dostępnych we wskazanym kraju.

  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. 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

$dogetcatsdata_request = array(
   'country-id' => 1,
   'local-version' => 0,
   'webapi-key' => 'g2fe408289'
);

  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

$dogetcatsdata_response = array(
   'cats-list' => array(
      array(
         'cat-id' => 26013,
         'cat-name' => 'Antyki i Sztuka',
         'cat-parent' => 0,
         'cat-position' => 0,
         'cat-is-product-catalogue-enabled' => 0),
      array(...),
      array(
         'cat-id' => 8999,
         'cat-name' => 'Wzmacniacze i kolumny',
         'cat-parent' => 5564,
         'cat-position' => 6,
         'cat-is-product-catalogue-enabled' => 0),
      array(...),
      array(
         'cat-id' => 19393,
         'cat-name' => 'Nokia',
         'cat-parent' => 19357,
         'cat-position' => 5,
         'cat-is-product-catalogue-enabled' => 0),
      array(...)),
   '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.