Akeneo Connections and Settings
Integrate iPaaS.com with Akeneo to enable seamless data synchronization for products and product categories. Akeneo acts as the source system: product data (simple products and variant/product-model products, together with their child data such as options, option values, inventory, variants, related products, bundles/kits, and units) and product categories flow from Akeneo into iPaaS.com.
Prerequisites
Before setting up the Akeneo integration in iPaaS.com, complete the following in your Akeneo environment:
Create or access an Akeneo account.
Start a free trial or request a demo at https://www.akeneo.com/start-free-trial.
If you already have an account, log in with your existing credentials.
Create an API connection in Akeneo. In Akeneo, navigate to Connect > Connection Settings and create a new connection for iPaaS.com. Akeneo generates a Client ID and Client Secret for this connection.
Grant permissions. Ensure the API user tied to the connection has permission to read the catalog data you intend to synchronize (products, product models, categories, reference entities, and related attributes). Without sufficient read permissions, polling and initialization will return incomplete data.
Collect your credentials. From the connection in Akeneo, copy and save the values described in Configuration Details below. You will enter these in the iPaaS.com subscription settings.
Configuration Details
Gather the following values from your Akeneo connection. Each is entered into the matching field in the iPaaS.com subscription settings.
API Url — The base API URL of your Akeneo instance. This is the root address iPaaS.com uses for all Akeneo REST API calls, including the authentication token request. Find it from your Akeneo instance address.
Example:
https://yourcompany.cloud.akeneo.com
ClientId — The Client ID generated for the connection in Akeneo. Found under Connect > Connection Settings for your connection.
Example:
1_abc123clientidexample
ClientSecret — The Client Secret generated for the connection in Akeneo, paired with the Client ID. Found under Connect > Connection Settings for your connection.
Example:
xyz789clientsecretexample
UserName — The username Akeneo created for the connection. Found under Connect > Connection Settings for your connection.
Example:
ipaas_connection_1234
Password — The password Akeneo created for the connection, paired with the username. Found under Connect > Connection Settings for your connection.
Example:
a1b2c3d4e5f6
Configure Subscription Settings
Navigate to the Akeneo subscription settings in iPaaS.com and provide the following information.
Field | Description | Required | Example |
Name | A unique name for identifying the Akeneo subscription. | Yes | Akeneo_PIM_Integration |
Versions | The iPaaS.com integration version to use for this subscription. | Yes | v1.0 |
Create Default Mappings | When enabled, iPaaS.com creates the default mapping collections for the integration on setup. | No | Enabled |
API Url | The base API URL of your Akeneo instance. iPaaS.com uses this as the root for all Akeneo REST API calls. | Yes | |
ClientId | The Client ID the custom connector provides under Connect > Connection Settings for your connection in Akeneo. | Yes | 1_abc123clientidexample |
ClientSecret | The Client Secret paired with the Client ID, from the same Akeneo connection. | Yes | xyz789clientsecretexample |
UserName | The username the custom connector provides for the connection in Akeneo. Used with the password to obtain an access token. | Yes | ipaas_connection_1234 |
Password | The password paired with the username, from the same Akeneo connection. | Yes | Your password |
Create Missing Bundle Items | When enabled, iPaaS.com automatically creates bundle items that are referenced by a bundle/kit but do not already exist, rather than skipping them. | No | Enabled |
Product Variant Poll Search Days | The number of days back the variant (product-model) poll searches for changes when looking up variant products during a poll. Tune this to control how far back variant changes are detected. | No | 7 |
Skip Related Product Pre-requisite | When enabled, iPaaS.com transfers a product without first requiring that its related products already exist in the destination. When disabled (the default), related-product prerequisites are enforced. | No | true |
Akeneo Product ID Format | Controls how iPaaS.com identifies products when reading them from the Akeneo REST API. Set to UUID or Identifier to match your Akeneo version and catalog. See the explanation below the table. | Conditional | UUID |
Akeneo Product ID Format — choosing the correct value
Akeneo can address products either by a UUID or by a text identifier, depending on the Akeneo version and how the catalog is configured. This setting tells iPaaS.com which product endpoint to use:
UUID — iPaaS.com reads products from the UUID-based product endpoint:
/api/rest/v1/products-uuid/{uuid}Use this for Akeneo versions and catalogs that identify products by UUID.
Identifier — iPaaS.com reads products from the identifier-based product endpoint:
/api/rest/v1/products/{identifier}Use this for older Akeneo versions or catalogs that do not use UUIDs.
Set this value to match your Akeneo environment. If it does not match how your catalog addresses products, product reads will fail to resolve. If you are unsure which applies, validate the behavior in a staging environment before relying on it in production.
Authentication Methods
iPaaS.com authenticates to Akeneo's REST API using the credentials configured in the subscription settings, then uses the resulting token on all subsequent data requests. The base URL for every call is the API Url you configured.
Request a token. iPaaS.com sends a token request to the Akeneo OAuth endpoint:
POST {API Url}/api/oauth/v1/tokenAuthenticate the client. The request is authorized with HTTP Basic authentication, using the ClientId and ClientSecret combined as the client credential.
Supply the user grant. The request body uses the password grant type and includes the UserName and Password (from the Akeneo connection) so Akeneo can authenticate the user behind the connection.
Receive and store the token. Akeneo returns an access token, a refresh token, and an expiration. iPaaS.com securely stores the access token (with its expiration) and the refresh token for the subscription.
Reuse and refresh. On later requests, iPaaS.com reuses the stored access token. When the access token is missing or expired and a refresh token is available, iPaaS.com requests a new access token using the refresh-token grant (again authorized with the ClientId and ClientSecret) and stores the renewed tokens.
Verify authentication. After entering your credentials and clicking Apply, refresh the subscription settings page in iPaaS.com to confirm that the access token has been successfully stored.
For Akeneo REST API details, see the Akeneo API reference.
Initialization Support
Initialization performs a one-time bulk pull of existing data from Akeneo into iPaaS.com.
Product Categories support initialization. They are transferred in bulk and in parent-first order, so that parent categories are created before their children and the category hierarchy is preserved.
Products and other Akeneo data are not pulled through initialization. Instead, they are kept in sync through:
Record polling — iPaaS.com automatically and incrementally retrieves records that have changed in Akeneo since the last poll (see Throttling and the integration's transfer behavior).
Manual Sync — you can trigger a sync on demand from the subscription.
If you need to pull a large existing set of products in bulk, use the Postman Runner workaround described here: Syncing a large dataset using iPaaS.com and Postman Runner.
Throttling
Throttling ensures that Akeneo's API isn't overwhelmed by excessive API calls, preserving system performance during heavy data transfers.
While the throttling fields are required, the values are pre-populated by the integration settings. For more details, refer to Subscription Configuration – Edit.