With this step-by-step guide, you'll be able to install the Akeneo PIM for Salesforce package in no time.
Step 1: Check System Requirements
Before installing the Akeneo PIM for Salesforce package, ensure that your Salesforce org meets the system requirements and the Akeneo system requirements. For more information on the compatibility, please see Connector Compatibility.
Step 2: Install the Package
The package installation is completed using a secure installation link provided by the Akeneo teams.
Obtain the Installation Link
To receive your installation link, you can request it through one of the following channels:
- Via the Salesforce AppExchange: Submit a request for the package on the official Akeneo AppExchange listing
- Via your Akeneo Representative: Contact your Customer Success Manager (CSM) or Account Executive directly
Installation Procedure
Once you have received the link via email, follow these steps:
- Open the link in your web browser
- Log in to the specific Salesforce Organization (Production or Sandbox) where you intend to deploy the app
- Run the Installation: The Salesforce setup interface will appear automatically. Choose your preferred security level (e.g., Install for Admins Only) and confirm
- Confirmation: After the process starts, Salesforce will send you a confirmation email as soon as the package is fully installed and ready for configuration
After the installation process is complete, you may need to perform additional steps to configure the Akeneo App.
Step 3: Create an Akeneo Custom App
The process starts by creating a new Custom App in Akeneo.
- Navigate to Akeneo
- Click Connect in the menu
- Select App Store
- Click Create an App
Enter the App details and click Create
The Activate url and Callback url have to be exactly as shown. The Name can be changed to any name.
In the next screen, take note of the Client id and Client secret and click Done
Make sure to copy and save the Client id and Client secret as they will be required in a later stage on Salesforce.
Step 4: Configure the Auth Identity Provider on Salesforce
After the above configuration is done in Akeneo, we can move to Salesforce.
Creating the Auth Identity Provider
The first step is to create the Auth Identity Provider in the Salesforce configuration:
- Navigate to Salesforce
- Go to Setup
- In the Security tab click on Named Credentials
- Click on the External Auth Identity Providers tab
Click New
Fill in the "External Auth Identity Provider" details, as shown below
Please ensure you fill in the following information correctly:
- For the Authentication Protocol, select OAuth 2.0 and Authorization Code for the flow type
- Use the Client ID and Client Secret from the previously created Akeneo custom application
- Update the domains in the Authorize Endpoint URL and Token Endpoint URL with the correct domain for your Akeneo environment
Once all the information has been entered, click on Save
Adding custom query parameters
The PIM's OAuth protocol requires two additional parameters to validate authentication: code_identifier and code_challenge. We will need to create them and add them to our Auth Identity Provider.
In the page that opens, scroll down to the “Custom Request Parameters“ section
These parameters have to be calculated using the Client Secret as a reference. To do that, go to the Salesforce Developer Console and run the code snippet below.
String clientSecret = 'PASTE YOUR CLIENT SECRET HERE';
String codeIdentifier = EncodingUtil.convertToHex(Crypto.generateAesKey(128));
String codeChallenge = EncodingUtil.convertToHex(Crypto.generateDigest('SHA-256', Blob.valueOf(codeIdentifier + clientSecret)));
System.debug('code_identifier: ' + codeIdentifier);
System.debug('code_challenge : ' + codeChallenge);After executing it, open the execution log, click on Debug Only, and you should see two values as shown below. Taken note of them.
Back in the “Custom Request Parameters” section, click New to create the first parameter
Fill in the details using the code_identifier value from the step above and click Save
Click New again to add the second parameter
Fill in the details using the code_challenge value from the step above and click Save
Step 5: Configure the External Credentials on Salesforce
Let's now move on to creating External Credentials.
Creating the External Credentials
Click on Named Credentials on the top of the page to go back to the named credentials screen
On that screen, click on the External Credentials tab and then click New
Fill in the details like shown below, making sure to select the “Akeneo External Auth Identity Provider“ that was created before, and click Save
Be sure to select the OAuth 2.0 protocol and the Browser Flow for authentication.
Adding and configuring the Principal
In the page that opens, scroll down to the “Principals“ section and click New
Fill in the details as shown below and click Save
Be sure to enter the full value for the scope:
read_products read_catalog_structure read_channel_settings read_channel_localization read_attribute_options read_catalogs write_catalogs delete_catalogs read_categories
On the same “Principals“ section, click on the arrow below the “Actions“ column and then click Authenticate
You should be redirected to Akeneo where you need to authorize the App
You need to grant all the requested permissions
After authorizing everything, you should be redirected back to Salesforce, and you should see a confirmation screen to confirm the access. Click Confirm
After that, in the “Principals“ section, you should see that it now says “Configured“
Step 6: Configure the Named credentials on Salesforce
Now click on Named Credentials on the top of the page to go back to the named credentials screen
Click on the Named Credentials tab and then click New
Fill in the details as shown below and click Save
Please ensure you fill in the following information correctly:
- The Label and Name should be exactly Akeneo, as shown
- Update the URL domain to the right domain of your Akeneo environment
- Select the “Akeneo External Credential“ created in the previous step for the External Credential
Step 7: Granting user access on Salesforce
To be able to use the “Named Credential”, the user’s profile must be configured to have access to the External Credential used by the Named Credential:
- Navigate to Salesforce
- Go to Setup
- In the Users tab click on Profiles
- Click on the System Administrator profile
On the profile page, click on External Credential Principal Access
On the new page, click Edit
Move the “Akeneo_External_Credential - Default“ credential to the right side and click Save
Step 8: Testing the Connection
The final step is to test the connection to see if everything is working correctly. Here's how to do it:
Go to the Developer Console and execute the following code snippet
Http http = new Http();
HttpRequest request = new HttpRequest();
request.setEndpoint('callout:Akeneo/api/rest/v1/catalogs');
request.setMethod('GET');
HttpResponse response = http.send(request);
System.debug(response.getStatusCode());
System.debug(response.getbody());Open the execution log, and you should see a 200 status code and a response received from Akeneo
You have now successfully connected your Akeneo PIM to Salesforce.
Follow the steps in this documentation to setup your first catalog and launch the first transfer of products.