Server
Magento v2
Connect your Magento v2 store backend to Converge
Installation Instructions
1
Set the Configuration
-
Open your terminal or command prompt and navigate to the root directory of your Magento 2 installation.
-
Execute the following command to set the
oauth/consumer/enable_integration_as_bearer
configuration option to1
.
bash
bin/magento config:set oauth/consumer/enable_integration_as_bearer 1
2
Verify the Configuration
- To ensure that the configuration has been set correctly, you can check the value using the following command:
bash
bin/magento config:show oauth/consumer/enable_integration_as_bearer
- The output should confirm that the value is set to
1
.
3
Navigate to your Magento Integration Settings
- Navigate to your Magento Admin Dashboard.
- From the Menu Sidebar, navigate to the System > Extensions > Integrations submenu.
4
Generate your Magento Admin Access Token
- Choose to generate a new key, and choose
Sales/Operations/Orders/Actions/View
as your scope. - Copy the generated access token, you will need it in the next step.
5
Create a new Server-side source in Converge
- In Converge, click on Create a new source
- Pick Server-side from the modal
- Name your source: e.g.
{Storename} Store Backend
- Choose the Magento v2 app from the dropdown menu.
6
Connect the Source to Magento
- Enter the full URL of the REST API of your Magento 2 store in the API URL-field, including
https://
, e.g.https://myshop.com/rest
- If your storefront is hosted on a different domain than your API, please provide the domain in the Storefront domain.
This domain should match the domain on which the Magento Storefront Module was installed. For example,
myshop.com
. Feel free to leave this blank if your store is hosted on the same domain. - Paste in the Admin Access Token you retrieved in the previous section in the Admin Access Token.
- Optionally, filter out orders by store view or modify the start date. You should leave these fields blank if you do not have a good reason to use them.
You should see the Source syncing all historical order data, you should wait until it’s fully synced to create connections
Event Spec
This integration auto-tracks the following events on the server with all properties available according to the Converge Event Spec.
Event Name | Event Description |
---|---|
Placed Order | When a customer places an order. |