Belco

This integration displays allows you to import all existing Magento customers into Belco and loads relevant customer information from Magento on the customer detail page.

Api access

Before you begin please check if the REST API is accessible. The easiest way to that is to open an API endpoint in your browser, eg. https://yourdomain.com/api/rest/customers.
The page should return XML with an Access denied message.

If you get a regular 404 page, make sure the rewrite rules for the REST API are enabled.

If you are using a firewall please whitelist our proxy: 185.60.151.19

1. Install the Magento extension

To enable this integration you first need to install our Magento Extension, if you've already installed the extension you can continue to step 2.

2. Create a new Consumer

First, you need to create a Consumer in the Admin Panel. Creating a new consumer means registering the application. To do this, perform the following steps:

  1. On the Magento Admin Panel menu, select System > Web Services > REST - OAuth Consumers.
  2. On the OAuth Consumers page, click Add New in the top right corner to add a new consumer.
  3. The New Consumer page opens. The Key and Secret fields are filled automatically and cannot be edited. These values are generated automatically and will be used to identify the Consumer in Magento.
  1. Fill in a name for the consumer, eg Belco
  2. Copy & paste the Key and Secret, as we'll need it in the next step.

Click Save in the top right corner to save the created Consumer.

3. Configure REST user roles

Then the appropriate roles have to be configured, in order to give Belco access to the REST api.

  1. On the Magento Admin Panel menu, select System > Web Services > REST - Roles.
  2. On the REST Roles page, click Add Admin Role
  3. Enter a role name, eg Belco
  4. Enter your admin password
  5. Configure the Role API Resources, select Retrieve for Orders, Order Item, Order addresses, Order Comments, Customer and Customer Address

Click Save Role to save the new role.

4. Configure REST attributes

  1. On the Magento Admin Panel menu, select System > Web Services > REST - Attributes.
  2. Click Admin
  3. Set Resource Access to all

Click Save to save the changes.

5 Configure user access

Next step is to assign the newly created role to a user.

Always create a new user without admin access for extra security.

  1. On the Magento Admin Panel menu, select System > Permissions > Users.
  2. Create a new user specifically to access the api.
  3. Open REST Role tab
  4. Select the Belco role you just created.

Click Save User to assign the new role.

6. Configure the integration

Now that we've created a consumer for Belco, we can enable the integration in the Belco dashboard.

  1. On the top right settings menu, click on Settings
  2. On the left navigation, click on the shop you want to connect to Magento and open the Magento integration settings page.
  1. Enter the root url of your shop, eg https://mystore.com/index.php (be sure to add /index.php after the url)
  2. If you use a custom admin path, replace admin by the path you're using.
  3. Paste the Key and Secret you just copied in the corresponding fields .
  4. Click Connect, a popup will be opened, redirecting you to your Magento store.
  5. In the popup login with the user for which you assigned the Belco REST role

If you're currently logged in as an admin user, log out first and continue from step 4.

Click Authorize to finish the configuration.

7. Importing existing customers

Once you successfully connected Magento you can import your existing customers into Belco.
New customers will be automatically added.

Click Import existing customers to start the import. Importing can take a while, depending on the amount of customers in your database.

Magento


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.