Introduction to Agile Data Sync

Agile Data Sync or ASL SYNC is an add-on plugin for Agile Store Locator that lets users sync the store data on Agile Store Locator with their API endpoint.

Once users sync their API endpoints with the Agile Store Locator, all changes in the API data will automatically be reflected in the Agile Store Locator plugin. As a result, you will no longer need to manually make changes to the store data on your Agile Store Locator account.

How Does It Work? #

To sync your API endpoint with Agile Store Locator, please follow the below steps:

1. Download ASL SYNC
2. Log in to your WordPress account, and click on ASL SYNC
   
3. On the “Data Synchronization Jobs” page, click on “+ New Sync API”
   
4. You will be taken to the “Agile Store Datasource Synchronization” page

On the “Agile Store Datasource Synchronization” page, you must complete 3 steps to sync your API endpoint with Agile Store Locator.

Let’s go over these steps one by one.

Step 1 – Setup API Connection #

In the first step, you will need to enter the configuration details of the API source through which the store data will be synchronized.

To proceed, fill in the below fields:

1. API Title – Title of your API endpoint
2. API Endpoint URL – The URL address of your API endpoint
   
3. Response format – Select either JSON or CSV
4. Fill in the rest of the fields as needed
5. Click on “Check Connection” to complete the first step
   

Once you click on “Check Connections”, you will be taken to the “Fields Mapping” section.

Step 2 –  Field Mapping #

In the second step, you will need to map the “Store Fields” ( that correspond with fields in Agile Store Locator) to the fields in your API endpoint.

All custom fields have the prefix “custom-” attached to the field name. The rest of the fields are the default fields in Agile Store Locator.

Let’s go over a few of the store fields.

1. api_Item_id – This is the unique identifier of your API
2. updated_on – This is the timestamp of the last update for each API record. Only records not updated in the previous execution will be updated in the next execution, according to the timestamp set.
   
   

Continue to map the rest of the store fields to the API fields, and click on “Save Mapping” when you are done.

Step 3 – Finalizing Setup #

In this step, you will just need to select a few options to complete the process.

Choose an option for the below fields:

1- Frequency – This determines how frequently the store information in Agile Store Locator is updated through your API endpoint.

2- Status – Enable or disable the synchronization process.

3- Deletion – Enabling this option will delete any records that don’t match with the records in your API endpoint.

Click on “Finish” when you are done.

The synchronization process will execute after the period you selected in the “Frequency” field has passed.

Alternatively, you can press the “Execute” button to manually execute the synchronization process.

Once the synchronization process is executed, you will receive a summary of the activity that occurred.

Step 4 – Check Your Store Data on the Agile Store Locator #

Once the synchronization process is done, you can head over to the Agile Store Locator plugin and see if the changes in your API are reflected in the plugin.