Dokumentácia

API pre firmy a adresy

Prepojte svoj web s verejnými dátami.

Začnite tu

API poskytuje návrhy firiem a adries a základný detail subjektu. Dáta číta z lokálneho registra regup. Aktuálnosť a pôvod nájdete v odpovedi.

Pilotný prístup zatiaľ zriaďuje prevádzkovateľ. Samoobslužná registrácia ešte nie je otvorená.

Stiahnuť OpenAPI →

https://api.regup.eu/v1

Endpointy

Požiadavka	Cena
`GET /v1/autocomplete/companies` Vyhľadávanie firiem	0.1 cr
`GET /v1/autocomplete/addresses` Vyhľadávanie adries	0.1 cr
`GET /v1/companies/{country}/{ico}` Detail firmy alebo organizácie	1 cr
`POST /v1/browser-sessions` Vytvorenie krátkodobej relácie pre web	Bez kreditu
`GET /v1/me/usage` Spotreba účtu	Bez kreditu

Úspešný detail vyžaduje oprávnenie companies:read. Krajina je sk alebo cz a IČO má presne osem číslic vrátane úvodných núl.

Autentifikácia

Serverový kľúč posielajte v hlavičke Authorization. Patrí výhradne na váš server; nevkladajte ho do JavaScriptu ani URL.

Authorization: Bearer <SERVER_API_KEY>

Na stránke použite verejný client ID projektu a krátkodobú browser reláciu. Projekt musí mať povolený konkrétny HTTPS origin. Samotný origin nenahrádza autentifikáciu.

Serverový príklad

Vo svojom prostredí nastavte REGUP_API_KEY na vydaný serverový kľúč.

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

Kredity a limity

Predvolený bezplatný pilot má 10 000 kreditov na kalendárny mesiac, spoločne pre všetky projekty a kľúče účtu. Nevyčerpané kredity sa neprenášajú.

Našepkávanie stojí 0,1 kreditu za úspešnú požiadavku. Základný detail stojí 1 kredit. Výber výsledku, ktorého údaje už návrh obsahuje, ďalšiu požiadavku nepotrebuje.

V odpovediach sa používajú celé jednotky: 10 jednotiek = 1 kredit. Hlavička X-Credits-Charged-Units udáva zaúčtovanú cenu. Rýchlostný limit platí samostatne od mesačného prídelu.

Odpovede a chyby

Úspešná odpoveď obsahuje data a meta: identifikátor požiadavky, cenu, zdroje a dostupné informácie o aktuálnosti. Zachovajte atribúciu, ak ju podmienky zdroja vyžadujú. Bankové účty DPH nie sú súčasťou API.

400: Neplatné parametre
401: Chýbajúce alebo neplatné prihlásenie
403: Chýbajúce oprávnenie alebo nepovolený origin
404: Nenájdený detail
409: Nejednoznačná identita subjektu
429: Dosiahnutý rýchlostný alebo mesačný limit
503: Dočasná nedostupnosť služby

Chybné požiadavky sa neúčtujú. Pri opakovaní po 429 alebo 503 rešpektujte Retry-After, ak je uvedené. Pri strate spojenia po spracovaní odpovede už mohla byť úspešná požiadavka zaúčtovaná.

JavaScript do formulárov

Hotové JavaScriptové knižnice pripojíte k vlastnému formuláru. Ukážky obsahujú vloženie skriptu aj spracovanie vybraného výsledku.

Demo firiem →

Demo adries →