Managing Rest Client Module

From osCommerce Wiki
Jump to navigation Jump to search

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."
2 Create data source.jpg

Create Data Source:

In the popup, choose the data source type and enter a name.

4 Data source name.jpg

The data source is now successfully created.

5 Data source created.jpg

Configure Data Source:

To configure the data source, click on the wrench icon or double-click on its folder.

6 Data source config.jpg

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."

8 Update access details.jpg

Setting Up Data Synchronization

1. Product Section:

Expand the Product section by clicking the + icon.

9 Product section.jpg

Customize product options, including server-client interactions and data update customization.

10 Product section A.jpg
11 Product section B.jpg
12 Product actions.jpg
13 Product images.jpg
14 Other Product settings.jpg

2. Order Status Mapping Synchronization:

Expand the Order Status Mapping Synchronization section by clicking the + icon.

15 Order Status mapping.jpg

Enter mappings for order statuses on the server by selecting from the drop-down.

16 Order Status mapping A.jpg

3. Orders and Customers:

Customize orders and address book synchronization options.

17 Orders.jpg
18 Customers.jpg

Adding Actions

1. Configure Directory Popup:

Click on the gear icon, then "Add more" in the Configure Directory popup.

19 Actions.jpg

Add actions by choosing from the dropdown.

20 Many Actions.jpg

2. View Selected Actions:

All selected actions will appear under the Data Sources tab.

21 Selected Actions.jpg

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.

22 Synch process.jpg

2. Process Progress:

In the Job process popup, monitor the progress data.

23 Job process popup.jpg

The result will be a customer list under the Customers tab.

24 Customer list.jpg

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.

26 Run frequency.jpg

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!