Magento REST Roles

This diagnostic program will make sure that REST API access is properly granted to HubShop.ly. This is an important part of the authorization process which enables HubShop.ly to send and retrieve information for your HubSpot portal.

What to Look For

null

What it Does

This diagnostic program will confirm that a REST role and attributes have been created for your activated store.

Tip: When you start setup for the first time, this is automatically configured.

Possible Statuses

Pass

  • A passing status means that the your REST API is configured to allow HubShop.ly to communicate.

Fail

  • A failing status means that no REST role could be verified for use with HubShop.ly. If this happens, you can try to reset your installation by clicking the Reset button in the Support section. This will restart your HubShop.ly installation and attempt to setup the REST role for you automatically.
  • Alternatively, you can configure this yourself. See below for more information.

Dependencies

  • The Enabled test must be passing.

Manually Setting up the REST Role

HubShop.ly will attempt to automatically configure the REST role for you. However, in some circumstances this may not work for your application. If the diagnostic test fails, you can do this manually by following the steps below:

  1. Log into your Magento admin panel
  2. Select System > Web Services > REST - Roles
  3. Select Add Admin Role
  4. In the Name field, enter "HubShop.ly"
  5. In the Role API Resources tab, choose All for Resource Access
  6. Save the role
  7. Return to the new role's management screen
  8. In the Role Users tab, click the checkbox next to your own username
    1. If your username does not appear, click the Reset Filter button
    2. You may ignore the warning given about role assignment
  9. Save the role

Once the role is setup, you must then define the accessible attributes for your user under this role. Follow these steps:

  1. Select System > Web Services > REST - Attributes
  2. Select Admin from the User Type list
  3. Set the Resource Access field to All
  4. Save your changes

Once finished, re-run the diagnostic tests and confirm that it is passing.