API Keys management

To manage the platform API Keys, you must go to the Administration menu and click on API Keys. This section of the platform administration allows you to create and manage your API Keys.

The API Keys management is restricted to specific roles. If you do not have access to this part of the platform and need to manage account configurations, please contact your administrator.

API Keys list

API Keys list

In the API Keys list screen, you can:

  • Filter the list to view a more restricted list of API Keys or perform a search.

  • Create a new API Key. For more details on creating an API Key, please refer to the section API Key Creation

By selecting a specific API Key from the list, you can:

  • Display the entire history of the selected API Key. All changes made to the API Key since its creation are listed with the corresponding dates and the identity of the modifier.

  • View all the API Key details listed in the Detailed API Key information section.

  • Edit the information of the selected API Key.

  • Revoke an API Key. A confirmation window will appear. Once revoked, the key will no longer appear in the list. The action is final, please perform it with caution.

Detailed API Key Information

For each API Key, the following information is available:

  • Name: the name given to the API Key.

  • Description: short description given of the API Key.

  • Belongs to: the organization to which the API Key belongs.

  • Client ID: the unique identifier of the API Key used in pair.

  • Accessible organizations: list of organizations to which the API Key applies.

  • Roles: list of roles applied to the API Key.

API Key Creation

API key creation screen

When creating a new API Key, you need to specify all of the following fields:

  • Name: the name given to the API Key.

  • Description: short description given of the API Key.

  • Belongs to: the organization to which the API Key belongs.

  • Accessible organizations: list of organizations to which the API Key applies.

  • List of roles you want to assign to the API Key. Please take note of the different roles available in the platform before assigning them. You can also create your roles.

To choose more than one item in a list, please keep the control key (Ctrl) depressed while clicking a new item in the list with your mouse.

Once the API key is created, a popup will appear with a Client Id and API Key.

Make sure to copy the API Key value and store it somewhere safe as this is the only instance where it will be displayed and it is not recoverable afterwards.

API Key example

Limit

The number of API Keys is limited to 5 per organization. Existing API Keys need to be revoked to create new ones once the limit is reached.

Attempting to create API keys past the limit will fail and display the following error:

API Key error

To create new API keys when the limit is reached, existing active keys need to be revoked. See the Revoke an API Key section.

Usage

API Keys are the responsibility of the client; we recommend enforcing a 90-day rotation for every API Key.

Authorization header

To make API calls to IPC Wire Services, both the API Key and Client ID are used for authentication. They must be included in the Authorization header. The header has the following format:

Prefix “Apikey “ (with a space) + the API Key + period (.) + Client ID

'Authorization': 'Apikey apikey.clientid'

Example:

API Key: rPEQ1zitNVoADR0VjnY1TGcwk7pgBZpxvi0wb5lCer0jyouSdkbmzQ

Client ID: WPiMTcYN9BkQF6F4wwU6K6Pxzgsoa2PfgeqNeNr-qJo

Header:

'Authorization': 'Apikey rPEQ1zitNVoADR0VjnY1TGcwk7pgBZpxvi0wb5lCer0jyouSdkbmzQ.WPiMTcYN9BkQF6F4wwU6K6Pxzgsoa2PfgeqNeNr-qJo'

Request:

curl --location --request GET 'https://{api.url}/v1/transactions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Apikey rPEQ1zitNVoADR0VjnY1TGcwk7pgBZpxvi0wb5lCer0jyouSdkbmzQ.WPiMTcYN9BkQF6F4wwU6K6Pxzgsoa2PfgeqNeNr-qJo'