xTrace: User Profile – API Key Creation

To interact with the Open API and RMT API on behalf of a Goods Circulation Participant" (GCP), a static API key must be created. Below are the general requirements and a step-by-step instruction.

📌 General Provisions

• Each user can have only one active API key.
• An API key can only be created by a user who has the role of “Participant's API key manager”.  

🧩 Options for Adding an API Key

An API key can be created:

• for an existing business user;
• or for a new business user created specifically for integration purposes.

Step 1. Assigning the “API Key Manager of the Participant” Role

Role assignment is performed by the PTG administrator. To assign the role, the administrator must:

• Log in to the personal account (PA).
• Go to the "User Profile" section and select "Edit".

• Open the "Roles" subsection, check the box for "API Key Manager of the Participant" and click "Save".

Step 2. Creating an API Key for a Business User

The API key can be created directly by the user or administrator. To do this:

• The API key can be created directly by the user or administrator. To do this:
• Go to the "Organization Profile" section → "Users". 

• Open the profile of the required business user.
• Go to the "API Keys" tab.
• Click "Create API Key", specify the key name and its validity period. The validity period of the API key is up to 30 days.

• The generated API key will be displayed in the pop-up window.

⚠️ Important:

• Be sure to save the value of the API key in a secure place — it cannot be restored after the window is closed.
• The key ID ≠ the key value itself.

If the key is lost — delete it and create a new one by repeating the steps above.