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. 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
Users will need the role permission 'Account API Settings' to access this section of the account. All admins automatically have this permission in the 'Administration: Account Super User' role.
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/
Navigate to your target environment (app.zenqms.com or sandbox.zenqms.com) and click on 'Settings >API Settings'. Select the 'create token' option. Enter the token name and click 'create'.
Review the legal information and click 'sign', when ready.
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 that are available. Under the 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 module you want to interface with. You will select access by checking the radial button in the row of the item. You will need to select 'Read' or 'Read/Write' to add a connection. Click 'save' when finished.
After successfully saving the this information you will see the connection 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. 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. You may use the ZenQMS Public API site for testing your connection.
Production Public API Connection: https://public-api.zenqms.com/
Sandbox Public API Connections: https://public-api-sandbox.zenqms.com/
Select 'Authorize' to enable your connection.
Enter your saved token and click 'authorize'.
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