Managing Rest Client Module
Congratulations on installing the Rest Client Module! This user guide will walk you through the steps to efficiently manage your Rest Client within the admin area, offering a seamless solution for synchronizing two or more websites. To make the most out of this module, follow the steps outlined below.
Note: Rest Client is dependent on Rest Server, so ensure the Rest Server module is also installed.
Creating and Configuring Data Sources
Access Data Sources:
- After installation, navigate to the Products/Catalogue and Import/Export tabs.
- Select the Data Sources tab and click on "Create data source."
Create Data Source:
In the popup, choose the data source type and enter a name.
The data source is now successfully created.
Configure Data Source:
To configure the data source, click on the wrench icon or double-click on its folder.
Copy the department API URL and API key from the Rest Server settings page to insert into the required fields of the data source configure popup.
Click "Update access details."
Setting Up Data Synchronization
1. Product Section:
Expand the Product section by clicking the + icon.
Customize product options, including server-client interactions and data update customization.
Order Status Mapping Synchronization:
Expand the Order Status Mapping Synchronization section by clicking the + icon.
Enter mappings for order statuses on the server by selecting from the drop-down.
Orders and Customers:
Customize orders and address book synchronization options.
Adding Actions
1. Configure Directory Popup:
Click on the gear icon, then "Add more" in the Configure Directory popup.
Add actions by choosing from the dropdown.
2. View Selected Actions:
All selected actions will appear under the Data Sources tab.
Data Synchronization Process
1. Initiate Synchronization:
For example, to synchronize customer data, select "Synchronize Customers" in the Type column.
Click the green triangle in the Action column to implement this action.
2. Process Progress:
In the Job process popup, monitor the progress data.
The result will be a customer list under the Customers tab.
3. Repeat for Other Types:
Repeat these steps for other synchronization types.
Cron Settings
The module allows you to manage the synchronization run frequency using cron.
Access cron settings by clicking the clock icon or selecting the desired frequency from the dropdown on the Configure Directory popup.
You've now successfully configured and synchronized your data using the Rest Client Module. Whether it's managing products, orders, or customers, this module provides a robust solution for synchronizing multiple websites seamlessly.
If you have any questions or encounter issues, refer to the documentation provided with the module. Happy synchronizing!