Allegro WebAPI

Interfejs programistyczny platformy Allegro

doGetSiteJournal

Ostatnia zmiana: ---
Dostępność:
Metoda pozwala na pobranie informacji z dziennika zdarzeń na temat zdarzeń (rozpoczęcie, zakończenie, złożenie oferty kupna w licytacji, zakup przez Kup Teraz!, zmiana w ofercie, odwołanie oferty kupna w licytacji) w ofertach zalogowanego użytkownika (dane zwracane są tylko dla ofert użytkownika utworzonych przez niego w kraju do którego jest on zalogowany w momencie wywoływania metody) lub we wszystkich ofertach w serwisie. Zwracanych jest zawsze 100 najnowszych zdarzeń (zaczynając od punktu podanego w parametrze starting-point), posortowanych rosnąco po czasie ich wystąpienia. W przypadku przekazania w parametrze starting-point wartości 0, zwróconych zostanie 100 chronologicznie najwcześniejszych zdarzeń, do których dostęp ma jeszcze dziennik zdarzeń (zazwyczaj są to dane z ostatnich 8-9 dni). Aby sterować pobieraniem kolejnych porcji danych (tak aby dotrzeć do danych najświeższych), należy w parametrze starting-point przekazywać wartość row-id ostatniego (setnego) elementu, zwracanego w ramach danego wywołania i robić to sukcesywnie, dopóki w wyniku wywołania nie otrzyma się porcji danych mniejszej niż 100 elementów (co będzie świadczyło, że otrzymane dane są danymi najświeższymi).

  1. session-handle | string | wymagany
    Identyfikator sesji użytkownika, uzyskany za pomocą metody doLogin(Enc).
  2. starting-point | long | niewymagany
    Punkt startu, pozwalający na sterowanie pobieraniem kolejnych porcji danych dot. informacji o zdarzeniach związanych z ofertami (jego wartość zwracana jest w polu row-id struktury site-journal-array).
  3. info-type | int | niewymagany
    Zakres zwracanych informacji (0 - zwracane są tylko dane dot. zdarzeń w ofertach zalogowanego użytkownika, 1 - zwracane są dane dot. zdarzeń we wszystkich ofertach w serwisie; domyślnie ustawiana jest wartość 0).



Orientacyjna struktura wywołania metody

$dogetsitejournal_request = array(
   'session-handle' => '22eb99326c6be29aa16d07d622bcfbcbee94ad54846f2f4e03_1',
   'starting-point' => 2865837087,
   'info-type' => 0
);

  1. site-journal-array | SiteJournal[]
    Tablica struktur zawierających informacje o zdarzeniach związanych z ofertami.
    1. row-id | long
      Identyfikator rekordu zawierającego informację o zdarzeniu.
    2. item-id | long
      Identyfikator oferty.
    3. change-type | string
      Typ zdarzenia (start - rozpoczęcie oferty; end - zakończenie oferty; bid - złożenie oferty kupna w licytacji; now - zakup przez Kup Teraz!; change - zmiana w ofercie; cancel_bid - odwołanie oferty kupna w licytacji przez sprzedającego lub administratora).
    4. change-date | long
      Data zapisania zdarzenia w dzienniku (w formacie Unix time).
    5. current-price | float
      Aktualna cena przedmiotu w licytacji (lub 0 jeżeli oferta jest typu Kup Teraz!).
    6. item-seller-id | long
      Identyfikator sprzedającego.



Orientacyjna struktura odpowiedzi serwera

$dogetsitejournal_response = array(
   'site-journal-array' => array(
      array(
         'row-id' => 2869399784,
         'item-id' => 975967833,
         'change-type' => 'start',
         'change-date' => 1269603383,
         'current-price' => 0,
         'item-seller-id' => 4109848),
      array(
         'row-id' => 2869434550,
         'item-id' => 975967833,
         'change-type' => 'change',
         'change-date' => 1269603891,
         'current-price' => 0,
         'item-seller-id' => 4109848),
      array(
         'row-id' => 2869460429,
         'item-id' => 975967833,
         'change-type' => 'end',
         'change-date' => 1269604287,
         'current-price' => 0,
         'item-seller-id' => 4109848))
);


  • ERR_INVALID_INFO_TYPE
    Niepoprawna wartość dla zakresu zwracanych informacji.
  • ERR_NO_SESSION / ERR_SESSION_EXPIRED
    Niepoprawny identyfikator sesji lub sesja wygasła.
  • ERR_WEBAPI_KEY_INACTIVE
    Klucz WebAPI na którym została wygenerowana sesja został zdezaktywowany (jego właściciel nie zaakceptował warunków Regulaminu WebAPI).
  • ERR_WEBAPI_NOT_AVAIL
    Problemy z usługą Allegro WebAPI.