# Akeneo (prebuilt connector)

## Description

**Akeneo** is a product information management and product data intelligence solution.

## API documentation

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

{% embed url="<https://api.akeneo.com/api-reference-index.html>" %}

## Authentication&#x20;

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

* [Akeneo Auth](#akeneo-auth)

### Akeneo Auth

{% tabs %}
{% tab title="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 **Akeneo Auth** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>Client ID</code></td><td>true</td><td>The <strong>client id</strong> generated for your Patchworks connection in Akeneo.</td></tr><tr><td><code>Client Secret</code></td><td>true</td><td>The <strong>client secret</strong> generated for your Patchworks connection in Akeneo.</td></tr><tr><td><code>Store URL</code></td><td>true</td><td><p>The URL used to access your Akeneo store without the <code>https//</code> element. For example: </p><p><a href="https://wob-sandbox.cloud.akeneo.com/">https://patchworks-sandbox.cloud.akeneo.com/</a> </p><p>would be entered as:<br><a href="https://wob-sandbox.cloud.akeneo.com/">patchworks-sandbox.cloud.akeneo.com/</a> </p></td></tr><tr><td><code>Username</code></td><td>true</td><td>The <strong>username</strong> generated for your Patchworks connection in Akeneo.</td></tr><tr><td><code>Password</code></td><td>true</td><td>The <strong>password</strong> generated for your Patchworks connection in Akeneo.</td></tr><tr><td><code>Response authentication token key</code></td><td>true</td><td>Set to <code>access_token.</code></td></tr><tr><td><code>Response refresh token key</code></td><td>true</td><td>Set to <code>refresh_token</code>.</td></tr></tbody></table>
{% endtab %}

{% tab title="Obtaining credentials" %}
The required credentials for adding a Patchworks instance of the Akeneo prebuilt connector can be obtained by adding an Akeneo connection for Patchworks, in your Akeneo dashboard. The steps required to add a new connection are summarised below:

**Step 1**\
Log into your Akeneo dashboard.

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

![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FcG6YvoL7dsqpWY3mtAzm%2Fakeneo%201.png?alt=media\&token=aa54bd43-0e64-4c9f-9a1d-04b0f8d0c483)

**Step 3**\
Select **connection settings** from the connect menu to access existing Akeneo connections:

![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FJBRRFVSZ5kP6AwLd5O5c%2Fakeneo%202.png?alt=media\&token=e7fcc8e7-219d-4e85-86f9-f44412d9e69a)

**Step 4**\
Click the **create** button:

![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F4Dzgbdia4pIimMLxB6QJ%2Fakeneo%203.png?alt=media\&token=80fdd1d9-5779-4233-ab25-3579954fc68c)

**Step 5**\
A new set of credentials is created for this connection and displayed in a **credentials** panel:

![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FpxO7zDo44xMOOoFTV3fY%2Fakeneo%205.png?alt=media\&token=285ebda9-f5f7-41f8-9656-3496b1235675)
{% endtab %}
{% endtabs %}