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/authentication

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

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_label	POST	Obligāts	Sertifikāta etiķete, kas jāizmanto paraksta izveidei. Atbalstītās vērtības un papildu informāciju skatiet sadaļā [Sertifikātu sesija].
digest_value	POST	Obligāts	Parakstāmā dokumenta jaucējvērtība (hash). Kodēta Base64 formātā.
digest_algorithm	POST	Obligāts	Jaucēšanas algoritms, kas izmantots dokumenta jaucējvērtības aprēķināšanai (`sha256`, `sha384` vai `sha512`).
message	POST	Obligāts	Lietotājam attēlotais ziņojums, lai mudinātu autorizēt paraksta izveidi. Līdz 300 rakstzīmēm. Jaunas rindas rakstzīme `\n` apzīmē rindas pārtraukumu.
force_pin	POST	Neobligāts	Pieprasījums izmantot PIN kodu, neļaujot izmantot biometriju. Ja parametrs nav norādīts vai tiek norādīta vērtība, kas nav `"true"`, ir atļauta arī biometrijas izmantošana.
attributes	POST	Neobligāts	Iegūstamo lietotāja atribūtu saraksts, atdalīts ar komatiem. Pieejamie atribūti atkarībā no jums piešķirtās API atslēgas: `given_name` - vārds; `family_name` - uzvārds; `age` - vecums kā skaitlis; `age_14`, `age_16`, `age_18`, `age_19`, `age_21`, `age_24`, `age_25` - `true`, ja lietotājs ir sasniedzis attiecīgo vecumu.

Sertifikāta objekts nav nepieciešams parakstīšanas operācijai, jo tas tiek automātiski izvēlēts no saistītā lietotāja.

Plašāku informāciju skatiet sadaļā [Verifikācijas kods].

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

Content-Type: application/x-www-form-urlencoded; charset=UTF-8

Authorization: Basic <API-key>

Pieprasījuma saturam jābūt application/x-www-form-urlencoded vienībai, kas satur visus obligātos parametrus.

Atbilde

Ja operācija ir apstrādāta veiksmīgi, tiek atgriezta atbilde ar statusu 200 OK.

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. Plašāku informāciju skatiet sadaļā [API kļūdu apstrāde].

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
  "error": { "value": "unauthorized" }
}

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. Plašāku informāciju skatiet sadaļā [Sesijas rezultāts (/session)].

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

Content-Type: application/json