Popis API

Otevřená data

Co jsou otevřená data?

Otevřená data jsou informace zveřejněné na internetu, které jsou volně dostupné ve strojově čitelné formě. Poskytovat je může státní správa a samospráva, úřady, státní podniky, soukromé firmy i jednotlivci. Mezi otevřenými daty najdeme rejstříky, seznamy, evidence, výpisy z úředních desek, databáze, ekonomické ukazatele, výstupy z měřicích čidel (např. čistota ovzduší, hustota dopravy) a podobně. Zpřístupněných datových sad jsou dnes už tisíce.

Otevřená data musí být publikována v tzv. otevřeném formátu, tedy ve strojově čitelné formě, jejíž specifikace je volně dostupná na internetu. Programátoři tak mohou vyvíjet aplikace, které s otevřenými daty pracují, aniž by za použitý formát museli platit. Mezi nejpoužívanější otevřené formáty patří prostý text, HTML, XML, CSV či sada ODF (ODT, ODS, ODP).

Kde najdu otevřená data?

Otevřená data státní správy a samosprávy jsou dle zákona registrována v Národním katalogu otevřených dat (NKOD), kde je také můžete vyhledávat.

Co je API a k čemu slouží?

API (Application Programming Interface) je rozhraní, které slouží pro komunikaci mezi dvěma programy/aplikacemi. Skrze něj si mohou vyměňovat data a snáze rozšiřovat svoji funkcionalitu například právě o data, která jsou připravena někým jiným – například doplnit mapu města o pozice vozů MHD aktualizované v reálném čase. Otevřená data je možné skrze API libovolně zpracovat a prezentovat třeba ve webové nebo mobilní aplikaci.

Popis JSON služby

Základní informace

Data o informacích zveřejněných na úřední desce Ministerstva vnitra jsou zpracována do formátu JSON. Aktualizace probíhá 1x denně a struktura dat odpovídá otevřené formální normě k úředním deskám.

API je volně založené na principu REST API, ve kterém jsou na jednotlivých koncových bodech s příslušnými HTTP metodami publikované informace ve formátu JSON.

Popis endpointu - Úřední desky

GET https://opendata.mvcr.cz/api/boards

Požadavek

Hlavička:
accept: application/json
Query parametr:
type?: string
Volitelný parametr zapínající filtr na PČR, HZS a MV. Číselník povolených hodnot: pcr, hzs, mv

Odpověď

Status kód 200
Úspěšné volání.
Content-type: application/json Schéma podle OFN.
Status kód 400
Neplatný požadavek.
Zkontrolujte povolené hodnoty query parametrů.
Příklad při neplatné hodnotě parametru type v query: 
{
  "status":400,
  "errorCode":"VALIDATION_ERROR",
  "message":"must be equal to one of the allowed values"
}
Status kód 500
Při zpracování požadavku nastala neočakávaná chyba na straně serveru. Detaily nejsou z bezpečnostních důvodů API vrácené. Je zapotřebí kontaktovat správce služby.

Příklady volání

Formát odeslaných dat

V příkladu je ukázána informace v minimálním zveřejňovaném rozsahu.

Pro více informací a příkladů náhledněte do Otevřené formální normy.