API – zoznamy, filtrovanie a stránkovanie
Niektoré metódy API vracajú zoznam položiek (napr. príjmy, objednávky, pohyby na províznom účte).
Tieto metódy majú spoločné správanie – rovnaké vstupné parametre pre filtrovanie a stránkovanie, ako aj jednotnú výstupnú štruktúru.
Výstupné údaje
Odpoveď metód, ktoré vracajú zoznam, vždy obsahuje nasledujúce položky:
- výsledky – pole objektov s jednotlivými položkami zoznamu
- stránka – číslo aktuálnej stránky
- count – počet položiek vrátených 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 vo výsledkoch nie sú tu uvedené:
{ "results": [ ... ], "page": 1, "count": 10, "filteredCount": 18, "totalCount": 624, "requestId": "..." }
Celkovo je 624 položiek (napr. objednávok),
z ktorých 18 zodpovedá aktuálnym filtrom a prvých
10 položiek bolo vrátených (strana 1, veľkosť strany 10).
Filtrovanie
K svojej požiadavke môžete pridať jeden alebo viacero filtrov. Filtre sa odosielajú ako parametre GET a používajú sa na výber položiek, 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 ako zadaná hodnota (vhodné na načítanie nových položiek)
lastID je ideálny, ak pravidelne načítate nové položky
od posledného známeho ID a nechcete sa zaoberať spätným stránkovaním.
Príklad – objednávky s ID vyššími ako 1234
https://api.wedos.as/partner/orders?lastID=1234
Stránkovanie
Zoznamy môžu byť rozdelené na stránky, t. j. vrátené v konkrétnych dávkach. API umožňuje vrátenie maximálne 1 000 položiek na jedno volanie.
- stránka – predvolené nastavenie 1
- počet – predvolené nastavenie 100
- počet – maximálne 1000
Ak chcete len malý náhľad (napr. 10 položiek), nastavte count=10.
Pri sťahovaní väčších dávok buďte rozumní (napr. 100-300), aby ste zbytočne nepreťažili koncový bod.
Príklad – 10 položiek na druhej strane
Vrátené položky 11 až 20:
https://api.wedos.as/partner/orders?stránka=2&počet=10
Ak si nie ste istí
Ak si nie ste istí, ako filtrovať alebo stránkovať v konkrétnej metóde, môžete využiť verejné diskusné fórum alebo nám napísať priamo na adresu:
affiliate@wedos.com.