Adobe Commerce - Magento (prebuilt connector)

Description

Adobe Commerce (formerly Magento) is a flexible, scalable commerce platform that lets you create uniquely personalised B2B and B2C experiences.

API documentation

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

REST API reference | Adobe Commerce Developer Guide

Authentication

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

• Token authentication

Token authentication

Required credentials

When a user chooses to add a connector instance using token authentication, the credentials below are prompted:

Credential	Required?	Notes
URL		Displayed immediately after creating a new integration in the Magento admin console.
token		Displayed immediately after creating a new integration in the Magento admin console.

Obtaining credentials

Token

To obtain the token (actually an access token) required for Patchworks to access your Magento 2 data, you must create an integration. To do this, follow the steps below.

Step 1 Log into your Magento admin console.

Step2 Click on the system button with a cog icon to open the menu:

Step 3 Click on integrations under the extensions header. This will load the following page:

Step 4 Click on add new integration to start adding a new integration.

Step 5 Provide the required information in the first form. We suggest setting the name as 'Patchworks':

Step 6 Click API under basic settings and assign the required permissions:

Step 7 Click save. You will then be taken to the below page:

Step 8 Click activate for the integration you just saved and when prompted, confirm that the permissions are correct:

Step 9 Click allow to display integration tokens - add them all to your password manager, ready for use in your Patchworks setup:

The access token is required for Patchworks, but it's worth logging all token information returned here.

URL

To find the URL required to add a Patchworks connector, log into your Magento 2 admin console and check the URL in your browser's address bar. You need everything up to and including 'magento.com' - for example:

https://www.acme-magento.com/

Additional setup

Tokens

If you are using Magento 2.4.4 or later, the allow OAuth access tokens to be used as standalone bearer tokens option must be set to yes. To do this, follow the steps below.

The steps

Step 1 Log into your Magento admin console.

Step2 Select stores from the navigation menu:.

Step 3 Select the configuration option:

Step 4 Expand the services navigation option and select OAuth:

Step 5 Set the Allow OAuth Access Tokens to be used as standalone Bearer tokens option to yes: