How to set up and edit API configurations

Establishing connection to Struct PIMs API.

Getting started

To create a new API configuration, navigate to the API configurations page in the PIM system and click on the "Create API Configuration" button located in the top right corner.

API configuration page

This will present you with the API configurations setup page.

API configurations setup page

To configure the API, first assign a name to the API key for identification purposes. The subsequent fields, "API Key" and "API URL," should contain the generated key and the URL where the API is accessible.

Afterwards you will have the options to specify what kind of access to grant the API key.

When you are done with the configurations you can click the "Save"-button in the bottom right to save and generate the key.

Example of API configurations

In the example below you will see the API key generated, which is needed in order to access the API endpoints. The name of the API key is to clarify that it is made for testing.

Example of API configuration

Last updated