Step-by-step: Create a Magento API user

To use MageBridge, you need to create an API user in Magento. This API user is also related to a so-called API role. By default, there is neither API user nor API role, so you need to configure both.

Logging into the Magento Admin Panel

First an API role needs to be added. Login to the Magento Admin Panel and navigate to System > Web Services > Roles.


Create a new API role

This page lists the current API roles. If there none listed yet, click on Add New Role.


Every role needs a name. This can be anything. Just make sure it is descriptive enough for yourself.


The second tab on the left (Role Resources) allows you to select which resources should be available for users with this role. While you can select exactly which privileges are given, we recommend you select All unless you're willing to spend hours with experimenting.


Create a new API user

Now that the role is created, you can add an user that makes use of this role.


The strange thing here is that the user fields here seem to indicate a person or individual, while in fact we're creating a system account of some kind. The fields First Name, Last Name and Email just need to be filled in with any value you like. Make sure the User Name and Api Key are secure enough.


The second tab on the left is called User Role, and that's where you select the role earlier created.

Configure the API details in MageBridge

The User Name and Api Key of the user that is created in Magento, need to be configured inside the MageBridge settings in Joomla!. Login to the Joomla! Administrator and navigate to Components > MageBridge > Configuration and select the tab API. Enter the user details in the fieldset Magento API user.