API Developer Documentation and Resources

ZenQMS provides a REST based API for client developers to connect ZenQMS account data to their other tools/platforms. These APIs are developed/validated per the ZenQMS SDLC. The article below outlines the process for configuring and testing your API connection.

At the moment this is limited to transactions in Issues, Change Control, and Tasks modules.

ZenQMS does not provide coding resources/support beyond the help articles and the Swagger open API documentation.

We currently do not offer any preconfigured app integrations/plug ins.

The URL's below have been created to assist you in configuring your ZenQMS API:

Production Public API Connection:  https://public-api.zenqms.com/

Sandbox Public API Connections:  https://public-api-sandbox.zenqms.com/

Enabling a User to Configure an API

The first step in this process is to ensure your user has the permission to access the API Settings within the Settings module. An Account Super User will need to add you to a role with the "Account API Settings" permission enabled. 

To do this, navigate to your target environment (app.zenqms.com or sandbox.zenqms.com) and click on the Settings icon:

Under Account, click Roles/Permissions:

Create a role with the Account API Settings permission box checked/enabled, or add this permission to an existing role:

The Account API Settings permission will allow users to configure your SSO solution within the target environment. 

Configuring your API Connection

As a reminder, the URL's below have been created for you to connect to the ZenQMS API:

Production Public API Connection:  https://public-api.zenqms.com/

Sandbox Public API Connections:  https://public-api-sandbox.zenqms.com/

Now that you have enabled your user by adding the appropriate Account API Settings permission to a role, you may start configuring your SSO solution. 

Navigate to your target environment (app.zenqms.com or sandbox.zenqms.com) and click on the Settings icon. Under Account, click API Settings:

Select the Create Token button in the upper left hand side of the page: 

Enter Token Name and sign to agree to terms and conditions. 

You will now receive an "API Token successfully created" window with important information. For security reasons, the full API secret and token is shown only once. You’ll need to copy it somewhere safe before continuing.

Now that you have copied your API Secret and Token successfully, select Configure API Settings:

You may now configure the connections to the specific Change Control and Issue Categories you want to interface with. 

Under API Settings, you will see a blue link titled "Add Allowed IP". This allows you to restrict which IP addresses may access your API connection. You may add multiple IP addresses. 

You will now select the Change Control or Issue Categories you want to interface with. You will select access by checking the radial button in the row of the category. You will need to select "Read" or "Read/Write" to add a connection: 

You will now see the connection created in the API Settings table.

Important Step:  You will need to enable the API connection by turning it on under the "Status column. Select the switch next to your connection to enable the connection. It will show green when active. If you ever need to disabled the connection, switch it off:

If you ever need to refresh or regenerate your API Secret and Token, go to this table and select the refresh icon next to the Status column. This will provide you with a new API Secret and Token. Remember, copy them and keep them in a safe location:

Testing Your API Connection

As a reminder, the URL's below have been created for you to connect to the ZenQMS API: 

Production Public API Connection:  https://public-api.zenqms.com/

Sandbox Public API Connections:  https://public-api-sandbox.zenqms.com/

You may use the ZenQMS Public API site for testing your connection.

Select "Authorize" to enable your connection:

Enter your saved token here:

Test Example #1:  /v1/get-by-key/{key} Get item by key

After authorizing my connection, I selected a change control key from my Change Control Full Table. In this example, I chose "Gen-3". I then select "Execute". In the response body, I receive the change controls id(guid), name, and type:

For Reference: API Settings - READ Transaction in Issues, Change Control and Tasks