Create & Test a Connection
A connection holds the Akeneo REST API credentials the plugin uses to read your catalog. Every connection is validated live against Akeneo before it is saved, so you never store credentials that don't work.
Open the Connections List
In the admin sidebar, open Akeneo Migration → Connections. This lists every connection you have created, with its name, base URL, username, and status (Enabled / Disabled).
It is a standard UnoPim datagrid, so search, filters, pagination, and mass delete all work the way they do everywhere else in the admin — and it follows your theme, dark mode included.
Enter the Connection Details
Click Create Connection. The form opens as a modal on the listing — you never leave the page.
Fill in your Akeneo REST API (Connection) credentials:
| Field | Description |
|---|---|
| Akeneo Base URL | The URL of your Akeneo instance — for example, https://your-instance.cloud. Must be a valid URL. |
| Client ID | The Client ID from your Akeneo API connection. |
| Secret | The Secret from your Akeneo API connection. |
| Username | The Akeneo API user's username. |
| Password | The Akeneo API user's password. |
TIP
On create, the connection is enabled automatically and named from its base URL. You can rename it later from the connection's edit page.
NOTE
You will need an Akeneo account with REST API (Connection) credentials. In Akeneo, these are created under Connect → Connection settings, which provides the Client ID, Secret, username, and password used here.
Test & Save
When you save, the plugin tests the credentials against Akeneo. If they are valid, the connection is created and you land straight on its edit page.
If the test fails, the connection is not saved and a clear reason is shown so you can fix it:
| Message | What it means |
|---|---|
| The Akeneo API was not found at this Base URL | The Base URL is wrong or does not point to your Akeneo instance. Check it (for example, https://your-instance.cloud). |
| Authentication was rejected | One or more of the Client ID, Secret, Username, or Password is incorrect. |
| Access was denied by Akeneo | The API user does not have permission to use the API — check its roles and permissions in Akeneo. |
| Akeneo rejected the request | Review the connection details and try again. |
| Akeneo returned a server error | A temporary problem on the Akeneo side — try again in a few moments. |
| Could not reach the Akeneo server | The Base URL is wrong, or the server is offline or unreachable from this network. |
Edit a Connection
From a connection's edit page you can rename it, update its details, enable or disable it, and choose which entities to migrate. The page has three tabs:
- Connection — the connection details and the Run a Migration controls.
- History — field-level changes made to this connection over time.
- Migration History — every migration run started from this connection.
Saving your changes
Change anything on this page and UnoPim's global save bar slides in at the bottom, telling you how many fields were modified:
- Save changes posts the update over AJAX. The connection is re-validated against Akeneo, a success message appears, and the page stays exactly where it is — no reload.
- Discard reverts everything you changed on the form, after asking you to confirm.
If you try to navigate away with unsaved changes, UnoPim asks before letting them go.
NOTE
For security, the stored Secret and Password are never shown in plain text — on edit they appear as a masked length. Leave them as they are to keep the stored value, or type a new value to replace it. Both, along with the Client ID, are also encrypted in the database.
Delete a Connection
Use the delete action on the listing to remove a single connection, or tick several rows and delete them together.
Deleting a connection also removes the mappings recorded under it, so a later migration on a new connection starts fresh.
Next Steps
With a working connection in place, you can now run a migration.