API key creation

Users can create Client Credentials in PDX for the PDX External API. The creation of API keys is an OAuth 2.0 authentication flow called the 'Client Credential flow.' These client credentials can be used by clients to authenticate themselves when interacting with PDX through the External API.

The generated API key is a confidential value known only to the client and the PDX authorization server. It serves as a form of authentication for the client, proving its identity to the PDX server. With this feature, PDX Account Administrators are able to create ‘Client credentials’ in the 'API keys' section of their account settings. In this flow, the client application presents its client credentials to the PDX authorization server to obtain an access token directly. The access token can then be used by the client to access the PDX application.

Select the API keys option after opening the Profile and account settings option from the 'person' icon. This will open the 'API keys' screen. Click the 'Create API key' button to add a new key.

An API key can now be created or deleted. A user can register a Name, description, and a ‘Source system id,’ but only ‘Name’ is mandatory.

Note: ‘Source system id’ is used to specify the import source. This field is not mandatory and should only be used if the user wishes to separate the attributes in an import. If attributes should not be separated, leave the field ‘Source system id’ blank.

Clicking ‘Create API key’ will generate an ‘Id’ and ‘API key.’

Important: Make sure to copy the API key before clicking 'Ok' as the key will not appear again.

Once the key has been created, it will appear in the API keys tab. The user can click the hamburger icon to create a new key () or delete () an existing key.

Specifying a source when importing products into PDX

Now, a source to display on the attributes in PDX can be registered when importing products into PDX using the API. The name of the source displays in parentheses next to the name of the attribute. Below is an example of the name of the source displayed next to the name of the attribute.