Jak stránkovat výsledky, filtrovat podle štítků nebo časového období a na co si dát pozor při hromadném volání BizMachine API.
Vybrané API endpointy (kolekční endpointy) podporují hromadné volání — můžete jedním dotazem získat data pro více firem najednou. Kompletní přehled endpointů a parametrů najdete v API dokumentaci.
Stránkování výsledků
API vrací maximálně 250 záznamů na stránku. K dalším stránkám se dostanete parametrem Offset:
GET /cz/v3/events?Company.NationalIn=12345678&Offset=0 (1. stránka)
GET /cz/v3/events?Company.NationalIn=12345678&Offset=250 (2. stránka)
GET /cz/v3/events?Company.NationalIn=12345678&Offset=500 (3. stránka)
Celkový počet záznamů najdete v odpovědi v poli paging.totalItems. Stránkujte, dokud nezpracujete všechny záznamy.
Pozor: Používejte parametr Offset, ne Page. Parametr Page API tiše ignoruje a vrací stále první stránku — výsledkem jsou duplicitní data bez jakékoliv chybové hlášky.
Nejčastěji používané parametry
Tag.UID — filtrování podle štítku
API vrátí data pouze pro firmy v zadaném štítku (seznamu). Štítek můžete vytvořit přímo v Prospectoru jako "Seznam firem", nebo ho spravovat kompletně přes API.
Typický postup: přes API nahrajte seznam firem do štítku a pak provolejte libovolný datový endpoint s parametrem Tag.UID — dostanete data jen pro tyto firmy.
API vrátí pouze záznamy změněné ve sledovaném období. Typicky stačí jednorázově naimportovat všechna data a pak pravidelně dotazovat jen přírůstek za poslední období.
Na co si dát pozor
Neznámé parametry API tiše ignoruje. Pokud použijete špatný název parametru (překlep, nesprávný formát), API nevrátí chybu — vrátí nefiltrované výsledky. Když dostáváte neočekávaně velký počet záznamů, zkontrolujte názvy parametrů.
Vozidla používají jiný identifikátor. Endpoint vehicles nepoužívá Company.NationalIn, ale Company.UniqueId ve formátu {dataset}-company-{ico} (např. cz-company-12345678). Podrobnosti viz Přehled API endpointů.
Limit 250 na stránku platí pro všechny kolekční endpointy. Tato hodnota (maxPageSize) je uvedena v odpovědi v sekci paging.