Pular para o conteúdo principal

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.8 (2026-11-06)​

Since lib 2.20.0. Requires native components 2.17.0 (Windows, macOS, Linux).

1.8.7 (2026-10-17)​

Since lib 2.19.0. Requires native components 2.15.0 (Windows, macOS, Linux).

1.8.6 (2026-02-03)​

Since lib 2.18.0. Requires native components 2.14.0 (Windows, macOS, Linux).

1.8.5 (2026-01-26)​

Since lib 2.17.0. Requires Windows native component 2.13.2.

  • Add the caCertificates option to importCertificate and importTokenCertificate, which also imports the CA certificate chain into the system CA store and into the token or PFX file (Windows only)

1.8.4 (2025-11-10)​

Since lib 2.16.5. Requires Windows native component 2.12.7.

  • Require .NET Framework 4.6 or later on Windows (previously 4.0)

1.8.3 (2025-10-02)​

Since lib 2.16.4. Requires Windows native component 2.12.6 and macOS native component 2.13.5.

  • Treat *.localhost domains (RFC 6761) as localhost, so they can use Web PKI without a license (Windows and macOS)
  • Fix importCertificate on Windows failing when an unrelated key container could not be opened, and fix saving its PKCS#12 (PFX) backup
  • Fix listCertificates on macOS failing entirely when a PKCS#11 token cannot be read

1.8.2 (2023-11-23)​

Since lib 2.16.3.

1.8.1 (2022-12-17)​

1.7.2 (2022-07-03)​

1.6.1 (2020-05-23)​

1.6 (2019-10-13)​

1.5.2 (2019-07-19)​

1.5 (2018-11-27)​

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

1.4.1 (2018-06-15)​

1.4 (2018-02-23)​

1.3 (2017-11-10)​

  • Add improved error handler with exception model

1.2 (2017-06-19)​

1.1 (2016-08-19)​

1.0 (2015-04-28)​

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

View as Markdown