Get your API Client

Create an API Client for your commercetools Project

Before your applications can interact with your commercetools Project, you must first set up an API Client.

API Clients include authentication information and permission scopes to determine what endpoints the API Client can interact with.

Objectives of this guide

By the end of this guide you will have:

  • Created an API Client
  • Saved your API Environment Variables file

Create an API Client

  1. Log in to the Merchant Center.
  2. Go to Settings > Developer settings.

A screenshot of the Developer settings options

  1. Click Create new API client.

A screenshot of the API clients page

  1. Enter a name for your API. The name does not affect how the API functions.

A screenshot of the API Client name

  1. Select what scopes your API Client uses. Use the drop-down list and choose Admin client to provide the API Client with complete access.

A screenshot of the API Client scopes

  1. Click Create API client.

A screenshot of the Create API Client button

View your API Client configuration

API Client information is only displayed once.

Ensure that you save the project_key, client_id, secret, scope, API URL, and Auth URL before leaving or closing this page.

Your API Client information is listed under Client credential flow.

Client credential flow

Save your API environment variables file

Not only can you can manually save your API Client information, but a drop-down list contains options for downloading your API Client configuration in a format-friendly way for various programming languages.

These configurations can be copied to your clipboard or downloaded.

  1. Select Environment Variables (.env) from the drop-down list and click the download icon.

Download Environment Variables

  1. The environment variables file is downloaded to your computer with a placeholder name based on your Project key, such as env.your-project-key_credentials.

The environment variables file is a plain text file and can be opened with any text or code editor.

  1. Open your downloads folder and rename the environment variables file .env.
Developer Center
HTTP APIGraphQL APIPlatform Release NotesCustom ApplicationsBETASDKs & Client LibrariesImport & ExportSUNRISE Starter FrontendsTutorialsFAQ
Merchant Center
DocumentationRelease Notes
Sign upLog inTech BlogIntegrationsStatusSupportUser Research Program
Copyright © 2022 commercetools
Privacy PolicyImprint