Getting an API Key

First, check that you can see this function in your OpenProcess set up screen:

API developer access function

If this is not present and you believe you're licensed to use the APIs, please log a support ticket via help.ieg4.com

Second, you need to ensure that your user is associated with a group that has the appropriate permission to create an API key, namely:

Api Administrator

Once done you can now create an API key.

Creating an API Key

The List of api keys screen shows an API keys that already exist:

List of API Keys

To create a new API key click on the 'Add' button. This will then present the following:

Naming the API key

The Name of the API will be shown on any updates made so please be sure to use a name that makes it really clear that the update was API based.

E.g. Chatbot Update, External Form Update, Automated Web hook from Alloy etc.

On pressing save the API key details are displayed.

IMPORTANT

These details are not shown again so be sure to copy these details down and store them somewhere securely. If you lose the details, you should access the list of API key screen and delete the API key you created and create a new one.

You can use these details in the OpenProcess Swagger UI endpoint if you want to test/try them out e.g. test is:

Swagger UI

OpenProcess TEST Swagger UI endpoint