Apraksts
API Pārvaldnieks ir standartizēta servisu izplatīšanas platforma, kas nodrošina iespēju drošā un standartizētā veidā piekļūt valsts un pašvaldības informācijas sistēmu sniegtajiem datu servisiem.
Publicēts: 16.08.2024.
Izmantošanas iespējas un procedūra
- Publicēto servisu pārlūkošana un abonēšana API Izstrādātāju portālā
- REST, SOAP un GQL servisu reģistrācija API Publicētāju portālā.
- Reģistrēto servisu drošības un konfigurācijas pārvaldība
- Pieprasījuma un atbildes notikuma auditēšana
| 1. | Izstrādātāju portālā (API Devportal) pieejamo servisu (API) izpēte |
Datu ņēmējs veic Izstrādātāja portāla (API Devportal) servisu (API) kataloga izpēti (https://api.viss.gov.lv/devportal/apis), lai iegūtu informāciju par pieejamajiem servisiem, kuru izmantot savā risinājumā. – Dokumenta sadaļās 5.3.1.1. “Publicēto API pārlūkošana” |
| 2. |
Vienošanās ar datu devēju par servisu saukšanu caur API Pārvaldnieku |
Ja datu ņēmējam jau ir izveidota datu apmaiņa API Pārvaldniekā reģistrēto servisu izsaukšanai, t.i. datu ņēmējam jau ir izveidots API Izstrādātāju portāla (API Devportal), VISS Pašvaldību funkciju atbalsta sistēmā (PFAS) lietotājs un piešķirts Datu apmaiņas identifikācijas numurs: Datu ņēmējs sazinās ar datu devēju un vienojas par servisu saukšanu, izmantojot API Pārvaldnieku. Datu ņēmējs norāda datu dēvējam API Izstrādātāju portālā izveidotā klienta lietojuma nosaukumu un identifikatoru (Key), ar kuru plānots izsaukt konkrētos servisus. – Dokumenta sadaļās 5.4.4. ”Pieejas servisam (API) piešķiršana” un 5.3.1.5. “Servisa izmantošanas tiesību pieprasīšana no datu devēja”. Tālāk skat. 6. punktu. |
| 3. | Datu devēja atļauja servisu izmantošanai |
Ja datu ņēmējam nav izveidota datu apmaiņa API Pārvaldniekā reģistrēto servisu izsaukšanai, t.i. datu ņēmējam nav izveidots API Izstrādātāju portāla (API Devportal) lietotājs: Datu ņēmējam nepieciešams aizpildīt un nosūtīt Aģentūrai elektroniskā dokumenta veidā uz Aģentūras e-adresi vai e-pastu pasts@vraa.gov.lv, 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. |
| 4. | Tiesību piešķiršana |
Aģentūra izveido datu ņēmējam lietotāju API Izstrādātāju portālā, reģistrē PFAS sertifikātu servisu izsaukšanai, kā arī piešķir Datu apmaiņas identifikācijas numuru. Aģentūra informē datu ņēmēju un datu devēja kontaktpersonu par lietotāju izveidi datu ņēmējam. – Dokumenta sadaļās 5.3.1.2. “Pieejas tiesību pieprasīšana no VRAA” |
5. |
Klienta lietojuma (Application) reģistrācija izstrādātāju portālā |
Datu ņēmējs Izstrādātāju portāla sadaļā “KLIENTA LIETOJUMI” reģistrē savu Klienta lietojumu, kuru izmantos attiecīgo servisu abonēšanai un izsaukšanai. Vienam Klienta lietojumam ir iespējams piesaistīt vairākus servisus. – Dokumenta sadaļās 5.3.1.3. ”Klienta lietojuma reģistrācija” |
| 6. | Atļaujas piešķiršana |
Datu ņēmējs sazinās ar datu devēju, norādot datu dēvējam API Izstrādātāju portālā izveidotā klienta lietojuma nosaukumu un identifikatoru (Key), ar kuru plānots izsaukt konkrētos servisus. Datu devējs piešķir datu ņēmēja klienta lietojumam VISS portālā atļaujas izsaukt datu devēja servisus. Datu devējs informē datu ņēmēju par atļauju piešķiršanu. – Dokumenta sadaļās 5.4.4. ”Pieejas servisam (API) piešķiršana” un 5.3.1.5. “Servisa izmantošanas tiesību pieprasīšana no datu devēja” |
| 7. | Servisa abonēšana |
Datu ņēmējs abonē izvēlēto servisu un veic tā izsaukumu ar reģistrēto klienta lietojumu. - Dokumenta sadaļās 5.3.1.4. “Servisu abonēšana” un 3.1.5 “Lietojuma pielāgošana servisa izsaukšanai” |
| 8. | Konsultatīvais atbalsts | Iestāžu un to izstrādātāju pārstāvji visa procesa laikā var saņemt konsultatīvo atbalstu, rakstot uz e-pastu atbalsts@vraa.gov.lv |
| 1. | VISS un API Pārvaldnieka tiesību pieprasījums |
Lai varētu publicēt servisus Publicētāju portālā (API Publisher), iestāde nosūta Aģentūrai veidlapu par VISS un API Pārvaldnieka tiesību piesķiršanu. Tā jāaizpilda norādot visu nepieciešamo informāciju, jāparaksta un jānosūta Aģentūrai elektroniskā dokumenta veidā uz Aģentūras e-adresi vai e-pastu pasts@vraa.gov.lv, vai papīra formātā pa pastu (Alberta iela 10, Rīga, LV-1010). Svarīgi! Ja vēstule tiek sūtīta eletroniski, tai jābūt parakstītai ar drošo elektronisko parakstu ar laika zīmogu. |
| 2. |
Tiesību piešķiršana |
Aģentūra iestādei izveido lietotāju Publicētāju portālā un piešķir tiesības publicēt servisus. Aģentūra informē par izveidotajiem lietotājiem un piešķirtajām tiesībām, nosūtot e-pastu iestādes lietotājiem. |
| 3. | Vai serviss tiks aizsargāts ar iestādes STS? |
Ja serviss ir papildus aizsargāts ar iestādes STS (Security Token Service), tad iestādei jāsazinās ar VRAA par mediatora izveidi. |
| 4. | Pieprasījums Aģentūrai par mediatora izveidi |
Pieprasījumu par mediatora izveidi un pievienošanu nosūta Aģentūrai elektronisku uz e-pastu atbalsts@vraa.gov.lv, e-pasta tēmā norādot - Mediatora izveide servisam API Pārvaldniekā. |
| 5. | Mediatora izveide |
Aģentūra sazinās ar iestādi un, pēc sniegtās informācijas, izveido mediatora failu un nosūta to pa e-pastu iestādes norādītajai kontaktpersonai. |
| 6. | Servisa (API) pievienošana testa vidē |
Servisu iespējams pievienot Publicētāju portāla “API” sadaļā, spiežot uz saites “PIEVIENOT JAUNU API”. |
7. |
Servisa aprakstīšana un publicēšana |
Iestāde publicējot servisu, norāda tā aprakstu atbilstoši API aprakstīšanas un publicēšanas vadlīnijām, kā arī pievieno servisa dokumentāciju. Piekļuve API jāierobežo ar operāciju (scope), izņemot gadījumos, kad normatīvajos aktos ir noteikts, ka servisa atgrieztie dati ir brīvi pieejami ikvienam. Datu apmaiņas izveides vadlīnijas – Dokumenta sadaļās 5.4.3 “Servisu (API) reģistrēšana un publicēšana” |
| 8. | Servisu testa izsaukumi | Veic testa izsaukumus testa vidē, lai pārliecinātos, ka serviss (API) darbojas korekti. Kļūdu gadījumā atgriežas uz 7. soli un veic servisa konfigurēšanas un aprakstīšanas uzlabojumus. |
| 9. | Servisa publicēšana un Izsaukumu veikšana produkcijas vidē | Pēc veiksmīgas servisa pievienošansas un izsaukumu veikšanas testa vidē, iestāde publicē servisu Publicētāju portāla produkcijas vidē. |
| 10. | Konsultatīvais atbalsts | Iestāde un tās izstrādātāja pārstāvji visa procesa laikā var saņemt konsultatīvo atbalstu, rakstot uz e-pastu atbalsts@vraa.gov.lv. |
Vadlīnijas un dokumentācija
Autorizācijas talona iegūšana API Pārvaldniekā notiek izmantojot sertifikāta autentifikāciju.
VRAA nodrošina sertifikāta izveidošanu, izmantojot VISS CA.
Lūgums nepārkopēt dotās komandas no parauga, bet gan rakstīt tās ar rokām, jo pārkopējot tas var nestrādāt.
VRAA CA sertifikātu sagatavo, izmantojot openssl bibliotēku:
-
Sagatavošanas solī nepieciešams uzlikt openssl un palaist to no komandrindas
openssl> -
Jāuzģenerē privātā atslēga, kur xxxxx ir izdomāts kodēts nosaukums katram klientam unikāls
>genrsa -out c:\temp\xxxxx.key 2048 -
Jāuzģenerē sertifkāta pieprasījums
>req -new -subj '/C=LV/ST=Riga/L=Riga/O=Organizacijas nosaukums/OU=IT/CN=xxxxx/emailAddress=it@kllients.lv' -key c:\temp\xxxxx.key -out c:\temp\xxxxx.req -days 1800 -
Uzģenerētais fails xxxxx.req jānosūta VRAA. VRAA pēc šī pieprasījuma uzģenerē xxxxx.cer failu un nosūta to klientam.
-
Kad klients saņem .cer failu, tas jāiekopē blakus .key failam, jāatver openssl un jāizpilda komanda:
>pkcs12 -export -in c:\temp\xxxxx.cer -inkey c:\temp\xxxxx.key -out c:\temp\xxxxx.pfx
Iegūto .pfx failu var izmantot pēc vajadzības.
Linux sertifikāta apstrāde:
openssl pkcs7 –print_certs –in iestade.p7b –out certificate.cer
Kur iestade.p7b ir VRAA atsūtītais .p7b fails
openssl pkcs12 –export –in xxxxx.cer –inkey/opt/certi/iestade.key –certfile iestade.cer –out iestade.pfx
Kur certificate.cer ir iepriekšējās komandas uzģenerētais fails; iestade.key ir Jūsu key fails, iestade.cer ir VRAA atsūtītais. Šī komanda prasīs ievadīt paroli – Jūsu izdomāta parole, kuru vajadzēs app.config failam.
openssl pkcs12 –info –in iestade.pfx
Šī komanda izdrukā uzģenerētā .pfx faila info – no kā var iegūt nepieciešamos datus, prasti tas ir thumbprint (tas ir localKeyID) - ciparu un burtu kombinācija ar visām atstarpēm.