Funkcionalitātei "eParaksts Token Signing" gala lietotāja datorā ir jāinstalē pielāgots spraudnis/paplašinājums pārlūkprogrammām, kas sazinās ar viedkarti.

Gala lietotāja spraudņu/paplašinājumu instalācija tiek izplatīta ar eParakstītājs 3.0 programmatūras pakotni.

Izmantojot JavaScript API funkciju getBackendInfo, ir iespējams noteikt instalētā spraudņa/paplašinājuma stāvokli. Situācijās, kad spraudnis/paplašinājums nav instalēts vai tā versija ir novecojusi.

JavaScript API (HWCrypto)

Komponentes
JavaScript API (HWCrypto) sastāv no trim failiem:

eparaksts-hwcrypto.js - galvenās funkcijas.
eparaksts-hwcrypto-legacy.js - papildu funkcionalitāte, lai nodrošinātu saderību ar Internet Explorer 8 un jaunākām versijām.
eparaksts-jquery.js - papildu saderības funkcijas.

JavaScript API funkcijas

getBackendInfo

Funkcijan
Atgriež informāciju par galalietotāja spraudni/paplašinājumu

Promise window.eparakstshwcrypto.getBackendInfo()

Parameteri
nav

Rezultāts
Atgriež Promise objektu, kas atbilst BackendInfo datu tipam.

Kļūdas
Paredzamās kļūdas:

technical_error

getCertificate

Funkcija
Lietotājam tiek piedāvāts izvēlēties sertifikātu no pieejamo sertifikātu saraksta. Savienojums ar pārlūkprogrammas spraudni/paplašinājumu, kas ļauj nolasīt sertifikāta datus no lietotāja viedkartes.

Promise window.eparakstshwcrypto.getCertificate(object options)

Parameteri

Parametrs Tips Obligāts Apraksts

options objekts (object) Nē Sertifikāta izvēles nosacījumi.

Parametrs		Tips	Obligāts	Apraksts
`options`		objekts (object)	Nē	Sertifikāta izvēles nosacījumi.
	`lang`	virkne (string)	Nē	Vēlamā lietotāja saskarnes valoda (kods ISO-639-1). Atbalstītās valodas: en - angļu (noklusējuma vērtība); lv* - latviešu; ru* - krievu. Lietotāja saskarnes valoda netiek pilnībā ietekmēta, jo izmantoto valodu var noteikt operētājsistēma vai pārlūkprogramma.
	`operation`	virkne (string)	Nē	Operācijas veids:Type of operation: `sign` - dokumenta parakstīšana (paraksta sertifikāts tiks atgriezts) (noklusējuma vērtība); `auth` - lietotāja autentifikācija (tiks atgriezts autentifikācijas sertifikāts)

lang

virkne (string)

Nē

Vēlamā lietotāja saskarnes valoda (kods ISO-639-1).

Atbalstītās valodas:

en - angļu (noklusējuma vērtība);
lv* - latviešu;
ru* - krievu.

Lietotāja saskarnes valoda netiek pilnībā ietekmēta, jo
izmantoto valodu var noteikt operētājsistēma vai pārlūkprogramma.

operation

virkne (string)

Nē

Operācijas veids:Type of operation:

sign - dokumenta parakstīšana (paraksta sertifikāts tiks atgriezts) (noklusējuma vērtība);
auth - lietotāja autentifikācija (tiks atgriezts autentifikācijas sertifikāts)

Rezultāts
Atgriež Promise objektu, kads atbilst Certificate datu tipam.

Kļūdas
Paredzamās kļūdas:

no_implementation
no_certificates
user_cancel
technical_error

Sign

Funkcija
Nepieciešams, lai lietotājs parakstītu iepriekš sagatavotu jaucējvērtību (HASH) no parakstāmajiem datiem. Parakstīšana tiek veikta, izmantojot pārlūkprogrammas spraudni vai paplašinājumu, kas nodrošina piekļuvi lietotāja viedkartei.

Promise window.eparakstshwcrypto.sign(object certificate, object hash, object options)

Parameteri

Parametrs	Objekta parametrs	Tips	Obligāts	Apraksts
`certificate`		objekts (object)	Jā	Sertifikāts, lai parakstīšanai izmantotu atbilstošo privāto atslēgu. Izmantojot funkciju getCertificate, tika iegūts objekts, kas atbilst datu tipam Certificate
`hash`		objekts (object)	Jā	Sagatavota parakstāma HASH vērtība
	`type`	virkne (string)	Jā	Tipa lauka vērtība netiek interpretēta, bet tā ir saglabāts atpakaļsaderībai. Visos gadījumos ieteicams izmantot konstantu "SHA"
	`hex`	virkne (string)	Jā	Parakstāmā jaucējvērtība (HASH) HEX formātā. vai vairāku dokumentu (partijas) parakstīšanas gadījumā JSON objektā, kas satur vienu vai vairākus `key:value` pāri, kur: `key` - parakstīts dokumenta identifikators; `value` - Parakstāma HASH vērtība HEX kodējumā
`options`		objekts (object)	Nē	Parakstīšanas nosacījumi
	`lang`	virkne (string)	Nē	Vēlamā lietotāja saskarnes valoda (kods ISO-639-1).Atbalstītās valodas: en* - angļu (noklusējums); lv* - latviešu; Lietotāja saskarnes valoda netiek pilnībā ietekmēta, jo izmantoto valodu var noteikt operētājsistēma vai pārlūkprogramma.
	`operation`	virkne (string)	Nē	Operācijas veids:Type of operation: `sign` - dokumentu parakstīšana (noklusējuma vērtība); `auth` - lietotāja autentifikācija
	`info`	virkne (string)	Nē	Informatīvs teksts (dokumenta nosaukums, darījuma summa utt.).

Rezultāts
RAtgriež Promise objektu, kas atbilst Signature datu tipam

Kļudas
Paredzamās kļūdas:

no_implementation
invalid_argument
user_cancel
technical_error
pin_blocked

Datu veidi

BackendInfo

Satur informāciju par pārlūkprogrammā instalēto galalietotāja spraudni/paplašinājumu.

Atribūtis

Parametri	Tips	Apraksts
veids (type)	Virkne (string)	Spraudņa/paplašinājuma veids: `NO_IMPLEMENTATION` - Spraudnis/paplašinājums ir bloķēts vai nav instalēts `FAILING_CHROME` - Spraudnis/paplašinājums nedarbojas, galalietotājam ir jāiespējo spraudnis/paplašinājums un jārestartē pārlūkprogramma `FAILING_NPAPI` - Spraudnis/paplašinājums nedarbojas, galalietotājam ir jāiespējo spraudnis/paplašinājums un jārestartē pārlūkprogramma Plugin/extension name - spraudnis/paplašinājums darbojas. Ir pieejama arī spraudņa/paplašinājuma versija.
versija (version)	Virkne (string)	Spraudņa/paplašinājuma versija

Sertifikāts

Satur X509 sertifikāta datus.

Atribūti

Parametrs	Tips	Apraksts
`encoded`	Uint8Array	Sertifikāta binārā vērtība DER kodējumā.
`hex`	Virkne (string)	Sertifikāta vērtība HEX kodējumā. (Neobligāti)

Paraksts

Satur parakstītus datus..

Atribūti

Parametrs	Tips	Apraksts
`hex`	Virkne (string)	Signed data in HEX encoding. Ja pieprasījumā ir "JSON" tips, parakstītie dati tiek iekļauti JSON objektā, kas satur vienu vai vairākus`key:value` pārus, kur: `key`- parakstīts dokumenta identifikators; `value` - parakstīti dati HEX kodējumā. Kārtība, kādā `key:value` pāri, kas tiek atgriezti, var nebūt identiski tai secībai, kādā tika izveidots paraksta pieprasījums.