Dokumentace

API pro firmy a adresy

Propojte svůj web s veřejnými daty.

Začněte zde

API poskytuje návrhy firem a adres a základní detail subjektu. Data čte z místního registru regup. Aktuálnost a původ najdete v odpovědi.

Pilotní přístup zatím zřizuje provozovatel. Samoobslužná registrace ještě není otevřena.

Stáhnout OpenAPI →

https://api.regup.eu/v1

Endpointy

Požadavek	Cena
`GET /v1/autocomplete/companies` Vyhledávání firem	0.1 cr
`GET /v1/autocomplete/addresses` Vyhledávání adres	0.1 cr
`GET /v1/companies/{country}/{ico}` Detail firmy nebo organizace	1 cr
`POST /v1/browser-sessions` Vytvoření krátkodobé relace pro web	Bez kreditu
`GET /v1/me/usage` Spotřeba účtu	Bez kreditu

Úspěšný detail vyžaduje oprávnění companies:read. Země je sk nebo cz a IČO má přesně osm číslic včetně počátečních nul.

Autentifikace

Serverový klíč posílejte v hlavičce Authorization. Patří výhradně na váš server; nevkládejte jej do JavaScriptu ani URL.

Authorization: Bearer <SERVER_API_KEY>

Na stránce použijte veřejné client ID projektu a krátkodobou browser relaci. Projekt musí mít povolen konkrétní HTTPS origin. Samotný origin nenahrazuje autentifikaci.

Serverový příklad

Ve svém prostředí nastavte REGUP_API_KEY na vydaný serverový klíč.

curl 'https://api.regup.eu/v1/companies/sk/55345662' \
  --header "Authorization: Bearer ${REGUP_API_KEY}" \
  --header 'Accept: application/json'

Kredity a limity

Výchozí bezplatný pilot má 10 000 kreditů na kalendářní měsíc, společně pro všechny projekty a klíče účtu. Nevyčerpané kredity se nepřenášejí.

Našeptávání stojí 0,1 kreditu za úspěšný požadavek. Základní detail stojí 1 kredit. Výběr výsledku, jehož údaje už návrh obsahuje, další požadavek nepotřebuje.

V odpovědích se používají celé jednotky: 10 jednotek = 1 kredit. Hlavička X-Credits-Charged-Units udává zaúčtovanou cenu. Rychlostní limit platí samostatně od měsíčního přídělu.

Odpovědi a chyby

Úspěšná odpověď obsahuje data a meta: identifikátor požadavku, cenu, zdroje a dostupné informace o aktuálnosti. Zachovejte atribuci, pokud ji podmínky zdroje vyžadují. Bankovní účty DPH nejsou součástí API.

400: Neplatné parametry
401: Chybějící nebo neplatné přihlášení
403: Chybějící oprávnění nebo nepovolený origin
404: Nenalezený detail
409: Nejednoznačná identita subjektu
429: Dosažený rychlostní nebo měsíční limit
503: Dočasná nedostupnost služby

Chybné požadavky se neúčtují. Při opakování po 429 nebo 503 respektujte Retry-After, je-li uvedeno. Při ztrátě spojení po zpracování odpovědi už mohl být úspěšný požadavek zaúčtován.

JavaScript do formulářů

Hotové JavaScriptové knihovny připojíte k vlastnímu formuláři. Ukázky obsahují vložení skriptu i zpracování vybraného výsledku.

Demo firem →

Demo adres →