Getting started with the API

Summary

#Prerequisites

The Supplier Data Manager API is available exclusively to customers of the Supplier Data Manager (SDM) platform. If you're not yet a customer and would like to get access, please contact your Customer Success Manager (CSM) to learn more about how to get started. Once you have access, the API allows for seamless integration and automation of your product data processes.

So this guide is for you if you have:

  • An active user account on the Supplier Data Manager (SDM) platform
  • A project (in the user's organization)
  • One or more output formats defined

#Step 1: Get your token

The API requires a token, you can generate one by calling this endpoint:

POST https://sdm.akeneo.cloud/api/v1/auth/token/
    {
        "email": "customer@company.com"
        "password": "MySecurePassword",
        "token_name": "any name"
    }

The token_name key can be arbitrarily decided, it is only used for administrative purposes.

The email and password keys must be those of your user account

The response contains the key in UUID v4 format:
    

{
    "key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}

This key allows you to authenticate on all SDM API endpoints, so it must be kept secret. From this stage, all requests must be authenticated by passing the token in the headers:

Authorization: Token ${key}