# ChannelEngine (prebuilt connector)

## Description

**ChannelEngine** ensures product info and stock levels are synchronised across marketplaces - syncing product information, product data and stock information across channels.

## API documentation

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

{% embed url="<https://support.channelengine.com/hc/en-us/articles/4409515268637-Merchant-API-before-you-start>" %}

Swagger documentation is available by composing your own company-specific link (using your ChannelEngine tenant subdomain) as below:

{% code lineNumbers="true" %}

```
https://<tenant subdomain>.channelengine.net/api/swagger/index.html
```

{% endcode %}

For example:

{% code lineNumbers="true" %}

```
https://patchworks-dev.channelengine.net/api/swagger/index.html
```

{% endcode %}

## Authentication&#x20;

When adding connector instances for **ChannelEngine**, 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](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) 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>Environment</code></td><td>true</td><td>This is your ChannelEngine tenant subdomain. For example:<br><code>patchworks-dev</code></td></tr><tr><td><code>Token</code></td><td>true</td><td>This is the API key generated from the ChannelEngine dashboard. </td></tr></tbody></table>
{% endtab %}

{% tab title="Obtaining credentials" %}
**Finding your environment**

**Step 1**\
Log into the ChannelEngine dashboard.

**Step 2**\
Note the subdomain in the URL - this is your environment setting:

<img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FMcTCYF3XO5oMF3jnAUs5%2Fchannelengine%203.png?alt=media&#x26;token=1e3dde9a-619c-445d-95ff-84b78a90f812" alt="" data-size="original">

\
**Finding your token**

**Step 1**\
Log into the ChannelEngine dashboard.

**Step 2**\
Select **settings** from the left-hand navigation bar, then **merchant API settings**:

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FedC3Bsao8S1DIZlVc9Ov%2Fchannelengine%201.png?alt=media&#x26;token=94161fa3-fe6c-40d9-9cef-3577d38c41ee" alt="" width="319"><figcaption></figcaption></figure></div>

**Step 3**\
Existing API keys are displayed:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FEAoAhQrhxgLdW4hxphyR%2Fchannelengine%202.png?alt=media&#x26;token=880c97c1-8920-4946-bd94-13ff19964728" alt=""><figcaption></figcaption></figure>

If necessary, you can add a new one for Patchworks. &#x20;
{% endtab %}
{% endtabs %}