Generating an API key in the Seller Portal allows you to securely connect external systems or applications to your marketplace. Each key is unique and linked to your organization, and you can control exactly what it can do by selecting scopes when you create it.
How to generate an API key in the Seller Portal
You must generate an API key to use the API.
- In the Seller Portal, go to Extensions > API Access. The API Access & Documentation page opens with a list of existing API keys.
- In the Create new API Key section, fill in the key details:
- Description: Enter a unique name and description that reflects the intended use of the key.
- Organization: Enter the legal name of your organization.
- In the Scopes table, select the access level your key needs for each resource:
- Select Read to allow the key to retrieve data.
- Select Write to allow the key to retrieve and modify data.
- Select Manage to allow the key to retrieve, modify, and perform destructive actions.
Tip: Grant the lowest level of access each integration needs. If a key only needs to read data, do not grant Write or Manage. Leaving all scopes unchecked grants no access — only public data will be reachable.
- After you read and understand the API license, select the checkbox beside I have read and understood the API License.
- Click Create API key. The API Key window opens showing the API key. You can only see this value once.
- Copy the key and store it in a safe place.
- Click Close.
Note: You can no longer retrieve the key after you close this panel and browse away from this page.
For more on what scopes are and how to choose them, see API key scopes overview.
If you are using the API, see our API documentation.
Related articles