Skip to main content
Admin access required. Tokens are automatically refreshed every 4 hours using your admin credentials.

​
Find Your Store URL

Identify your Magento store’s base URL for API access.

1

Locate Store URL

Find your store’s base URL from your browser or Magento configuration.

  • Check your browser’s address bar when logged into Magento Admin
  • Remove any paths after the domain (e.g., /admin, /index.php)
  • Examples of valid store URLs:
  • • https://mystore.com (standard installation)
  • • https://shop.example.com (subdomain)
  • • https://example.com/store (subdirectory)
  • Must use HTTPS for production environments

​
Prepare Admin Credentials

Ensure you have admin access to your Magento store before connecting.

1

Create Dedicated API User

Set up a dedicated admin user for API access (recommended for security).

  • Log in to Magento Admin Panel
  • Navigate to System → Permissions → All Users
  • Click Add New User
  • Create user with username like api_admin
  • Assign Administrator role or custom API role
  • Note the username and password for connection
2

Configure API Permissions (Optional)

For enhanced security, create a custom role with specific permissions.

  • Go to System → User Roles → Add New Role
  • Name it “API User”
  • In Role Resources, select required permissions
  • Assign this role to your API user

​
Linking the Account from the Hub

1

Navigate to the Hub

Use one of the three Linking Account Methods to access the Hub.
2

Fill out the fields

Fill out the following fields using details from your provider:
  • Store URL
  • Admin Username
  • Admin Password
3

Connect

  • Click Connect
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup

If the account linking is successful, you will see the newly linked account in your Accounts page.