integrační dokumentace.md

Integrační dokumentace Národního katalogu otevřených dat

Definice pojmů a zkratek

NKOD

Národní katalog otevřených dat

ISDS

Informační systém datových schránek

LKOD

Lokální katalog otevřených dat

RDF

Resource Description Framework

Reference

Čtenář této příručky by měl být obeznámen s:

• instalační dokumentace
• aplikační dokumentace
• uživatelská dokumentace

Architektura

Architektura viz aplikační dokumentace.

Komunikační rozhraní

Komunikace s NKOD probíhá výhradně přes web protokolem HTTPS. Mějme <base> jako základ URL, na kterém běží NKOD. V produkčním prostředí bude <base> data.gov.cz, v testovacím pak pod-test.dia.gov.cz.

Uživatelská rozhraní

Pro uživatele nabízí NKOD následující rozhraní

1. SPARQL endpoint na https://<base>/sparql
2. Triple pattern fragments endpoint na https://<base>/tpf
3. GraphQL endpoint na https://<base>/graphql
4. Webové uživatelské rozhraní pro prohlížení záznamů na https://<base>

Rozhraní používaná NKOD

NKOD pak komunikuje pomocí následujících rozhraní:

1. NKOD-ISDS komunikuje s ISDS pomocí webové služby ISDS a stahuje došlé registrační záznamy LKOD a jednotlivých datových sad.
2. NKOD přijímá volání z GitHub webhooků na https://<base>/deploy/<název-webhooku>.php
3. NKOD přistupuje k webové službě Seznamů držitelů datových schránek pro identifikaci majitele datové schránky, ze které přišel registrační záznam
4. NKOD přistupuje ke SPARQL endpointu Registru práv a povinností pro získání informací o Orgánech veřejné moci a v rámci pipeline 07.2 pro získání dat pro Inventární seznam.
5. NKOD přistupuje ke SPARQL endpointu MFF UK obsahujícího RDF verzi RÚIAN pro získání názvů územních prvků použitých ve frontendové aplikaci a registračních formulářích
6. NKOD přistupuje k číselníkům na webu EU Vocabularies, viz pipeline 01 Cache externích zdrojů.
7. NKOD přistupuje k MS Sharepoint DIA pro získání registrovaných aplikací a podnětů na otevření dat (TODO - pomocí aplikace)