The Supplier Data Manager (SDM) REST API lets you automate product data workflows: uploading files, creating and monitoring jobs, and retrieving processed output. This guide covers how to authenticate and obtain a token so you can start making API calls.
For a full reference of all available endpoints, see the SDM API reference.
Prerequisites
To use the Supplier Data Manager REST API, you need:
- An active user account on the Supplier Data Manager platform
- A project in your organization
- One or more output formats defined for that project
Email and password authentication must be enabled for your organization. If your organization uses Single Sign-On (SSO), contact your Akeneo administrator to confirm whether API access via email and password is available.
If you do not yet have access to the Supplier Data Manager, contact your Customer Success Manager (CSM) to get started.
Step 1: Get your token
To authenticate with the Supplier Data Manager REST API, request a token by calling the following endpoint:
POST https://sdm.akeneo.cloud/api/v1/auth/token/
Request body:
{
"email": "customer@company.com",
"password": "MySecurePassword",
"token_name": "any name"
}
-
emailandpassword— your Supplier Data Manager user account credentials -
token_name— a label for identifying the token (used for administrative purposes only; choose any meaningful name)
Response:
{
"key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}
The key is a UUID v4 token. This token must be kept secret — it authenticates all subsequent API requests on behalf of your account.
Calling the endpoint with the same token_name returns the existing token rather than creating a new one. To create a separate token, use a different token_name value. Tokens do not expire by default unless an expiration has been configured by your administrator.
Step 2: Authenticate your requests
Include the token in the Authorization header of every API request:
Authorization: Token YOUR_KEY_HERE
For example, to list your projects:
GET https://sdm.akeneo.cloud/api/v1/projects/
Authorization: Token XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
All Supplier Data Manager API endpoints require this header.
Next steps
With authentication in place, you can use the SDM REST API to create and monitor jobs, upload product data files, and manage option collections. See the other articles in this section for step-by-step guides on each of these scenarios.
For the complete list of endpoints, parameters, and response schemas, see the SDM API reference.