NEW ZenQMS API Configuration

We are happy to offer further advances with our ZenQMS API. This is a feature that allows administrators to set up integrations with ZenQMS.

Settings - READ Transaction in Issues, Change Control and Tasks

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/

 

Recommendation Always configure and test in your Sandbox environment before implementing in Production. 

 

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. 

  • Navigate to your target environment (app.zenqms.com or sandbox.zenqms.com).
  • Navigate to the Settings module.

Settings_module.png

  • Navigate to Settings > Account > Roles/Permissions

roles_permissions.png

  • Create a role with the "Account API Settings" permission box checked/enabled. Or add this permission to an existing role. 

api_setting_permission.png

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

Configuring your API Connection

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).
  • Navigate to the Settings module.
  • Navigate to Settings > Account >API Settings.

api_settings.png

  • Select the "Create Token" button in the upper left hand side of the page. 

create_token.png

  • The following information is required to configure your API Setting:
    • Name (Create Name for Token)
    • Entity ID
    • Single Sign-On Service URL
    • X.509 Certificate
    • Email Attribute
    • Select How Users Will Execute Signatures 

create_token_name.png

  • 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.

api_token_created_successfully_2.png

  • Now that you have copied your API Secret and Token successfully, select "Configure API Settings".

configure_api_settings.png

  • You may now configure the connections to the specific Change Control and Issue Categories you want to interface with. Please note, you may only create read connections for change controls, issues, and tasks at this time. We have one write connection available at this time for replacing/updating the custom field (single select or multi select) options of the latest active version of the category. Further development and additional capabilities are coming in the future. See:

patch_write.png

  • 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. Please note, if your IP address changes, you will lose your connection to the API. 

Add_allowed_API.png

  • 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. 

select_api_connection.png

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

api_connections_in_table.png

  • Important Step:  you will need to enabled 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. 

status_switch.png

active_connection.png

  • Important Note:  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. 

refresh.png

refresh_token.png

 

Testing Your API Connection

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.

authorize.png

authorize_test.png

  • Enter your saved token here.

authorization.png

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

get_item_by_key.png

  • 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. 

execute.png

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.