API Versions

The Web PKI provides an API version requirement parameter, in case the developer intends to use a specific feature set and avoid any unnecessary update on the user Web PKI components. In order to do so, use the requiredApiVersion parameter on init() method, e.g.:

pki.init({
    ready: onWebPkiReady,
    requiredApiVersion: pki.apiVersions.v1_2
});

In the example above, we defined that we are going to use the feature set of API 1.2 (and lower), thus any Web PKI component update will only be required for users with lower versions than the ones defined by API 1.2. No unnecessary update will be required for users with satisfying versions, even though it is not the latest one.

If the parameter is not set, the default requested version is API 1.3.

API changelog

1.8.2 (2023-11-23)

Since lib 2.16.3

• Improve method importCertificate supporting multiple calls

1.8.1 (2022-12-17)

• Add methods encrypt and decrypt
• Add Extended Key Usage info to CertificateModel
• Add parameter nonExportableKey on method generateSoftwareRsaKeyPair

1.7.2 (2022-07-03)

• Add support to unrestricted size native responses
• Add CertificateModel international PKI fields: PkiArgentinaModel, PkiEcuadorModel, PkiParaguayModel, PkiPeruModel
• Add CertificateModel fields: certificatePolicies, subjectDN, issuerDN

1.6.1 (2020-05-23)

• Add downloadToFolder* command with TLS 1.2 forced support

1.6 (2019-10-13)

• Add methods keySignData and keySignHash for signing with a generated private key Id.
• Add privateKeyId parameter to the generate key pair response: GenerateKeyPairResponse
• Fix bug on sendAuthenticatedRequest response payload when it comes without content length header property.

1.5.2 (2019-07-19)

• Add option for returning the signed document content on local signature commands without the 1MB size limit: returnContent
• Add certificate validation levels on local signature commands: CertificateValidationLevels
• Add vertical and horizontal direction control on PAdES (PDF) visual representation: PadesVisualAutoPositioning
• Add native app life cycle control on init method: useDomainNativePool

1.5 (2018-11-27)

• Add more efficient batch signature command: signHashBatch
• Add license v3
• Add mobile integration

1.4.1 (2018-06-15)

• Fix sendAuthenticatedRequest* empty buffer bug

1.4 (2018-02-23)

• Add XML local signature features:
  • signFullXml*
  • signXmlElement*
  • openXmlSignature*
• Add authenticated request feature:
  • sendAuthenticatedRequest*
• Add user error message field on exception object:
  • userMessage

1.3 (2017-11-10)

• Add improved error handler with exception model
  • fail

1.2 (2017-06-19)

• Add local store and PKCS#11 certificate generation features:
  • generateSoftwareRsaKeyPair
  • importCertificate
  • listTokens
  • generateTokenRsaKeyPair
  • importTokenCertificate

1.1 (2016-08-19)

• Add license v2
• Add local signature features:
  • showFileBrowser*
  • openFile*
• Add PAdES local signature features:
  • signPdf*
  • openPades*
• Add CAdES local signature features:
  • signCades*
  • openCades*

1.0 (2015-04-28)

• Add basic features:
  • init
  • listCertificates
  • readCertificate
  • signHash
  • signData
  • redirectToInstallPage
• Add sign batch feature:
  • preauthorizeSignatures
• Add download and directory selection features:
  • showFolderBrowser
  • downloadToFolder
  • openFolder
• Add RestPKI sign integration:
  • signWithRestPki

* Methods supported only on Windows. For more information see Web signatures article.