API Key Admin

The API Key Admin function is only available when you connect to the system partition. You need to use PlatformManager and its Remote Login to access the system partition:

Once you log into the system partition, you access the API Key Admin page from the System Admin menu. On this page you can create API keys that can be used by an external application to make API calls to Pricefx endpoints.

The list of API keys is displayed in a table which is in-line editable.

To add a new API key:

  1. Click the New API Key button.

  2. Fill in the following fields:

    • Label – Enter the label of the new API key.

    • Expiry – Time after which the validity of the key expires (in seconds). The default is 3,600.

    • Activated

    • Renew Refresh Token – The default value is true.

    • Registration Enabled

    • Max Attempts – The default value is 0.

    • Partition Names

    • RSA Public – Enter the public RSA encryption key.

    • RSA Private – Enter the private RSA decryption key.

  3. Click the Refresh button to ensure these values stay.

Found an issue in documentation? Write to us.

 
Pricefx version 12.0