# 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:

{% embed url="<https://devdocs.magento.com/redoc/2.3/>" %}

## Authentication&#x20;

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

* [Token authentication](#token-authentication)

### Token authentication

{% tabs %}
{% tab title="Required credentials" %}
When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **token** authentication, the credentials below are prompted:

<table><thead><tr><th width="193">Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>URL</code></td><td>true</td><td>Displayed immediately after creating a new integration in the Magento admin console.</td></tr><tr><td><code>token</code></td><td>true</td><td>Displayed immediately after creating a new integration in the Magento admin console.</td></tr></tbody></table>
{% endtab %}

{% tab title="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:

![](/files/urWBWHPIF6YOWZJg2P3N)

**Step 3**\
Click on **integrations** under the **extensions** header. This will load the following page:&#x20;

![](/files/cPp6cbHJdzQluSE21eeb)

**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':

![](/files/NKmu9hE2DxF8f6vp4aid)

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

![](/files/apMUSuudoHqxKo6UPurP)

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

&#x20;![](/files/xjuoTxBW6pqcgAC24hzs)

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

![](/files/DfOxZ96SqcJr2TihwJnb)

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

![](/files/2Y8kdv0N2ob9taiBxwVV)

{% hint style="info" %}
The **access token** is required for Patchworks, but it's worth logging all token information returned here. &#x20;
{% endhint %}

#### 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/
```

{% endtab %}

{% tab title="Additional setup" %}

#### Tokens&#x20;

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:\
&#x20;![](/files/CgotTgooxt0ZBPWaJswj)

**Step 4**\
Expand the **services** navigation option and select **OAuth**:

![](/files/UZfyCJCZQKaoD5y97APM)

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

<figure><img src="/files/YXU1hv1MPJHSNaIyn5sm" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/adobe-commerce-magento-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
