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 Akeneo system requirements. For more information on the compatibility please see Connector Compatibility
Step 2: Install the Package
To install the Akeneo PIM for Salesforce package, follow these steps:
- Log in to your Salesforce org.
- Navigate to the AppExchange.
- Search for "Akeneo PIM for Salesforce" and select the package.
- Click "Get It Now" and follow the prompts to install the package.
- Accept the terms and conditions and click "Install for Admins Only" .
- Wait for the installation to complete.
After the installation process is complete, you may need to perform additional steps to configure the Akeneo App.
To set up the connection between Akeneo PIM and Salesforce org, you need to configure the following components on both apps:
Step 3: Configure the app on Salesforce
After installing the package, you'll need to configure it to connect to your Akeneo PIM instance. Follow these steps to configure the package:
In Salesforce, do not end url with a slash “/”
If the URL finishes with a slash “/” the Auth Providers connectivity will not work properly for instance.
Auth. Provider:
To gain the required activation and refresh URLs, create a temporary Auth. Provider:
• Go to Setup,
• Search for Auth. Providers and click on New.
• On the new screen, select Provider Type = Akeneo
• Enter values like in the below table
| Label | Value | Notes |
|---|---|---|
| Name | Akeneo | |
| URL Suffix | Akeneo | |
| Base Endpoint | <YOUR_AKENEO_PIM_DOMAIN> | For e.g. https://mycompany.cloud.akeneo.com |
| Authorize Endpoint | <YOUR_AKENEO_PIM_DOMAIN>/connect/apps/v1/authorize | For e.g. https://mycompany.cloud.akeneo.com/connect/apps/v1/authorize |
| Client ID | temp123 | *these values will be replaced at a later stage from Akeneo |
| Client Secret | temp123 | *these values will be replaced at a later stage from Akeneo |
| Token Endpoint | <YOUR_AKENEO_PIM_DOMAIN>/connect/apps/v1/oauth2/token | For e.g. https://mycompany.cloud.akeneo.com/connect/apps/v1/oauth2/token |
| Authentication Scopes | read_products read_catalog_structure read_channel_settings read_channel_localization read_attribute_options read_catalogs write_catalogs delete_catalogs read_categories | |
| Execute Registration As | <YOUR_ADMIN_USERNAME> | Choose the user under which context the auth provider connections will run. Make sure that the user you specify to run has Customize Application and Manage Auth. Providers permissions. |
Finally, Save and copy OAuth-Only Initialization URL and Callback URL you need it for Akeneo configuration.
Step 4: Create an Akeneo Catalog App
After creating the Salesforce Authentication provider, you'll need to configure a connected Akeneo App. It requires the two URLs you have been asked to copy in the above step.
- Navigate to Akeneo
- Click Connect in the menu
- Select App Store
- Create an App
Creating a custom app requires you to enter the following information:
Name: Give your App a name
Activate URL: Enter OAuth-Only Initialization URL you copied from Salesforce Auth. Provider above.
Callback URL: Enter Callback URL you copied from Salesforce Auth. Provider above.
Now you get the credentials presented you need to copy and take over into Salesforce to finalize the Salesforce Auth. Provider setup from above.
Save Client ID and Secret
Make sure to copy and save the client ID and secret as they will be required in a later stage on Salesforce.
In the next screens agree on the Privacy Policy and Terms of Use, configure the following screens for your needs, but do not connect yet – first continue with the Salesforce configuration.
Step 5: Finalise Auth Provider Configuration
We now can finalize the Salesforce Auth. Provider configuration from the top and continue with required other configurations in the next steps.
Navigate to Setup > Auth. Provider > Select Akeneo
Now that you have Client id and Client secret from Akeneo Connected App you can complete Salesforce Auth. Provider configuration as shown below.
- Edit the Akeneo Auth Provider and replace the “temp123” values for the below:
-
Client ID: the Client id from Akeneo Connected App you copied above.
-
Client Secret: the Client secret from Akeneo Connected App you copied above.
-
Client ID: the Client id from Akeneo Connected App you copied above.
- Save.
Finally, the configuration should look like this:
Step 6: Create a Salesforce Remote Site Setting
Remote Site Settings are whitelists for URLs or endpoints we want to call from within Salesforce.
- Under Setup, search for Remote Site Settings:
- Click on New Remote Site.
Now enter the following information as shown below:
| Input | Value |
|---|---|
| Remote Site Name | Akeneo |
| Remote Site URL | <YOUR_AKENEO_PIM_DOMAIN> |
| Active | TRUE |
Save, it now should look like this:
Step 7: Create Named Credential
Named Credentials are preconfigured endpoints together with safely stored authentication information.
That way in Salesforce we can simply use the callout name of a Named Credential to access an endpoint and its various targets without the need to deal with authentication.
Navigate to Setup > Named Credentials:
Do not simply click on the New button, but on the chevron next to it as shown in the image below, and then click on New Legacy.
Now enter the following information as shown below:
| Label | Value |
|---|---|
| Label | Akeneo |
| Name | Akeneo |
| URL | URL of your Akeneo instance |
| Identity Type | Oauth 2.0 |
| Authentication Protocol | |
| Authentication Provider | |
| Start Authentication Flow on Save | TRUE |
| Generate Authorization Header | TRUE |
Once completed the input fields as shown above click Save.
Now you should be redirected to Akeneo to complete the Connected App configuration you started before. So in the next screens agree on the Privacy Policy and Terms of Use, and configure the following screens for your needs.It will automatically proceed with the OAuth authorization and finally lead you into the logged-in Salesforce org.
If this happens you have successfully configured the connection between both systems.
Once the app is Authenticated you will see this status in the Named Credential you have created. Ignore the warnings since the refresh access token stays permanent on Akeneo side.
You have now sucessfully connected your Akeneo PIM to Salesforce.
Follow the steps in this documentation to setup your first catalog and launch the first transfer of products.