Generating an API key for SCV API
The API key is used to authenticate requests and should not be shared with anyone who should not have access to it.
| The API key is sensitive information and should be treated like a password. Do not share the API key with anyone who should not have access to the SCV API, including exposing the API key in client-side code or public repositories. |
Prerequisites
Before generating an API key for use with SCV API, you must;
-
Be a Squiz DXP user in the organization within which you need to generate the key.
-
Be an Owner or Admin on the Squiz DXP organization.
Generating an API key
For a general overview of creating and managing API keys in Squiz DXP, see API keys.
The Single customer view section includes the two permissions needed to use the SCV API.
- CUSTOMERS_SCHEMA_READ
-
Allows you to retrieve customer schema information.
This is the minimum permission level required to pull information from Single Customer View.
- CUSTOMERS_SCHEMA_UPDATE
-
Allows you to write and update files to the customer schema.