Application Customisation - API Security Key

Platform: Risk Assessment Platform

Applies to: Super Admin and Company Admin

API Security Key

This feature allows the use of an API to push data into the Data Sets configured in the Risk Assessment Platform (RAP). The data sets can be used to answer the risk analysis questions in risk assessments. 

This feature is part of the Data-Driven Assessments add-on.

Create an API Security Key

You must have purchased the Data-Driven Assessment add-on and have a role with the appropriate permissions.

1. Open the Settings menu () and select API Security Key.
2. On the new window, press the New API Key button.
3. A popup will appear displaying your API key.
4. Make sure to copy the key and store it securely.
5. Press Save.

You can now use the API security key in 

Delete an API Security Key

If your API Security Key has become compromised or is no longer needed, you can delete it.

When the key is deleted, requests to the RAP API endpoint using that key will fail.

1. Open the Settings menu () and select API Security Key.
2. On the new window, press the New API Key button.
3. Press the Delete button () beside your API key.
4. A confirmation popup will appear. Press OK.

General Information About API Security Keys

API security keys, also known as API keys or authentication tokens, are used to secure and control access to APIs (Application Programming Interfaces). APIs are a way for different software systems to communicate and interact with each other. API security keys act as a form of identification, ensuring that only authorized users or applications can access the API resources.

How API security keys are used:

1. Generate the API Key using the steps described above.
2. Include the API Key in the HTTPS requests you make to the Risk Assessment Platform API.

About Sending Requests
With the API key included, you can send requests to the RAP API endpoint for your account. The RAP API server will check the provided key to determine whether the request is authorized. If the key is valid, the server will process the request and provide the desired response.

Security Best Practices

Keep your API key secure. Treat it as a sensitive piece of information and avoid hardcoding it in your application code. Do not share your API key in publicly accessible code repositories.