Pieprasījums

Lai uzsāktu operāciju, veiciet HTTP GET pieprasījumu uz šādas formas HTTP URL:

https://{service}/v1/session/{session_id}

Autorizācija

Authorization galvenē iekļaujiet jums piešķirto API atslēgu. Papildu informāciju skatiet sadaļā [API autorizācija].

Pieprasījuma parametri

Sesijas rezultāta iegūšanai ir nepieciešami noteikti parametri.

Nosaukums	Tips	Lietojums	Apraksts
session_id	PATH	Obligāts	Sesijas ID, kas iegūts saistītās operācijas iniciēšanas laikā.

Pieprasījuma galvenes

HTTP pieprasījumā jābūt ietvertām šādām galvenēm:

Authorization - API atslēga.

Authorization: Basic <API-key>

Pieprasījuma saturs

HTTP GET pieprasījumos satura daļa netiek izmantota.

Atbilde

Tiks atgriezta atbilde ar statusu 200 OK, kas norāda, ka pieprasījums ir apstrādāts veiksmīgi.

Piemērs

HTTP/1.1 200 OK
Content-Type: application/json

{JSON-DATA}

Kļūdas gadījumā atbildē tiks norādīts cits statuss nekā 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
status	Obligāts	Pieprasījuma statuss. Iespējamās vērtības: `running` - operācija tiek izpildīta, mēģiniet vēlāk. `complete` - operācija ir pabeigta, sagaidāms rezultāts `error`, `certificate` vai `signature`.
error	Neobligāts	Struktūra, kas apraksta API kļūdu. Pieejama, ja operācija pabeigta ar kļūdu.
error.id	Neobligāts	Kļūdas identifikators problēmas izsekošanai.
error.value	Obligāts	Kļūdas vērtība. Papildu informāciju skatiet sadaļā [API kļūdu apstrāde].
error.message	Neobligāts	Papildu kļūdas ziņojums.
certificates[]	Neobligāts	Struktūra, kas apraksta Sertifikātu operācijas rezultātā iegūto sertifikātu sarakstu. Var būt tukša vai nebūt norādīta, ja operācija vēl tiek izpildīta vai pabeigta ar kļūdu.
certificates[].label	Obligāts	Sertifikāta etiķete. Izmantojama Autentifikācijas un Parakstīšanas operācijās.
certificates[].value	Obligāts	Sertifikāta vērtība, kodēta ASN.1 DER un Base64 formātā. ⚠️ Sertifikāts vienmēr ir derīgs atbildes saņemšanas brīdī, tādēļ papildu statusa pārbaudes (OCSP vai CRL) nav nepieciešamas. Tomēr, veidojot LTV iespējotu parakstu, ir jāpieprasa aktuāli atsaukšanas dati. ⚠️
signature	Neobligāts	Struktūra, kas apraksta Autentifikācijas vai Parakstīšanas operācijas paraksta rezultātu. Var būt tukša vai nebūt norādīta, ja operācija vēl tiek izpildīta vai pabeigta ar kļūdu.
signature.value	Obligāts	Paraksta vērtība, kodēta Base64 formātā.
signature.algorithm	Obligāts	Procesā izmantotais paraksta algoritms (`rsa-sha256`, `rsa-sha384`, `rsa-sha512`, `ecdsa-sha256`, `ecdsa-sha384`, `ecdsa-sha512`).
device_address	Neobligāts	eParaksts mobile vai eID Scan lietotni darbinošās ierīces IP adrese. Pieejama Autentifikācijas vai Parakstīšanas operācijai. Tukša, ja adresi nav iespējams noteikt vai operācija pabeigta ar kļūdu.

Atbildes galvenes

HTTP atbildē var būt ietvertas šādas galvenes:

Content-Type - dokumenta modeļa satura tips.

Content-Type: application/json