1. Sertifikātu sesija (/certificates)
Šī metode iniciē lietotāja sertifikāta iegūšanas sesiju, taču lietotājs nesaņem pieprasījumu ne eParaksts mobile, ne eID Scan lietotnē. Lietotāja sertifikāts ir nepieciešams parakstu izveidei atbilstoši AdES vai QES parakstīšanas shēmām. Metodi var neizmantot gadījumos, kad izvēlētā parakstīšanas shēma neparedz sertifikāta iekļaušanu parakstāmā dokumenta struktūrā.
Pieprasījums
Lai uzsāktu operāciju, veiciet HTTP POST pieprasījumu, kas satur application/x-www-form-urlencoded body, uz šādas formas HTTP URL:
https://{service}/v1/certificates
Autorizācija
Authorization galvenē (header) iekļaujiet jums piešķirto API atslēgu. Papildu informāciju skatiet sadaļā [API autorizācija].
Pieprasījuma parametri
HTTP pieprasījumā ir obligāti jānorāda noteikti parametri.
| Nosaukums | Tips | Lietojums | Apraksts |
|---|---|---|---|
| person_identifier | POST | Obligāts | Personas identifikators atbilstoši ETSI Natural Person Sematics Identifier, kas definēts ETSI319412-1. Formāts: PNOLV-XXXXXX-XXXXX |
| certificate_type | POST | Obligāts | Pieprasītā sertifikāta tips (authentication vai signature) |
| certificate_label | POST | Neobligāts | Filtrs, lai ierobežotu vaicājumu tikai uz tiem lietotāja sertifikātiem, kuri satur norādīto etiķeti. Atbalstītās etiķetes: mobileid - eParakstsmobile sertifikāti. eidscan - eID Scan sertifikāti. Noklusētā vērtība ir mobileid. |
Pieprasījuma galvenes
HTTP pieprasījumā jābūt ietvertām šādām galvenēm:
- Content-Type - application/x-www-form-urlencoded satura tips.
Content-Type: application/x-www-form-urlencoded; charset=UTF-8- Authorization - API atslēga
Authorization: Basic <API-key>Pieprasījuma saturs
Pieprasījuma saturam jābūt application/x-www-form-urlencoded vienībai, kas satur visus obligātos parametrus.
Atbilde
Ja operācija tiek apstrādāta veiksmīgi, tiek atgriezta atbilde ar statusu 200 OK.
Piemērs
HTTP/1.1 200 OK
Content-Type: application/json
{JSON-DATA}Kļūdas gadījumā atbilde saturēs statusu, kas atšķiras no 200 OK.
Šādā gadījumā atbilde saturēs papildu informāciju par kļūdas cēloni. Papildu informāciju skatiet sadaļā [API kļūdu apstrāde].
Piemērs
HTTP/1.1 400 Bad Request
Content-Type: application/json
{
"error": {
"value": "unauthorized"
}
}Atbildes parametri
Atbilde ir JSON attēlojums ar šādiem parametriem.
| Nosaukums | Lietojums | Apraksts |
|---|---|---|
| session_id | Obligāts | Sagatavotās sesijas unikāls identifikators, kas izmantojams turpmākajos API operāciju izsaukumos. Papildu informāciju skatiet sadaļā [Sesijas rezultāts (/session)]. |
Atbildes galvenes
HTTP atbildē var būt ietvertas šādas galvenes:
- Content-Type - JSON formāts.
Content-Type: application/jsonUpdated 3 days ago