Keyfactor API

The Keyfactor APIClosed A set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. is the Web APIClosed A set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. introduced in Keyfactor Command version 6.1. It is designed to support the updated platform architecture in the new version of the main Keyfactor Command solution and to, in time, replace the Classic API. The Keyfactor API allows for integration with other systems to automate certificate lifecycle management tasks. It will continue to be developed going forward to expose more core functionality that is built into the main product to allow for more in-depth integrations.

Documentation for the Keyfactor API is available as two companion pieces—this document (the Keyfactor Web APIs Reference Guide), which provides an overview of the API's endpoints, parameters to be provided in them, and data expected back from them, and the interactive code examples installed with your Keyfactor Command instance in the Keyfactor API Endpoint Utility.

Tip:  Click the help icon () at the top of the Keyfactor Command Management Portal page next to the Logout button to find the embedded web copies of the Keyfactor Command Documentation Suite and the Keyfactor API Endpoint Utility.

Figure 424: Documentation in the Help Dropdown

You can also browse to the Keyfactor API Endpoint Utility directly using the following link (where keyfactor.keyexample.com is the fully qualified domain name of your Keyfactor Command server or the DNSClosed The Domain Name System is a service that translates names into IP addresses. alias you are using to reference your Keyfactor Command server, if applicable):

https://keyfactor.keyexample.com/KeyfactorAPI/ref/index#

This link assumes that the Keyfactor API has been installed in the default IIS virtual directory (KeyfactorAPI). If you have installed in an alternate virtual directory, your path will be different.

A static reference (without the interactive utility you can find in the Keyfactor Command Management Portal) is available as a zip file in the Keyfactor Client Portal1.