Welcome to a quick tech tutorial on setting up an FTP or Web Service from one of your systems. For the example listed below we will be organizing the data feed output from a Woocommerce site however the same process is applicable from any of our ready to load systems or an endpoint you have created. Need some extra help please see our DSYNC user guide.
Please also note that DSYNC is a bidirectional system and can retrieve details from an FTP location and update systems as well. For example we could fetch information from the FTP location and update WooCommerce directly.
Add your first system
First, we will need to add a new system to your DSYNC dashboard
In this example, we will be using a Woocommerce store however we can set this up on multiple applications.
1) Select Add this system and then copy and paste your Woocommerce keys and credentials
Once you have added in all of your woo details the new system will be added to the dashboard. Don’t forget if you are setting up Woocommerce we will need “Read Write” permissions associated with the keys you set up.
Add your second system In this case it is an FTP location
- The next step is to add the FTP or the destination for your web service output. Select “Plus system” then select “ADD new Blank”
- Name the new output location
Add a new endpoint
Click on the new set up and then on the right select “Add endpoint”
A pop up box will appear
- Name your endpoint (you can name jobs anything)
- In the Type field we will be calling this “Destination” as we will be sending data to the FTP.
- In the section Connector Type please select “FTP”
You should now have a new system with a new endpoint added to your DSYNC dashboard
Add a data layout
Now we will need to go and gather the authorization settings and set up the FTP data layout. Most systems provide easy to find and apply data layout code in XML or JSON format. DSYNC uses V3 of the rest API for Woocommerce. As we are setting up a Woocommerce FTP DSYNC works well with V3 of Woocommerce Rest API.
When setting up a data layout we always refer to the JSON or XML data provided by the system we are looking to connect. Generally the most up to date data layout code is available within the systems API documentation. An example would be woocommerce docs available on GITHUB
What we are doing here is setting up a correct data layout. The correct XML and JSON code for products is usually available from within the systems API docs we can also obtain the correct API URL and Method for DSYNC to communicate with.
Once you have located the XML/ JSON code for the layout return to DSYNC.
- Double click on the system to bring up the “Endpoint” details
- Select either XML or JSON
- Then copy the code – In Woocommerce case the data layout is in JSON format
- Return to DSYNC and then select “Editor”
- Paste the JSON (in this case) code into the pop up box
This will create for you the Data layout of Woocommerce products or whatever snippet you instructed our editor to put in.
Create an endpoint
Now that we have created the data layout lets create an endpoint on the Woocommerce side. We are creating a new batch endpoint as we do not want to use the existing real-time endpoint that already exists on woo as we would like to schedule times for this job to be created and sent to the FTP.
Let’s create the new endpoint on the Woocommerce side
- Click on the system
- On the right hand side select “Add Endpoint”
- Name the endpoint
- For the output connection, the type would be considered as the “Source” as this is the origin
- For the connector type we would indicate “API” as we are using the WooCommerce API to output the data.
This will create a new API endpoint underneath our system
- Lets click on the new endpoint we have just created and set up the data layout
- Copy and paste the same sample JSON data for products we used for the FTP setup above
- Now the next step is to set up the authorization on each side of the sync. By clicking on the endpoint on the right panel the settings will appear The URL will be your website URL followed by the URL provided by the system as the HTTP request URL.
- Enter in the correct Method example "Get" method
- Authorization should be used if you have not used the wizard to “Pre Authorize” the system
Set up the FTP side Authorization settings
Now that we have set up one side we will also need to put in the right settings for the FTP side of the integration
By clicking into the FTP side we will need to set up all of the FTP access details
It is important to make sure all of the credentials are correct for the sync to occur properly.
Create a link / Relation
Now let’s make a link – relation for the sync to take places
- Click on the system endpoint (SOURCE)
- Select “Create Relation slash Link”
- Then click on the FTP endpoint we have set up (DESTINATION)
- Name the job
Create a Map for the SYNC
- Create a new data map for the SYNC
- Scroll through the map to make sure we have all the required fields identified with the Red asterisks (*)
- Add some fields and pair up to the corresponding data
- Save the map
If set up correctly the color of the line between the systems will change to Aqua meaning the sync looks good to go! You have now just set up a Product export from Woocommerce to your desired FTP location.
To test the job simply select the “RUN” button on the right panel
- If the job has been set up correctly you can view the check any error logs under the “History” section by selecting “Show More”
- Another handy feature is the ability to view the “Source”
You will also need to schedule when you would like the job to run at your required interval
how to connect WooCommerce to an FTP location – DSYNC can connect multiple systems to different web services for more information please help to talk to our friendly team.