Platform API
The Platform API is used to upload, update, and retrieve product data. It can also be used to implement product search and to display related products on your product detail pages.
Authentication
Some endpoints are public and do not require authentication. Endpoints that require authentication will have an "Authorize" button in the top right corner of the documentation.
Authentication is handled via a bearer token included in the Authorization header of your request. The header should look like this:
Authorization: Bearer YOUR-TOKEN-HERE
A token will be generated for you. If you do not yet have a token for your account, please contact [email protected].
Please make sure that your token is never visible to others, e.g., within a browser inspector view. To ensure your token remains private, you should proxy all requests through your own backend.
Additional Authentication
You can also secure public endpoints with a token. If you wish to secure all endpoints, please contact [email protected].
Projects
All endpoints require a project-id. The project identifies the data source that should be used for your request. If you are using the project-id of a German data source, the results will be returned in German. You can find the project-id for all projects associated with your account within the Data Platform under Projects. You can also use the List projects endpoint to retrieve all projects connected to your token or by tags. You can configure your project tags in the Zoovu Data Platform.
Getting Started
If you are using the Platform API to push your products into your Data Platform project, you need to follow the following steps:
- Initiate a full update
- Upload a batch of products
- Commit the full update
After this, you will find your products in the Data Platform and, if relevant, in Search Studio.
Authentication
- API Key: apiKey
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | authorization |
License
Zoovu