API – listy, filtrowanie i paginacja

Niektóre metody API zwracają listę pozycji (np. wpływy, zamówienia, ruchy na koncie prowizyjnym).
Metody te mają wspólne zachowanie – te same parametry wejściowe do filtrowania i paginacji, a także jednolitą strukturę wyjściową.

Ta strona wyjaśnia, jak czytać odpowiedzi, jak filtrować i jak paginować.

Dane wyjściowe

Odpowiedź metod, które zwracają listę, zawsze zawiera następujące elementy:

results – pole obiektów z poszczególnymi pozycjami listy
page – numer bieżącej strony
count – liczba elementów zwróconych w odpowiedzi
filteredCount – liczba pozycji odpowiadających aktualnym filtrom
totalCount – całkowita liczba pozycji bez filtrów

Przykładowa odpowiedź

Konkretne pozycje w wynikach nie są tutaj podane:

{
  "results": [
    ...
  ],
  "page": 1,
  "count": 10,
  "filteredCount": 18,
  "totalCount": 624,
  "requestId": "..."
}

Co to oznacza w praktyce:
W sumie istnieje 624 pozycji (np. zamówień),
z czego 18 odpowiada aktualnym filtrom i zwrócono pierwsze
10 pozycji (strona 1, rozmiar strony 10).

Filtrowanie

Do żądania można dodać jeden lub więcej filtrów. Filtry są przekazywane jako parametry GET i na ich podstawie wybierane są pozycje, które zwraca API.

Filtry podstawowe

ID – zwraca tylko pozycję o określonym identyfikatorze rekordu
lastID – zwraca tylko pozycje, których identyfikator jest wyższy niż podana wartość (odpowiednie do ładowania nowych pozycji)

Wskazówka

lastID jest idealnym rozwiązaniem, jeśli regularnie pobierasz nowe pozycje
od ostatniego znanego identyfikatora i nie chcesz zajmować się paginacją wsteczną.

Przykład – zamówienia o numerze identyfikacyjnym powyżej 1234

https://api.wedos.as/partner/orders?lastID=1234

Stronowanie

Listy można paginować, czyli zwracać tylko w określonych partiach. API umożliwia zwrot maksymalnie 1000 pozycji na jedno wywołanie.

Wartości domyślne

strona – domyślna 1
count – domyślnie 100
liczba – maksymalnie 1000

Do czego to służy?

Jeśli chcesz tylko mały podgląd (np. 10 pozycji), wpisz count=10.
Jeśli pobierasz większe partie, zachowaj rozsądek (np. 100-300), aby nie obciążać niepotrzebnie punktu końcowego.

Przykład – 10 pozycji na drugiej stronie

Zwraca pozycje od 11 do 20:

https://api.wedos.as/partner/orders?page=2&count=10

Jeśli nie jesteś pewien

Jeśli nie masz pewności co do filtrowania lub paginacji w konkretnej metodzie, możesz skorzystać z publicznego forum dyskusyjnego lub napisać do nas bezpośrednio na adres e-mail:
affiliate@wedos.com.