Službu doporučujeme využívat pomocí GovData SDK. SDK vám umožňují rychlou integraci a chrání vaši investici před změnami v nízkoúrovňovém RESTful API.
Získejte vlastní klíč pro přístup do API registrací v GovData.
GovData zpřístupňují následující datasety:
- Subjekty obchodního a živnostenského rejstříku
- Registr plátců DPH včetně jejich spolehlivosti a bankovních účtů (součástí subjektů)
- Datové schránky (součástí subjektů)
- Adresní místa
GovData umožňují přístup k datům dvojím způsobem, pomocí klíčů nebo vyhledáváním. Vyhledávání vrací stránkované výsledky a omezenou množinu informací. Přístup pomocí klíčů (id) slouží k získání úplného záznamu, například na základě předchozího vyhledávání.
Data lze v systému vyhledávat pomocí textového řetězce nebo geolokačních údajů ve formátu GPS.
Subjekty obchodního a živnostenského rejstříku je možné prohledávat pomocí části jejich názvů nebo pomocí GPS souřadnic. Ukázky vyhledávání subjektů textem nebo GPS souřadnicemi.
Adresní místa je možné vyhledávat pomocí části jejich textu nebo pomocí jejich GPS souřadnic. Ukázky vyhledávání adresních míst textem nebo GPS souřadnicemi.
Přístup k datům pomocí klíče (id) slouží k rychlému získání úplného záznamu. Ukázky přístupu k subjektu klíčem a k adrese klíčem.
Stav aktualizace jednotlivých datasetů je možné získat voláním API. Výsledek obsahuje informace o poslední aktualizaci každého datasetu a frekvenci aktualizací. Ukázka získání stavu GovData datasetů.
GovData API funguje ve dvou režimech a vyžaduje identifikaci uživatelů. Režim API demo nebo prod je součástí URI a přístupový klíč se zasílá jako hodnota HTTP hlavičky X-Api-Key. Sdílený režim demo a výchozí klíč slouží jako výchozí konfigurace SDK. Výchozí konfigurace SDK vám umožňuje anonymně zkoušet SDK a zpřístupňuje GovData API testovacím systémům. Druhým režimem je prod vyžadující použití klíče, který obdržíte po registraci v GovData.
Příkladem pro autentizaci je volání v režimu demo pomocí příkazu cURL:
curl -H 'X-Api-Key: ZX1Ap4RUDY2VisBOu2P0e4sEvh2LhWh4Cx8lqoO6' 'https://api.govdata.cz/v1/demo/entity/00006947'