Akeneo Installation Instructions
This guide walks you through subscribing to and configuring the Akeneo integration on iPaaS.com. The integration moves data from Akeneo into iPaaS.com, with Akeneo acting as the source system. It transfers Products (both simple products and variant/product-model records) along with their child data — options, option values, inventory, variants, related products, bundles/kits, and units — as well as Product Categories.
Records are kept in sync automatically through scheduled, incremental record polling (only records that changed since the last poll are picked up). You can also trigger a Manual Sync at any time, and Product Categories support a bulk initialization that preserves parent ordering. The integration supports Add and Update operations only; outbound deletes are not performed.
Akeneo authenticates API access using OAuth 2.0. Before configuring the subscription on iPaaS.com, obtain the following credentials from your Akeneo PIM. You will enter them on the Subscription Settings page in a later step.
Create a Connection in Akeneo (provides all four credentials)
Log in to your Akeneo PIM.
Go to Connect > Connection settings.
Open (or create) the connection for iPaaS.com — for example, "iPaaS-connect".
The connector provides four credentials for this connection: a Client ID, a Secret, a Username, and a Password.
Save all four securely — the Secret is shown only once. You will enter all four on the iPaaS.com Subscription Settings page.
Ensure the connection's user 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.
Best Practices
Use the connection's dedicated credentials rather than a personal account's.
Regenerate your Secret immediately if it is ever exposed, and update the corresponding subscription setting.
Akeneo access tokens expire after one hour; the integration refreshes them automatically as needed.
For full details on Akeneo's API and authentication, see the Akeneo API reference.
Installation Instructions for Integration Setup
In iPaaS.com, go to Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Locate and click the Akeneo integration tile.
On the Subscription Detail page, click Subscribe.
Enter a subscription Name and select a Version. The name can be any value that is relevant and unique within your company.
Format: [Product Name] - [Environment/Purpose]
Example: Akeneo - Production
Select Create Default Mappings (recommended). This creates the standard set of mapping collections automatically. Leave it unchecked only if you intend to build every mapping from scratch yourself.
Click Subscribe to create the subscription. You are taken to the Subscription Settings page, where you configure the values below.
Provide the API Url for your Akeneo instance.
Test/Sandbox example:
https://ipaascom.demo.cloud.akeneo.comUse your test/sandbox URL while validating the integration, then switch to your production instance URL when you go live.
Enter the API Throttle Limit. This controls the maximum number of API requests allowed within the throttle time window, protecting system performance and ensuring fair usage.
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds — the length of the time window over which the API Throttle Limit is measured. Requests beyond the limit within this window are deferred until the window resets.
Default: 60 seconds
Enter the number of Concurrent Connections — the maximum number of simultaneous API connections the integration may open. Additional requests are queued until an active connection finishes.
Enter the number of Concurrent Batch Executions — the maximum number of batch transfer operations that may run at the same time.
Enter the authentication credentials from the Authentication Configuration section below.
Click Apply to save the settings.
Authentication Configuration
Enter the following credentials on the Subscription Settings page. These are the values you obtained from Akeneo in the Before You Begin section. All credential fields are managed on the Subscription Settings page of your Akeneo subscription.
Field | Location | Description |
API Url (required) | Subscription Settings | The base URL of your Akeneo PIM instance (for example, |
ClientId (required) | Subscription Settings | The Client ID the connector provides for your Akeneo connection (Before You Begin). |
ClientSecret (required) | Subscription Settings | The Secret paired with the Client ID. Shown only once in Akeneo, so store it securely. |
UserName (required) | Subscription Settings | The username the connector provides for the Akeneo connection (Before You Begin). |
Password (required) | Subscription Settings | The password paired with the username, from the same Akeneo connection. |
The integration uses these credentials to authenticate to Akeneo's REST API via OAuth 2.0 and obtain an access token. The token is stored with the subscription and refreshed automatically before it expires.
Completing the OAuth Authorization
After saving your settings, confirm that an access token has been issued for the subscription:
Open your Akeneo Subscription Settings.
Click the Authentication (lock) icon in the settings toolbar.
A new browser window opens requesting permissions for the application. 3. While logged in to Akeneo, click Authorize when prompted. 4. Close the page when authorization completes. 5. Refresh the subscription. The AccessToken value should now be present, confirming a successful connection.
Important Notes
Store the Client ID, Secret, Username, and Password securely. If the secret is exposed, regenerate it in Akeneo and update the corresponding setting.
Akeneo access tokens expire after one hour. The integration handles token refresh automatically, so no manual re-authorization is required during normal operation.
If the AccessToken value does not appear after refreshing, recheck the Client ID, Secret, Username, Password, and API Url values, then repeat the authorization steps above.
Operational Configuration
These settings control how the integration reads products from Akeneo and handles related records. Configure them on the Subscription Settings page.
Field | What It Controls | Purpose | Example |
Akeneo Product ID Format | Whether the integration reads products by UUID or by Identifier. | Select UUID to read products from Akeneo's UUID-based product endpoint, or Identifier to read from the identifier-based product endpoint. Choose Identifier for older Akeneo versions or catalogs that do not use UUIDs; otherwise use UUID. | UUID |
Create Missing Bundle Items | Whether bundle/kit component items that do not yet exist are created during a bundle transfer. | Ensures that the items referenced by a bundle are present so the bundle can be assembled, rather than skipping components that have not been transferred independently. | True |
Product Variant Poll Search Days | The number of days back the variant poll looks for changed variant records. | Bounds how far back the incremental variant poll searches, balancing thoroughness against the volume of records examined on each poll. | 7 |
Skip Related Product Pre-requisite | Whether the prerequisite check for related products is skipped. | When enabled, allows related-product associations to transfer without first requiring the related product to satisfy the standard prerequisite. Leave disabled unless you have a specific need to bypass the check. | False |
About Akeneo Product ID Format: The UUID option routes product reads to Akeneo's UUID product endpoint (pattern /api/rest/v1/products-uuid/{uuid}). The Identifier option routes product reads to the identifier product endpoint (pattern /api/rest/v1/products/{identifier}). UUIDs were introduced in newer Akeneo versions; if your Akeneo instance or catalog predates UUID support, select Identifier. The available options are exactly UUID and Identifier.
Additional Configuration Options
Beyond the standard product and category data, the integration supports subscriber-configured custom field mappings:
Reference Entity attributes can be mapped to iPaaS.com custom fields. Both single-value attributes and collection attributes (where each entry is exposed with an integer suffix) are supported.
Category attributes can be mapped to iPaaS.com custom fields.
These mappings are configured by the subscriber within the relevant mapping collections after the subscription is in place.
Post-Installation Verification
After completing the installation, perform the following checks to confirm the integration is working.
Connection Test
Open the Akeneo Subscription Settings and confirm the AccessToken value is populated (see Authentication Configuration above).
If the token is present, the integration has successfully authenticated to your Akeneo instance.
Data Sync Test
In Akeneo, identify a product you can use for testing.
In iPaaS.com, run a Manual Sync for that product to pull it from Akeneo into iPaaS.com.
Confirm the product and its child data (options, option values, inventory, variants, and any bundles or related products) arrive as expected.
Functionality Test
Run an end-to-end transfer covering a representative product and a product category.
Validate key behaviors such as field mappings, custom field mappings, and incremental polling.
Review the transfer results and confirm there are no errors. Errors are recorded under Dashboard / Integration Monitoring / Error Logs.
Support and Troubleshooting
If you need assistance, the following iPaaS.com resources are available:
Documentation: API Introduction
Support Portal: https://support.ipaas.com/en/
Contact: https://ipaas.com/contact-us/
When reporting an issue, include details from Dashboard / Integration Monitoring / Error Logs to help the support team diagnose the problem quickly.