Skip to main content

Create and manage API keys

You can now create new API keys in Data Platform for both project groups and individual projects. Go to Data Platform > Projects > API Access to generate, copy or delete an API key.

API keys

An API key:

  • authenticates your account when using public APIs
  • grants access to specific functionality
  • applies settings such as rate limits

The account API Keys can be used to access all project groups and projects within this account.

Create a project group API key​

Project group keys give access to all projects in that group.

  • Under Project Group API Keys, click Add new API key.
  • Enter a name (for example, Main key).
  • Copy the generated key and use it in your integration.

Create a project API key​

Project keys give access to one specific project.

  • Under Project API Keys, click Add new API key.
  • Enter a name (for example, Secondary key).
  • Copy the generated key and use it in your integration.

Keys can be rotated on demand to improve security. Simply create a new key, update your integration, and delete the old one.

Authentication Methods​

Method 1 - Query Parameter (apiKey)​

Used by Product Data endpoints (batch upload steps 1–3).

Append the key directly to the request URL:

https://api.data.zoovu.com/products/batch/initiate?projectId=YOUR_PROJECT_ID&apiKey=YOUR_KEY

No additional headers are required.

Method 2 - Authorization Header (apiKeyHeader)​

Used by Ontology Management endpoints and some Product Data endpoints (incremental update, delete, list projects).

Pass the key as a request header:

authorization: YOUR_KEY

Do not add any prefix such as Bearer - simply pass the key value.

Testing Endpoints​

Using the page ("Try it" panel)​

Each endpoint page on docs.zoovu.com includes a Send API Request panel on the right-hand side.

  1. Expand the Auth section
  2. Paste your API key into the field
  3. Fill in any required parameters (e.g. projectId from Data Platform > Projects)
  4. Click Send API Request
  5. The response appears below

The panel may occasionally return a 401 No token set error immediately after a documentation update, due to caching. If this happens, use the manual curl method below.

Manual testing with curl​

If the panel does not work, use curl from your terminal. This bypasses any caching issues and gives a reliable result.

  1. Generate an API Key for your project in Data Platform > Projects.
  2. Save the key value. You will not be able to copy it later.
  3. Paste the key value at the end of the query (replacing YOUR_KEY).

For query parameter endpoints:

curl -X POST "https://api.data.zoovu.com/products/batch/initiate?projectId=YOUR_PROJECT_ID&apiKey=YOUR_KEY"

For header-based endpoints:

curl -X GET "https://api.data.zoovu.com/projects?projectId=YOUR_PROJECT_ID" \
  -H "authorization: YOUR_KEY"

A successful response looks like:

{
  "status": "success",
  "message": "You can now send batches of the full update"
}

Troubleshooting​

  • 401 - No token set The API key was not received. Check that you are using the correct authentication method for the endpoint (query param vs. header) and that the key field is not empty.

  • 401 - You are not allowed to access the requested resource The key was received but does not have permission. Verify that the key has access to the project ID you are using.

  • 200 via curl but 401 in the docs panel - This is a known caching issue following a documentation update. Use curl for testing until the panel refreshes. If the issue persists, contact Zoovu Support.