Configure your PIM API

#How to configure my PIM API?

Before setting up Akeneo Connector for Magento 2, 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"

#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 manage multiple Magento 2 "Websites"?

A Magento 2 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 Magento 2 website:

Connector parameter Magento information PIM information
Website mapping Magento Website PIM Channel