Commercetools (prebuilt connector)

To view this content in our official product documentation, click here.

Description

Commercetools provides all composable components needed to build and run shopping experiences.

API documentation

API documentation for Commercetools (used to build this connector) can be found via the link below:

{% embed url="https://docs.commercetools.com/api/" %}

Authentication

When adding connector instances for Commercetools, the following authentication methods are supported:

• OAuth 2 (client credentials)

OAuth 2 (client credentials)

{% tabs %} {% tab title="Credentials" %} When a user chooses to add a connector instance using OAuth 2 (client credentials) authentication, the credentials below are prompted:

Credential	Required?	Notes
Scope	true	The scopes selected when your API client was created for Patchworks (via the Commercetools dashboard). Multiple scopes should be separated by spaces.
Client ID	true	The clientid generated when your API client was created for Patchworks (via the Commercetools dashboard).
Secret	true	The secret generated when your API client was created for Patchworks (via the Commercetools dashboard).
Project key	true	The unique project key for your Commercetools environment.
Commercetools server region	true	The server region to be used for token requests. The default is europe-west1.gcp.
Grant type	true	Set to client_credentials.
Response authentication token key	true	Set to access_token.
Client type	true	Set to confidential.

{% endtab %}

{% tab title="Obtaining credentials" %}

Project key

Your unique project key forms part of the URL that you use to access Commercetools - for example:

In this example, our project key is product-patchworks.

Server region

Your server region forms part of the URL that you use to access Commercetools - for example:

In this example, our server region is europe-west1.gcp.

Client id, Client secret, Scope

These details are generated when you add an API client to your Commercetools implementation, for Patchworks. These details are only displayed once therefore, they should always be added to a password manager for later use.

If you don't have an existing API client for Patchworks, you can create one. To do this, follow the steps below.

Step 1\ Log into Commercetools

Step 2\ Select settings from the left-hand navigation bar:

Step 3\ Select developer settings:

Step 4\ Click the create new API client button:

Step 5\ Enter a name for this client and then select the required access scopes:

Step 6\ Create the API client. {% endtab %} {% endtabs %}