Přehled API endpointů
Orientační přehled BizMachine API endpointů — které verze použít, jak se liší typy volání a kde najít detailní specifikaci.
Kompletní technická specifikace endpointů (parametry, formát odpovědí, příklady) je v API dokumentaci. Tento článek vám pomůže se v endpointech rychle zorientovat — který použít, v jaké verzi a na co si dát pozor.
Přehledová tabulka endpointů
BizMachine API obsahuje endpointy ve dvou verzích (v3 a v4). Ne každý endpoint je dostupný v obou verzích a některé se ve formátu odpovědi liší. Tabulka níže shrnuje doporučenou verzi pro každý endpoint.
aggregated-data
v4
jednofirmové
Základní info, kontakty, indikátory, NACE, souhrn metrik
metrics
v3
jednofirmové
55 metrik s víceletými časovými řadami (finance, vozový park, zaměstnanci, veřejné zakázky)
owners
v4
jednofirmové
Vlastnická struktura s historií a podíly
connected-companies
v3
jednofirmové
Propojené firmy (mateřské, dceřiné, přes statutáry)
risks
v4
jednofirmové
Rizikové signály (insolvence, exekuce, daňové nedoplatky)
contacts
v4
jednofirmové
Telefon, e-mail, web, LinkedIn profily klíčových osob
financials
v3
kolekce
Detailní účetní výkazy (rozvaha, výsledovka) po řádcích
vehicles
v4
kolekce
Vozidla s vlastnickými řetězci, stránkováno po 250
events
v3
kolekce
Firemní události (změny v rejstříku, podání)
contracts
v3
kolekce
Veřejné zakázky z Registru smluv
subsidies
v3
kolekce
Přijaté dotace
indicators
v3
jednofirmové
Detailní BizMachine indikátory (aktivita, růst, dosažitelnost)
statutories
v3
kolekce
Statutární zástupci (aktuální i historičtí)
job-postings
v3
kolekce
Aktuální pracovní nabídky
locations
v3
kolekce
Provozovny a sídla
bank-accounts
v4
jednofirmové
Registrované bankovní účty
eshops
v3
kolekce
E-shopová přítomnost
Tip: Endpoint
metricsje pravděpodobně nejhodnotnější jednotlivý endpoint pro firemní analýzu — kombinuje finanční data, vozový park, zaměstnanost i veřejné zakázky v jednom volání s víceletou historií. Viz Endpoint metrics — přehled metrik.
Poznámka: Tabulka pokrývá datové endpointy pro čtení firemních údajů. Kompletní seznam včetně endpointů pro správu štítků, vyhledávání a dalších operací najdete v API dokumentaci.
Dva typy volání
API rozlišuje dva vzory volání. Typ závisí na konkrétním endpointu:
Jednofirmové endpointy
IČO se předává přímo v URL cestě:
Kolekční endpointy
IČO se předává jako query parametr. Výsledky mohou být stránkované:
Pozor — vozidla jsou výjimka: Endpoint
vehiclesnepoužíváCompany.NationalIn, aleCompany.UniqueIdve formátu{dataset}-company-{ico}(napříkladcz-company-12345678). Pokud použijete špatný parametr, API nevrátí chybu — vrátí nefiltrované výsledky. Podrobnosti v API dokumentaci.
Dostupné datové sady
BizMachine API pokrývá pět trhů. Dataset se předává přímo v URL:
cz
Česká republika
sk
Slovensko
hu
Maďarsko
pl
Polsko
de
Německo
Poznámka: Šíře dostupných dat se mezi zeměmi liší. Nejbohatší datové pokrytí nabízíme pro Českou republiku a Slovensko.
Jazyk odpovědí
Jazyk dat v odpovědích lze ovlivnit hlavičkou Accept-Language. Výchozí jazyk je angličtina.
EN
Angličtina (výchozí)
CS
Čeština
SK
Slovenština
Autentizace
Každý API dotaz musí obsahovat hlavičku s vaším API klíčem:
Jak API klíč vygenerovat: Jak si vygeneruji API klíč?
Na co si dát pozor
Několik věcí, které při integraci ušetří čas:
v3 vs v4 — ne každý endpoint funguje v obou verzích. Tabulka výše ukazuje doporučenou verzi. Pokud endpoint ve zvolené verzi neexistuje, API vrátí
UnsupportedApiVersion.Stránkování — kolekční endpointy vracejí max 250 záznamů na stránku. K dalším stránkám se dostanete parametrem
Offset(nePage). Viz Hromadné (BULK) API volání.Neznámé parametry — API tiše ignoruje neznámé query parametry a vrátí nefiltrované výsledky. Pokud dostáváte neočekávaně velký počet záznamů, zkontrolujte správnost názvů parametrů.
Metriky vs aggregated-data —
aggregated-dataobsahuje souhrn ~25 metrik (poslední hodnoty). Samostatný endpointmetricsvrací 55 metrik s kompletní víceletou historií. Podrobnosti viz Endpoint metrics — přehled metrik.
Další informace
Last updated