API – listy, filtrowanie i stronicowanie
Niektóre metody API zwracają listę pozycji (np. wejścia, zamówienia, operacje na koncie prowizyjnym).
Metody te mają wspólne zachowanie – te same parametry wejściowe do filtrowania i stronicowania oraz jednolitą strukturę wyniku.
Dane wyjściowe
Odpowiedź metod zwracających listę zawiera zawsze te pozycje:
- results – tablica obiektów z poszczególnymi pozycjami listy
- page – numer bieżącej strony
- count – liczba zwróconych pozycji w odpowiedzi
- filteredCount – liczba pozycji odpowiadających bieżącym filtrom
- totalCount – łączna liczba pozycji bez filtrów
Przykładowa odpowiedź
Konkretne pozycje w results nie są tu podane:
{ "results": [ ... ], "page": 1, "count": 10, "filteredCount": 18, "totalCount": 624, "requestId": "..." }
Łącznie istnieje 624 pozycji (np. zamówień),
z czego 18 odpowiada bieżącym filtrom, a zwrócono pierwszych
10 pozycji (strona 1, rozmiar strony 10).
Filtrowanie
Do żądania możesz dodać jeden lub więcej filtrów. Filtry przekazuje się jako parametry GET i na ich podstawie wybierane są pozycje, które zwróci API.
- ID – zwróci tylko pozycję o konkretnym ID rekordu
- lastID – zwróci tylko pozycje, których ID jest wyższe niż podana wartość (przydatne do pobierania nowych pozycji)
lastID jest idealny, jeśli regularnie pobierasz nowe pozycje
od ostatniego znanego ID i nie chcesz zajmować się stronicowaniem wstecz.
Przykład – zamówienia z ID wyższym niż 1234
https://api.wedos.as/partner/orders?lastID=1234
Stronicowanie
Listy można stronicować, czyli zwracać tylko w określonych partiach. API umożliwia zwrócenie maksymalnie 1000 pozycji na jedno wywołanie.
- page – domyślnie 1
- count – domyślnie 100
- count – maks. 1000
Gdy chcesz tylko mały podgląd (np. 10 pozycji), ustawisz count=10.
Gdy pobierasz większe partie, trzymaj się rozsądku (np. 100-300), żeby niepotrzebnie nie obciążać endpointu.
Przykład – 10 pozycji na drugiej stronie
Zwróci pozycje od 11 do 20:
https://api.wedos.as/partner/orders?page=2&count=10
Jeśli nie będziesz pewien
Jeśli nie będziesz pewien filtrowania lub stronicowania w konkretnej metodzie, możesz skorzystać z publicznego forum dyskusyjnego albo napisz do nas bezpośrednio na e-mail:
affiliate@wedos.com.