Configure your PIM API

Summary

How to configure my PIM API?

Before setting up Akeneo Connector for Adobe Commerce, you first need to generate a "client ID" and a "secret" couple in the PIM to enable the API connection.

Please refer to our specific documentation to do so.

Note the following information:

  1. Your PIM URL (ex: https://mypim.cloud.akeneo.com)
  2. Your PIM API Client ID and Secret
  3. Your PIM User dedicated to the use of the API (Username and Password).

How to configure the connector with my PIM API information?

In the connector configuration page, in Akeneo API configuration, fill in the below parameters with the PIM information collected above :

Connector parameter PIM information
Akeneo base URL PIM URL
Akeneo user name PIM user Username
Akeneo password PIM user Password
Akeneo API client ID PIM API Client ID
Akeneo API client secret PIM API Secret

By clicking on the Test button, you can check if the connection works. If everything went well, you should see the following message: "The connection is working fine"

Configure your Akeneo Edition

Since the 101.1.0 version of the Akeneo Connector for Adobe Commerce, you have to configure the Akeneo Edition of your Akeneo platform in the connector configuration:

Connector parameter PIM information
Akeneo Edition 3.2, Between 4.0.0 and 4.0.62, 4.0.62 or greater, 5.0 or greater, Serenity Edition, Growth Edition

You can find your Akeneo Edition and Version on the bottom of the dashboard page of your Akeneo platform.

 

This configuration will activate and display features, depending on your Akeneo Edition.

How to optimize the performance of the PIM API connection?

In the connector configuration page, in Akeneo API configuration, with the below parameter you will be able to change the limit of API pagination: By default, the limit is set to 100. You may change this parameter to optimize the Connector import speed as per your convenience.

Connector parameter PIM information
Pagination size Pagination limit

How to determine which PIM Channel Adobe Commerce admin data will come from?

In the connector configuration page, in Akeneo API configuration, with the below parameter you can define which PIM Channel to associate with your Adobe Commerce Admin website:

Connector parameter PIM information
Admin Website Channel PIM Channel

How to manage multiple Adobe Commerce "Websites"?

An Adobe Commerce Website is represented by a specific Channel in Akeneo PIM.

In the connector configuration page, in Akeneo API configuration, with the below parameter you can define which PIM Channel to associate with your Adobe Commerce website:

Connector parameter Adobe Commerce information PIM information
Website mapping Adobe Commerce Website PIM Channel

Since the 100.2.1 version of the Akeneo Connector for Adobe Commerce, you can also choose how to associate your products to your websites using a select or multiselect attribute. Please read our documentation about this feature.