API Pārvaldnieks ir pieejams produkcijas vidē.

Kas ir API Pārvaldnieks?

API Pārvaldnieks ir VISS infrastruktūrai pielāgots WSO2 API pārvaldnieka risinājums, kas nodrošina iespēju VISS infrastruktūrā centralizēti izveidot un publicēt REST API un SOAP servisus, nodrošinot šo servisu drošību un izsaukumu maršrutēšanu. API Pārvaldnieks savu funkciju nodrošināšanā pielieto esošo VISS infrastruktūru – PFAS AUTH un DAIRM2..

API Pārvaldnieks un tā raksturojums

VISS centrālās datu apmaiņas platformas galvenās komponentes

API Pārvaldnieks kā koplietošanas komponentes “Datu apmaiņas infrastruktūra” modulis nodrošina iespēju piekļūt valsts reģistru un pašvaldības informācijas sistēmu sniegtajiem datu servisiem standartizētā veidā. API Pārvaldnieks ir Pieprasījuma servisa analogs, kas nodrošina plašāku funkcionalitāti. Pārejas posmā abi šie risinājumi darbojas paralēli. API Pārvaldnieks ir uz WSO2 enterprise service bus (https://en.wikipedia.org/wiki/Enterprise_service_bus)standarta risinājuma bāzēts un nodrošina:

Iespēju datu devējiem reģistrēt savus REST un SOAP servisus API Publicētāja (API Publisher) saskarnē.
Iespēju datu ņēmējiem reģistrēties API Izstrādātāju portālā (API Devportal), lai izmantotu publicētos servisus
Drošības slānī izmantojot OAuth 2.0 protokolu ar VISS PFAS autentifikāciju.
Pieprasījumu un atbilžu auditēšanu DAIRM2.

API Pārvaldnieka darbības principi

API Pārvaldnieks nodrošina pieeju tajā publicētajiem servisiem, izpildot pieprasījumu auditācijas un kontroles uzdevumus. Pieprasījumu veikšanai nav nepieciešams izmantot noteiktas ziņojumu struktūras (kā tas bija Pieprasījumu servisa gadījumā). Anonīmi (bez drošības talona) pieprasījumi netiek nodrošināti. Pieprasījumu apjoma ierobežojums ir 4 MB.

API Pārvaldnieka lietošanas scenārijs

API Pārvaldnieks nodrošina iespēju datu ņēmējiem veikt sinhronu biznesa servisu (API) izsaukumus. Visi publicētie API ir aizsargāti ar PFAS lietotāja autentifikāciju, un to izsaukšanai ir nepieciešams drošības talons.

height=

Pārvaldniekā publicēta biznesa servisa izsaukums

Iespēju datu devējiem reģistrēt savus REST un SOAP servisus API Publicētāja (API Publisher) saskarnē.
Iespēju datu ņēmējiem reģistrēties API Izstrādātāju portālā (API Devportal), lai izmantotu publicētos servisus
Drošības slānī izmantojot OAuth 2.0 protokolu ar VISS PFAS autentifikāciju.
Pieprasījumu un atbilžu auditēšanu DAIRM2.

API Pārvaldnieka risinājuma konceptuālā arhitektūra

API Pārvaldniekā publicēta biznesa servisa izsaukums

KOMPONENTE	KOMPONENTES APRAKSTS
API Vārteja (API Gateway)	Šis komponents atbild par aizsardzību, pārvaldību, mērogošanu un API izsaukumu nodrošināšanu. API Vārteja ir vienkāršs API starpniekserveris, kas pārtver API pieprasījumus un lieto politikas, piemēram, ierobežošanu un drošības pārbaudes.Pēc validācijas tas nodos Web pakalpojumu izsaukumus uz faktisko back end.
API Izstrādātāju portāls (API Devportal)	Šī komponente ir WSO2 risinājuma nodrošināta web saskarne, kurā reģistrējas pakalpju lietotāji, bet API izstrādātāji izvieto un reklamē savas pakalpes.Šī komponente pakalpju lietotājiem nodrošina vienotu API katalogu, iespēju pieteikties (Subscribe) API izmantošanai savos lietojumos un sniegt atsauksmes par pakalpēm API izstrādātājiem. Lietotne pieejama šeit https://api.viss.gov.lv/devportal/apis .
API Publicētājs (API Publisher)	Šī komponente ir WSO2 risinājuma nodrošināta web saskarne, kurā reģistrēt API izstrādātāju radītās REST un SOAP pakalpes.Tā nodrošina piekļuves tiesību pārvaldību, dokumentēšanu, lietotāju atsauksmju apkopošanu, versionēšanu, pakalpju darbības monitorēšanas un citas iespējas. Lietotne pieejama šeit https://api.viss.gov.lv/publisher/apis .
API datu plūsmas pārvaldītājs (API Traffic Manager)	API datu plūsmas pārvaldītājs lietotājiem palīdz regulēt API satiksmi, padarīt API un lietojumprogrammas pieejamas lietotājiem dažādos pakalpojumu līmeņos un aizsargāt API pret drošības uzbrukumiem.

Neskaidru jautājumu gadījumā, aicinām vērsties API Pārvaldnieka lietotāju atbalsta dienestā rakstot e-pastu uz atbalsts@vraa.gov.lv.

Administratīvie dokumenti

Nosaukums

Apraksts

Tips

Veidlapa Datu devējam
v.22.12.2020

Veidlapa par piekļuves nodrošināšanu datu ņēmējam API Pārvaldniekā reģistrētajām tīmekļa pakalpēm. Veidlapu aizpilda un nosūta datu devējs.

Veidlapa jānosūta elektroniskā dokumenta veidā uz Aģentūras e-adresi, vai papīra formātā pa pastu (Alberta iela 10, Rīga, LV-1010).

Svarīgi! Ja vēstule tiek sūtīta elektroniski, tai jābūt parakstītai ar drošo elektronisko parakstu ar laika zīmogu.

API Abonēšanas procedūra pieejama šeit.

Dokuments

API Pārvaldnieka Veidlapa
v.22.12.2020.

Veidlapa API Publicētāju portāla lietotāja izveidošanai un tiesību piešķiršanai izstrādātājiem, testētājiem, Iestādēm-datu devējiem. Tā jāaizpilda norādot visu nepieciešamo informāciju, jāparaksta un jānosūta Aģentūrai elektroniskā dokumenta veidā uz e-pastu pasts@vraa.gov.lv vai Aģentūras e-adresi (gadījumā, ja datu ņēmējam ir aktivizēts e-adreses konts), vai papīra formātā pa pastu (Alberta iela 10, Rīga, LV-1010).

Svarīgi! Ja vēstule tiek sūtīta elektroniski, tai jābūt parakstītai ar drošo elektronisko parakstu ar laika zīmogu.

API Publicēšanas procedūra pieejama šeit.

Dokuments

Infografika
v.10.09.2020

Informatīvs, vizuāli uzskatāms materiāls, kurā salīdzināts API Pārvaldnieks un Pieprasījumu serviss.

Dokuments

API aprakstīšanas un publicēšanas vadlīnijas 4.0
V2.3 04.04.2023

JAUNS!

v2.3 izmaiņas:

- Pievienota nodaļa par servisu testēšanu izmantojot Postman
- Pievienota sadaļa par atļauju piesķiršanas kārtību
- Papildināta izstrādātāju portāla nodaļa par tiesību pieprasīšanu
- Pievienota sadaļa par autorizācijas talona iegūšanu izmantojot sertifikātu
- Izņemta sadaļa par autorizācijas talona iegūšanu izmantojot lietotājvārdu/paroli

API Publicētāju 4.0 un API Izstrādātāju 4.0 portāla lauku skaidrojumi un izmantošanas vadlīnijas

Dokuments

Dokumentācija

Nosaukums

Apraksts

Tips

Programmētāja rokasgrāmata
v.1.15.

Dokumenta nolūks ir iepazīstināt izstrādātājus ar API Pārvaldnieka izmantošanas principiem. Detalizēta informācija par datu apmaiņu izveidi ir pieejama datu apmaiņas izveides vadlīnijās.

Dokuments

Datu apmaiņas izveides vadlīnijas
v.2.21. - atjaunots 25.01.2022.

JAUNS! Šajā dokumentā ir aprakstītas datu apmaiņas iespējas, to veidošana, izsaukumu piemēri un citi ieteikumi, kā arī informācija, kura sniedz atbalstu datu apmaiņu izstrādātājiem.

Vadlīnijas

Programmatūra

Nosaukums

Apraksts

Tips

Java koda piemēri
v.1.2.0.-13.06.2021.

Java koda piemēri API Pārvaldniekā publicēto servisu/API izsaukšanai. Jāizmanto kopā ar "Datu apmaiņas izveides vadlīnijas" dokumentu.

Programmatūra

PHP koda piemēri
v.1.2.0.-06.06.2022.

PHP koda piemēri API Pārvaldniekā publicēto servisu/API izsaukšanai. Jāizmanto kopā ar "Datu apmaiņas izveides vadlīnijas" dokumentu.

Programmatūra

.NET 6.0 koda piemēri
v.1.2.1.-11.08.2022.

.NET 6.0 koda piemēri API Pārvaldniekā publicēto servisu/API izsaukšanai. Jāizmanto kopā ar "Datu apmaiņas izveides vadlīnijas" dokumentu. Izmantojams ar Visaul Studio 2022

Programmatūra

.NET Framework koda piemēri
v.1.2.0.-16.04.2021.

.NET Framework 4.8 koda piemēri API Pārvaldniekā publicēto servisu/API izsaukšanai. Jāizmanto kopā ar "Datu apmaiņas izveides vadlīnijas" dokumentu.

Programmatūra

Arhīvs

Nosaukums

Apraksts

Tips

Java koda piemēri
v.1.1.8.-11.02.2021.

Java koda piemēri API Pārvaldniekā publicēto servisu/API izsaukšanai. Jāizmanto kopā ar "Datu apmaiņas izveides vadlīnijas" dokumentu.

Programmatūra

.Net koda piemēri
v.1.2.0.-15.04.2021

.Net koda piemēri API Pārvaldniekā publicēto servisu/API izsaukšanai. Jāizmanto kopā ar "Datu apmaiņas izveides vadlīnijas" dokumentu.

Programmatūra

PHP koda piemēri
v.1.1.8.-11.02.2021.

PHP koda piemēri API Pārvaldniekā publicēto servisu/API izsaukšanai. Jāizmanto kopā ar "Datu apmaiņas izveides vadlīnijas" dokumentu.

Programmatūra