Ātrā uzsākšana (Quickstart)
Lai atvieglotu attālināta eID paraksta (bāzēts uz CSC API risinājuma) integrāciju, nodrošinām gatavu Postman kolekciju un vides konfigurācijas šablonu
Lejupielādei pieejamie faili
| Artefakts | Pielietojums |
|---|---|
| TrustedX-CSCv2.postman_collection.json | Izpildāms CSC API integrācijas piemērs ar pamata validācijām un testiem |
| TrustedX-CSCv2.postman_environment.json | Vides konfigurācijas šablons bez klientam specifiskiem datiem un noslēpumiem |
Ieteicamā izpildes secība
Lai veiksmīgi izpildītu pilnu Attālināta eID paraksta scenāriju, ieteicams veikt darbības šādā secībā:
- Importēt Postman kolekciju un vides konfigurāciju.
- Aizpildīt klientam piešķirtās vides mainīgo vērtības.
- Izpildīt CSC info pieprasījumu un pārliecināties par veiksmīgu savienojumu ar CSC servisu.
- Mapē 10 - Parakstīšanas datu iegūšana, izmantojot PAR autorizācijas pieprasījumu, secīgi izpildīt visus pieprasījumus.
- Mapē 20 - Hash parakstīšana secīgi izpildīt visus pieprasījumus.
- Izmantojot Postman Console, salīdzināt faktiskos HTTP pieprasījumus un atbildes ar šajā dokumentācijā norādītajiem parametriem un piemēriem.
Postman mainīgo automātiska saglabāšanaMarķiera (Tokena) pieprasījumu pēcatvildes (post-response) skripti automātiski saglabā
access_tokenun parakstīšanas identitātes iegūšanas plūsmā arīcredential_id. Pārliecinieties, ka ir izvēlēta pareizā Postman vide un skriptiem ir tiesības atjaunināt vides lokālās vērtības.
Tvērums
Postman kolekcija aptver šādas darbības:
- CSC servisa informācijas iegūšanu (
POST /info); - īstermiņa parakstīšanas credential reģistrāciju;
- OAuth autorizācijas koda iegūšanu, izmantojot PAR (Pushed Authorization Request) un PKCE;
- autorizācijas koda apmaiņu pret piekļuves marķieri (Bearer Access Token);
credentialIDun credential informācijas iegūšanu;- dokumenta hash parakstīšanas autorizāciju;
- hash parakstīšanu, izmantojot
POST /signatures/signHash.
Priekšnosacījumi
Pirms integrācijas uzsākšanas jāsaņem:
- OAuth
client_id; - OAuth
client_secret; - reģistrēts
redirect_uri; - piekļuve attiecīgajai videi (testa vai produkcijas);
- testa lietotājs autentifikācijas un parakstīšanas pārbaudēm.
Svarīgi! Parametra
redirect_urivērtībai precīzi jāsakrīt OAuth klienta konfigurācijā, PAR pieprasījumā, autorizācijas pieprasījumā un tokena apmaiņas pieprasījumā.
Vides adreses
Postman vides mainīgie
Obligātie konfigurācijas parametri
| Mainīgais | Obligātums | Apraksts |
|---|---|---|
csc_base_url | Obligāts | CSC v2 bāzes URL bez beigu slīpsvītras |
client_id | Obligāts | Reģistrētais OAuth klienta identifikators |
client_secret | Obligāts | OAuth klienta noslēpums |
redirect_uri | Obligāts | OAuth klientam reģistrētais pāradresācijas URL |
scope | Obligāts | OAuth piekļuves tvērums. Šajā scenārijā jāizmanto vērtība credential |
Piekļuves (credential) iegūšanas parametri
| Mainīgais | Obligātums | Apraksts | Piemērs |
|---|---|---|---|
signature_qualifier | Credential iegūšanai | Pieprasītā paraksta kvalifikācija | eu_eidas_qes |
acr_values | Autorizācijai | Nosaka izmantojamo autentifikācijas plūsmu | Skatīt zemāk |
Atbalstītās autentifikācijas plūsmas
| Autentifikācijas veids | Vērtība |
|---|---|
| eID karte | urn:eparaksts:authentication:flow:sc_plugin |
| eID Scan | urn:eparaksts:authentication:flow:mobile-eid |
Parakstīšanas parametri
| Mainīgais | Obligātums | Apraksts |
|---|---|---|
credential_id | Parakstīšanai | EIDAS piešķirtais parakstīšanas credential identifikators |
hash_base64 | Parakstīšanai | Iepriekš aprēķināts dokumenta hash Base64 formātā |
hash_algorithm_oid | Parakstīšanai | Hash aprēķinā izmantotā algoritma OID |
signature_algorithm_oid | Parakstīšanai | Pieprasītā paraksta algoritma OID |
Atbalstītie algoritmi
| Algoritms | OID |
|---|---|
| SHA-384 | 2.16.840.1.101.3.4.2.2 |
| ECDSA ar SHA-384 | 1.2.840.10045.4.3.3 |
Dinamiskie parametri
Šos parametrus Postman kolekcija aizpilda automātiski izpildes laikā.
| Mainīgais | Apraksts |
|---|---|
code_verifier | Kriptogrāfiski nejaušs PKCE verificētājs |
code_challenge | SHA-256 vērtība no code_verifier, kodēta Base64URL formātā |
oauth_state | OAuth korelācijas un CSRF aizsardzības vērtība |
request_uri | PAR atbildē saņemtā pieprasījuma atsauce |
authorize_url | Lietotāja pāradresācijai izveidotais autorizācijas URL |
authorization_code | Pāradresācijas (Callback) saņemtais vienreiz lietojamais autorizācijas kods |
access_token | Marķiera galapunkta (Token endpoint) atbildē saņemtais piekļuves marķieris (Bearer Access Token) |
Nākamie soļi
Pēc vides konfigurācijas:
- Izpildiet
POST /infopieprasījumu, lai pārbaudītu savienojumu ar CSC servisu - Izveidojiet īstermiņa parakstīšanas identitāti (credential)
- Veiciet lietotāja autentifikāciju
- Iegūstiet parastīšanās identitātes (credential) informāciju
- Autorizējiet dokumenta jaucējvērtības (hash) parakstīšanu
- Izsauciet
POST /signatures/signHash, lai saņemtu kvalificētu elektronisko parakstu
Updated about 15 hours ago