API – zoznamy, filtrovanie a stránkovanie
Niektoré API metódy vracajú zoznam položiek (napr. príchody, objednávky, pohyby na províznom účte).
Tieto metódy majú spoločné správanie – rovnaké vstupné parametre na filtrovanie a stránkovanie a takisto jednotnú štruktúru výstupu.
Výstupné dáta
Odpoveď metód, ktoré vracajú zoznam, obsahuje vždy tieto položky:
- results – pole objektov s jednotlivými položkami zoznamu
- page – číslo aktuálnej stránky
- count – počet vrátených položiek v odpovedi
- filteredCount – počet položiek zodpovedajúcich aktuálnym filtrom
- totalCount – celkový počet položiek bez filtrov
Príklad odpovede
Konkrétne položky v results tu nie sú uvedené:
{ "results": [ ... ], "page": 1, "count": 10, "filteredCount": 18, "totalCount": 624, "requestId": "..." }
Celkovo existuje 624 položiek (napr. objednávok),
z toho 18 zodpovedá aktuálnym filtrom a vrátených bolo prvých
10 položiek (stránka 1, veľkosť stránky 10).
Filtrovanie
Do požiadavky môžeš pridať jeden alebo viac filtrov. Filtre sa odovzdávajú ako GET parametre a podľa nich sa vyberú položky, ktoré API vráti.
- ID – vráti iba položku s konkrétnym ID záznamu
- lastID – vráti iba položky, ktorých ID je vyššie než zadaná hodnota (vhodné na načítavanie nových položiek)
lastID je ideálny, ak pravidelne doťahuješ nové položky
od posledného známeho ID a nechceš riešiť stránkovanie dozadu.
Príklad – objednávky s ID vyšším než 1234
https://api.wedos.as/partner/orders?lastID=1234
Stránkovanie
Zoznamy možno stránkovať, teda vracať len po určitých dávkach. API umožňuje vrátiť maximálne 1000 položiek na jedno volanie.
- page – predvolene 1
- count – predvolene 100
- count – max 1000
Keď chceš len malý náhľad (napr. 10 položiek), dáš count=10.
Keď sťahuješ väčšie dávky, drž sa rozumne (napríklad 100-300), aby si zbytočne nezaťažoval endpoint.
Príklad – 10 položiek na druhej stránke
Vráti položky 11 až 20:
https://api.wedos.as/partner/orders?page=2&count=10
Keď si nebudeš istý
Ak si nebudeš istý filtrovaním alebo stránkovaním v konkrétnej metóde, môžeš využiť verejné diskusné fórum, prípadne nám napíš priamo na e-mail:
affiliate@wedos.com.