# Connect your Hygraph project to Akeneo

Learn how to connect your Hygraph project to Akeneo

**Akeneo** is a composable SaaS-based solution that allows organizations to improve Product Experience through product information management and product data intelligence.

## What you can do with the Hygraph-Akeneo integration

With this app you can orchestrate, activate, and optimize product experiences across all owned and unowned channels, including eCommerce, mobile, print, social, points of sale, and beyond.

## Prerequisites to use this integration

- You must have a **Hygraph** account. If you don't have one, you can create one [here](https://app.hygraph.com/signup).
- You must have a [Hygraph project](https://hygraph.com/docs/getting-started/quickstart#create-a-project) with at least one [model](https://hygraph.com/docs/getting-started/quickstart#create-a-model).
- You must have an **Akeneo** account. If you don't have one yet, you can start a free trial [here](https://www.akeneo.com/start-free-trial/) or request a demo [here](https://www.akeneo.com/demo/).
- You must have your [Akeneo PIM](https://www.akeneo.com/what-is-a-pim/) ready. Your PIM is the URL of your Akeneo account. You can copy it from the browser directly; it should look similar to this `https://<YOUR-PROJECT-NAME>.cloud.akeneo.com/`.
- You must create connection settings for your Hygraph project. To do this, go to **Connect > Connection settings** in your Akeneo dashboard, and click `Create`. You'll need to provide a `Label` and a `Code` to identify the app, then use the `Flow type` dropdown to select `Data source`.
  - This takes you to your Akeneo credentials: the `Client ID`, `Secret`, `Username`, and `Password`. Akeneo will show you your `Secret` and `Password` credentials only once, so make sure you save them somewhere.

**Warning:**

**Apps are environment specific**. This means their configuration is applied per environment. Take this into consideration if you're working with a project using more than one environment.

## Install the Akeneo app

Click [here](https://hygraph.com/marketplace/apps/hygraph-akeneo-app) to install the Akeneo App on **Hygraph**, then follow these steps:

[Video: Install Akeneo app](https://eu-central-1-shared-euc1-02.graphassets.com/AvHQ3RDvFSousA8iwElOKz/Jg1MszpiR9m9zrsm7qUn)

1. Use the dropdowns to select which project and environment you want to install the app in, then click `Install app`.
2. The permissions pop-up will display. Clicking `Authorize app` finishes the installation and takes you to the app configuration screen.
3. Next, you need to configure the app. To do that, you first need to fill in your `PIM` and the `Client ID`, `Client Secret`, `Username`, and `Password`. We explained how to get this information [in the prerequisites section](https://hygraph.com/docs/integrations/connect-akeneo#prerequisites-to-use-this-integration).

   **Pro Tip:**

   - You can find these credentials by going to **Connect > Connection settings** in your Akeneo Dashboard and clicking on the connection you created as part of the [prerequisites for this integration](https://hygraph.com/docs/integrations/connect-akeneo#prerequisites-to-use-this-integration).
   - Akeneo calls `Secret` the same key that Hygraph calls `Client Secret`.
   - Akeneo will show you your `Secret` and `Password` credentials only once, so make sure you save them somewhere.

4. Click `Save config settings` to finish the configuration process. A pop-up notification in the bottom right corner of the screen will indicate that the changes have been saved.

## Add the Akeneo field to your model

[Video: Add Akeneo field to model](https://eu-central-1-shared-euc1-02.graphassets.com/AvHQ3RDvFSousA8iwElOKz/39bDNvzhTMOCx4FQyhau)

1. Navigate to the **Schema** builder.
2. Select the model that you want to add the **Akeneo** field to.
3. Select the **Akeneo** field from the **Add fields** right sidebar.
4. Complete the `Display name` field, and the `API ID` will be auto-filled by the system. Optionally, you can also add a `Description`.
5. This screen also allows you to control different properties of your Akeneo field: you can allow multiple values, or you can localize the field, by selecting the checkboxes in the `Field options` section.
6. Click `Add`.

## Use Akeneo in your Hygraph project

[Video: Use Akeneo in Hygraph](https://eu-central-1-shared-euc1-02.graphassets.com/AvHQ3RDvFSousA8iwElOKz/qtuZZ68eRkiOOpX3YwvV)

1. Navigate to the **Content** editor.
2. Select the view that you configured the **Akeneo** for.
3. Click `+ Add entry` to create a new entry or, alternatively, edit an existing entry by clicking on the pencil icon.
4. Locate the **Akeneo** section of the screen and click on `Add Akeneo asset`. This opens a new screen where you can select and export assets into your Hygraph content entry. This screen contains a number of input and dropdown filters; [click here to learn how to use the Akeneo filters in the Hygraph UI](https://hygraph.com/docs/integrations/connect-akeneo#how-to-use-akeneo-filters).
5. Select the asset(s) you want, and then click `Export`. If you configured your Akeneo field to allow multiple assets, you will be able to select several assets here. As you select assets, the rows will turn a darker shade of gray to indicate that you selected them.
6. After selecting the asset(s) you want and returning to the content entry, your selection will display on the list.
   ![Akeneo - Images in content entry](https://hygraph.com/images/docs/integrations/akeneo/images-content-entry.png)
   You can optionally use the six dots icon to drag and drop the assets on the list to organize them in the order you want.
7. Finally, click `Save` or `Save & Publish`, as needed.

## How to use Akeneo filters

[Video: How to use Akeneo filters](https://eu-central-1-shared-euc1-02.graphassets.com/AvHQ3RDvFSousA8iwElOKz/cmnn9x8sehu3z07vxi25tmi7t)

Akeneo filters have two types of inputs:
- **Standard inputs:**  To use them, you need to enter complete search strings - partial strings are not supported by the Akeneo API.
- **Dropdown selects:** When you select the dropdown, the app begins fetching all categories and families from the catalog structure. You can then select specific categories or families to refine results displayed on the table.

You can select conditions for both standard and dropdown filters.

**Note:**

[Learn more about Akeneo asset families and variant families here](https://help.akeneo.com/serenity-build-your-catalog/30-serenity-manage-your-families-and-variant-families?from_search=131344156)

## Resources

- [Akeneo documentation on managing your connections](https://help.akeneo.com/serenity-connect-your-pim/serenity-manage-your-connections#grab-your-credentials)
- [Akeneo's Product Information Management 101](https://www.akeneo.com/wp-content/uploads/2021/11/Akeneo_eBook_PIM_101_EN.pdf)

&nbsp;