To be able to import into Dialog Insight data originating from your Magento transaction website, you must first authorize communication between the 2 applications. Each E-Commerce application has its own authorization process that must be meticulously followed to establish a proper connection.

Prerequisite
The E-Commerce module must be enabled.
Access Path
> Configuration > Relational data > E-Commerce page

How To

  1. In the Integration section, next to the Magento application, click on Activate, if not yet activated, or on Configure to edit the existing connection or add a new one.
  2. If one or more authorizations exist:
    1. Choose the connection you wish to use.
      *Only one Magento authorization can be enabled at a time. So if you have multiple connections, you will need to activate/deactivate them as needed.
    2. Click Save.
  3. If no authorization exists yet:
    1. You must first create one.
    2. To do so, click Create an authorization.
    3. Make sure to select the version YOU use for your transactional website.
      The valid Magento versions are:
      • Version 2 REST
      • Version 1 REST
      • Version 1 SOAP
      • Based on the Magento version you use, API types and versions are different. The REST type API is only compatible with Magento 1.7 or higher. As for the SOAP type API, it can only be used with Magento version 1.x. IMPORTANT - The REST type API is not the same for Magento 1.x and Magento 2.x versions. It is recommended to use the REST type API when possible.
    4. Click Continue.
    5. In Magento's authorization page, provide the requested information. Be aware that the data to provide, as well as the process, are slightly different depending on the Magento version you use, and is only available once you have created a Magento account and have defined at least one user.


Magento 2 REST

This format is compatible with Magento 2.x.

  1. Start by creating and retreiving your Magento keys:
    1. Once connected to your Magento account, access the administration page (Admin Panel).
    2. Go to System > Integrations.
    3. Click Add New Integration, and specify your Name and Email.

    4. Under the API tab, assign at least the read permission on Customers and Orders.

    5. Click Save & Activate.
    6. Then click Allow.
    7. In the next page, note the values for Key, Secret Key, Token and Secret token.

  2. Go back to the Dialog Insight application to enter the keys provided by Magento.

    1. Once all information is entered, click on Test connection.
    2. The access page to Magento's administration module will open again.
      1. Enter your user name and password.
      2. In the next window, confirm the displayed user's access.
    3. Back in Dialog Insight, you should see that the authorization has been granted with success.
    4. Click Continue.
    5. A page confirming that configuration is complete will display.
    6. Click Finish.

Magento 1 REST

The REST format is compatible with Magento 1.7 or higher.


  1. Start by creating or retrieving your Magento main and secret keys:
    1. Once connected to your Magento account, access the administration page (Admin Panel).
    2. Enter your user name and password.
    3. Then, in the System menu, select Web Services and REST - OAuth Consumers.
    4. In this page, select the name of your consumer or create one if you don't have one already. To see your keys, select your consumer's name and open the Consumer information page, where both main key (Key) and secret key (Secret) are.
    5. Go back to Dialog Insight and enter the two Magento keys.
      1. Once all information is entered, click on Authorize access.
      2. The access page to Magento's administration module will open again.
        1. Enter your user name and password.
        2. In the next window, confirm the displayed user's access.
      3. Back in Dialog Insight, you should see that the authorization has been granted with success.
      4. Click on Continue.
      5. A page confirming that configuration is complete will display.
      6. Click on Finish.

Magento 1 SOAP

  1. In Magento's authorization page, enter the requested information, which comes from your Magento account.

  2. Once the address, user name and API key are entered, validate the connection by clicking on Test connection.
    If information is accurate, authorization will be granted.
  3. Click on Continue.
  4. A page confirming that configuration is complete will display.
  5. Click on Finish.