Integrating Third-Party Applications

Important: The API Keys add-on is included in your Policy & Procedure Management license, but it is not enabled by default. To enable it, contact NAVEX Customer Support by submitting a request in the Community.

API keys allow programmers to integrate third-party applications with Policy & Procedure Management documents through the Policy & Procedure Management API. Using the API only gives access to documents assigned to the All Users or Public security level. Documents assigned Restricted - High or Restricted - Severe, as well as assessments and campaigns, are not accessible.

Generate an API Key

To generate an API Key for the developer responsible for doing custom programming, do the following:

  1. Click Settings & Tools > IT Settings, and then click API Keys.
  2. Click New.
  3. For Display Name, type a name for your own use in managing keys.

    The Key field is not editable. A key will automatically generate when you save the form.

  4. (Optional) To limit the IP addresses that can log into Policy & Procedure Management, in the IP Range(s) field, type one or more IP ranges.

    You can use both IPv4 (32 bit) and IPv6 (128 bit) IP address formats to specify a range. Type the lower limit of the IP range first, followed by a dash and then the upper limit of the IP range. To include multiple ranges, separate each range with a comma. Do not include a space before or after the comma.

    • IPv4 addresses are represented as four numbers separated by periods where each number can be zero to 255, such as 1.160.10.240.

    • IPv6 addresses are represented as eight groups of four hexadecimal digits separated by colons, such as 2001:0db8:85a3:0042:1000:8a2e:0370:7334.

  5. For Sites, select only those sites you want the API to have access to.
  6. If desired, select the Automatically select new sites as they get created check box.
  7. Click Save. The key generates and is displayed in the Key field.
  8. Copy the key and send it to the developer who will be doing the custom programming.

Regenerate or Delete a Key

If you ever feel that a key has been compromised, disable the key by regenerating or deleting it.

  1. Click Settings & Tools > IT Settings, and then click API Keys.
  2. Click the key name to show its details.
  3. Do either of the following:

    • To regenerate the key, click to the right of the Key field, and then copy and send the new key to the programmer.

    • To delete the key, click Delete, and then follow the prompts to back up the Policy & Procedure Management database. When the backup is finished, in the Delete API Keys window, click Yes. Then create a new key if necessary.