Page tree
Skip to end of metadata
Go to start of metadata

Definícia a základné požiadavky:

  • reprezentuje elektronickú služby verejnej správy prístupnú verejnosti aj prostredníctvom tretích strán

  • služba môže slúžiť na čítanie aj zápis

  • požiadavky na služby v oblasti podpory, Quality of Service alebo SLA musia byť identické ako pre zvyšný systém, ktorého je toto API súčasťou

  • použitie služby je podmienené prihlásením prostredníctvom centrálnej autority identít (NASES)

  • Prístup ku každej OpenAPI službe je riadený prostredníctvom centrálnej autority identít bez nutnosti komunikácie s poskytovateľom OpenAPI služby

  • Centrálna autorita identít poskytuje:

    • Registráciu OpenAPI služby

      • Všeobecné zmluvné podmienky pre použitie OpenAPI služby

      • Rozhranie na registráciu OpenAPI služby agendového systému, kde tvorca tejto služby definuje:

        • prostredníctvom integrácie s Centrálnym metainformačným systémom sú zabezpečené všetky potrebné dokumentačné náležitosti služby

        • scope pre službu

        • podrobnú dokumentáciu scope

        • ak sú nutné, tak špeciálne zmluvné podmienky použitia služby

    • Rozhranie pre povolenie prístupu k OpenAPI službe treťostrannému subjektu:

      • registrácia treťostranného subjektu

      • jednorázové elektronické podpísanie zmluvných podmienok pre použitie OpenAPI služby

    • Rozhranie pre odobratie prístupu treťostranným subjektom k OpenAPI službe

      • pre tvorcov OpenAPI služby

      • pre koncových používateľov (občania, komerčné subjekty, ...)

 

  • Prístup k službe je  prostredníctvom API Gateway komponentu

  • Sandbox

    • je izolované vývojárske prostredie na testovanie OpenAPI služieb v prostredí čo najpodobnejšom s produkčným, ale bez skutočných údajov (napríklad UPVS dev prostredie)

    • je vyžadovaný pri publikácii OpenAPI služby

  •  API Gateway je technický komponent, ktorý zabezpečuje:  
    • verejne prístupné proxy, prostredníctvom ktorého je riadený prístup pre registrované elektronické služby
    • počítanie prístupov k elektronickým službám za účelom spoplatnenia alebo obmedzenia prístupu po prekročení limitu definovaného poskytovateľom elektronickej služby
    • overovanie prístupových tokenov
    • zverejňovanie štatistík prístupu v štruktúrovanej podobe k jednotlivým službám
    • monitoring elektronických služieb a zverejňovanie v Centrálnom metainformačnom systéme
  • Technológie pre bezpečné poskytovanie identity používateľov a správy prístupov k služby:

    • preferovaná možnosť : OpenID Connect

    • alternatívy: STS WS (on-behalf-off), OAuth 2.0

Proces

Proces registrácie OpenAPI služby

  • služba musí byť zaregistrovaná v Centrálnom metainformačnom systéme, kde sa nachádza

    • minimálne štruktúrovaná API dokumentácia :

      • v pripade REST služby je štruktúrovane zdokumentovaná prostredníctvom OpenAPI 3.0

      • v prípade SOAP služby je štruktúrovane zdokumentovaná prostredníctvom WSDL + XSD

    • popis metadát služby na úrovni metadát je v súlade s CSPV-AP štandardom EU (kto je gestorom, endpoint, odkedy služba je zaregistrovaná)

    • príklad volania služby

    • príklad odpovede odpovede služby

    • dokumentácia všetkých možných “scope” služby

    • ak dátový prvok používaný na rozhraní služby má mapovanie na prvok v Centrálnom modely údajov, tak je tento vzťah zapísaný štruktúrovane v dokumentácii

    • ak existujú referenčné URI identifikátory pre entity v službách, je vyžadované ich použitie

  • registrácia služby v systéme centrálnej autority identít s prepojením prostredníctvom jednoznačného URI identifikátora na Centrálny metainformačný systém

  • definovanie scope (rozsah údajov o ktoré je možné vrámci služby poskytovať)

  • každý scope môže mať definované špeciálne zmluvné podmienky použitia. Ak žiadne nie su definované, sú použité všeobecné zmluvné podmienky

  • poskytovateľ OpenAPI služby deleguje spracovanie prístupov k volaniu služby centrálnej autorite identít

Proces povolenia prístupu k OpenAPI službe pre treťostranné subjekty

  • Treťostranný subjekt:

    • sa zaregistruje u centrálnej autority identit (ak do danej chvíly nie je registrovaný)

    • vyberie si existujúcu OpenAPI službu o ktorú má záujem

    • elektronicky podpíše zmluvné podmienky na použitie OpenAPI služby

Proces použitia OpenAPI služby v aplikácii treťostranného subjektu

  • Používateľ

    • pristúpi k treťostrannej aplikácii

    • pred použitím OpenAPI služby sa používateľovi zobrazí potvrdzovacia obrazovka so zobrazením scope, ku ktorým chce aplikácia pristupovať

    • musí odsúhlasiť prístup ku scope, ktoré požaduje treťostranná aplikácia

    • súhlas používateľa k prístupu treťostrannej aplikácii môže byť časovo obmedzený
    • bude pri povolení informovaný, že prevádzkovateľ OpenAPI služby ani Centrálny správca identít nenesie žiadnu zodpovednosť za prípadné nesprávne fungovanie aplikácie

    • môže interagovať s aplikáciou

Unknown macro: {add-label}