See at a glance all your connections

From Akeneo PIM, you can easily see all the connections to third parties, such as ERPs, DAMs, e-commerce platforms, syndication tools,...

To do so, click on Connect, then on Connection settings. 
The following screen should be displayed.

As an example, here, we have 3 connections around this PIM:

• 2 source connections: an ERP and a retail collaboration platform,
• one destination connection: an e-commerce platform.

Those 3 third-parties are either sending or receving information to/from the PIM.

To connect your PIM to a third-party solution, you will need to create a connection.

Here are the simple steps to create a connection:

1. Click on Connect.
2. Then on Connection settings.
3. Click on Create.
4. In the Label field, enter the name of your connector. For example, if you wish to connect your PIM to Magento, write Magento or Magento connector.  
   Sidenote: the code of the connection is automatically generated based on the label. You can keep it as is or change it, it's up to you!
5. Choose the flow type of your connection. To choose wisely, see the section below.

You're done! 🎉

Once your connection is created, you'll be able to assign it a visual in order to easily see which connection it refers to. For example, if your connection represents your connection to Magento, you may want to put a picture of the Magento logo, exactly like in the screenshot below.

After creating the connection, you'll also be given a set of credentials to authenticate your connector. See this section, to know more.

When you create or update a connection, you have to define a "flow type". But what does it mean?

The flow type is a central concept in the connection notion. It allows you to characterize the data flows that will interact with your PIM. More precisely it allows indicating the direction of a given flow.

It will determine the way your connection flows are monitored in the data flows dashboard.

This flow type has three available options you'll have to choose from. The next sections describe each of them. It will help make your decision.

The Source connection flow type

Choose this option for your connection whenever it represents a data flow entering the PIM. For example, your data flow mainly creates or updates PIM data, such as products, product models, assets, reference entities,...

If you choose this option, the Data flows dashboard will focus on the data that is pushed inside the PIM via this connection.

The Destination connection flow type

Choose this option for your connection whenever it represents a data flow that mainly extracts product information from your PIM.

If you choose this option, the Data flows dashboard will focus on the data that is pushed outside the PIM via this connection.

The Other flow type

Choose this option whenever you can't opt for none of the options above.

Enable the monitoring

For each connection, you can choose whether you want to monitor it in Data flows. 
To do so, check Track in Data flows dashboard, in the connection settings screen of the connection you want to track.

Whenever you create a connection, the PIM automatically generates a set of credentials for you. These credentials are necessary if you want to make any API calls to the PIM. Don't hesitate to learn more about the authentication over the API in our dedicated API website.

These credentials consist of 4 different strings:

• the client id,
• the secret,
• the connection username,
• the connection password.

To access the client id, the secret and the username, go to Connect / Connection settings, click on the connection for which you want to see the credentials. They are displayed on the right side of the screen in the Credentials column.

You can easily copy/paste the credentials by clicking on the button next to them.

The password is only showed once to you, just after the connection creation. So, make sure you save it somewhere. 
When the password is visible, there is a copy icon next to it for easy copy-paste. 😉

Use these credentials to authenticate the API calls in the Connector that matches your connection. For this step, take a look at this guide.

Why should you use the connection username?

You may have noticed that nothing prevents you from using another username than the one generated for you when your connection is created. It's totally possible but it's, in fact, not recommended at all!

Instead, we highly recommend using the connection username to authenticate all the API calls coming from the Connector linked to your connection.

Here are the 2 main reasons why:

• First, all the permissions set on your connection are based on the connection username. So if you don't use it, your permission connection won't be enforced.
• The connection monitoring in the dashboard is also based on the connection username. So if you want to benefit from this feature, use this username to authenticate your API calls.

Revoke/regenerate your connection secret

In some cases, your connection secret may have leaked and fallen into the wrong hands. So you want to revoke this secret, to avoid enabling these "wrong hands" to access your PIM via the API.

Here are the simple steps to go through to revoke your secret:

1. Click on Connect.
2. Click on Connection settings.
3. Click on the connection for which you want to revoke the secret.
4. In the Credentials section, on the right side of the Secret line, click on the regenerate icon. 
   
5. A popin asks you for confirmation. Click on Regenerate.

The current secret will be revoked. It means that no one will be able to use it anymore to authenticate their API calls. 
Also, a new secret has been generated. Be sure to use this new one in your connector, in order to be able to make API calls again.

The PIM shows you the connection password only once, at the connection creation. In case you may have forgotten it, you can regenerate a new one.

Here's how:

1. Click on Connect.
2. Click on Connection settings.
3. Click on the connection for which you want to revoke the password.
4. In the Credentials section, on the right side of the Password line, click on the regenerate icon. 
   
5. A popin asks you for confirmation. Click on Regenerate.

The current password will be deleted and a new one is generated. It means that no one will be able to use it anymore to authenticate their API calls. 
Be sure to use the new password in your connector, in order to be able to make API calls again.

For each connection, you can define a set of permissions that can restrict the access to:

• some API endpoints. In this case, those permissions are defined thanks to your connection user role.
• some parts of your product catalog. In this case, those permissions are enforced thanks to the connection user group. Note that they are only available in the Enterprise Edition.

For each connection, you can define a user role. This user role should be first created in the User role screens.

We strongly recommend you to create one dedicated user role for your connections, different from the user roles that you use for your UI users. It's even better if you create one user role for every connection you will need, as it will allow you to fine tune what each connection will be able to access. 😉

To create a user role and link it to your connection:

1. Click on System.
2. Click on Roles.
3. Click on Create role.
4. In the form that appears, give a name to your user role, My Magento user role for example.
5. Click on Web API permissions and select Overall Web API access.
6. You can also select other accesses in the list below depending on what you want your connection to be able to achieve.
7. Save your configuration by clicking on Save.
8. Click on Connect.
9. Click on Connection settings.
10. Click on the connection for which you want to set the permissions.
11. On the right side of the screen, there is a Permissions section. Select the user role you've just created in the Role dropdown.
12. Don't forget to save by clicking on Save.

For each connection, you can define a user group. This user group should be first created in the User group screens.

We strongly recommend you to create one dedicated user group for your connections, different from the user groups that you use for your UI users. It's even better if you create one user group for every connection you will need, as it will allow you to fine tune what each connection will be able to access. 😉

To create a user group and link it to your connection:

1. Click on System.
2. Click on User groups.
3. Click on Create group.
4. In the form that appears, give a name to your user group, My Magento user group for example.
5. Click on Save.
6. Click on Connect.
7. Click on Connection settings.
8. Click on the connection for which you want to set the permissions.
9. On the right side of the screen, there is a Permissions section. Select the user group you've just created in the Group dropdown. 
   
10. Don't forget to save by clicking on the Save button.

Delete a connection

If you created a connection you don't want to use anymore, you can delete it.

1. Click on Connect.
2. Click on Connection settings.
3. Click on the connection you want to delete.
4. Click on ... in the top right corner of your screen.
5. Click on Delete. 
   
6. A popin asks you for confirmation. Again click on Delete.

As a result, your connection will be deleted. It means that:

• you will no longer be able to follow its data flows inside the Data flows dashboard,
• the credentials that were generated with the connection will be revoked. The API authentication made with these credentials will be revoked as well. It means that all the API calls using a token that was generated based on these credentials will now send 401 errors. If this does not ring a bell for you, you might want to learn more about authentication in the API right here. 😉