Before You Begin
Before installing this integration, you must obtain the Client ID, Secret, Username, and Password from Akeneo to perform OAuth 2.0 authentication.
Here are the steps to get an Akeneo API key:
Step 1: Create a Connection (generates Client ID & Secret)
Log in to your Akeneo PIM.
Go to Connect > Connection settings.
Click Create.
Enter a label for your connection (e.g., "ERP" or "iPaaS-connect").
Select a flow type.
Click Save.
Akeneo returns a Client ID and Secret. Save these securely. You can only see the secret once.
Step 2: Create an API User (generates username & password)
1. Go to System > Users (or navigate to user management).
2. Click Create to add a new user.
3. Enter a username and password for your API user.
4. Assign appropriate permissions and roles. A best practice is to create a dedicated API user role.
5. Save the user credentials securely.
Step 3: Generate an Access Token
Now you have:
Client ID and Secret (from Step 1)
Username and Password (from Step 2)
To get your access token, make a POST request:
curl -X POST https://your-pim-url/api/oauth/v1/token \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS" \
-d '{
"grant_type": "password",
"username": "your_api_username",
"password": "your_password"
}'
The response includes your access token, which you use for all REST API calls. You can save this token so you can use as your API Key.
Best Practices
Create a dedicated API user role.
Regenerate your secret if it's exposed.
Access tokens expire after 1 hour; refresh them as needed.
Now you can start the integration setup.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Akeneo Integration title.
On the Subscription Detail page, click the Subscribe button.
Enter the subscription Name and select a Version. The name can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: Akeneo – Release
Select Create Default Mappings (recommended).
If you don’t want to create default mappings and want to create all mappings from scratch by yourself then uncheck this box.Enter the following credentials retrieved from Akeneo:
Password
Username
ClientSecret
ClientID
Enter the API Key you retrieved in Before You Begin.
Provide the API URL endpoint for your Akeneo instance.
Format:
https://[your-instance].[Product Name].comExample:
https://ipaascom.demo.cloud.akeneo.comEnvironment URLs:
Test/Sandbox:
[your-instance].cloud.akeneo.comProduction: N/A
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values:
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Akeneo can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the settings.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation.
Data Sync Test:
Initiate a sample data pull. (To iPaaS.com)
Initiate a sample data push. (From iPaaS.com)
Functionality Test:
Run an end-to-end business process.
Validate key features like field mappings, workflow triggers, and logging.
Review integration logs in iPaaS.com.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.