# 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](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) 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:

![](/files/1M0k2lt6Pm1EE09ctd2z)

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

![](/files/ojlJjQpxBlvCFBooICo6)

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

![](/files/10DlILX7YcSbsStik3oK)

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

![](/files/ZxRStYHHZuz92qWxgATu)
{% 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/akeneo-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.