JSON API Designer
The JSON API Designer within Data Sync helps you to build the connection document (XML API definition) needed to describe the API you are wanting to use within your Data Sync projects. It is designed to be used with the JSON API Connector which also supports the connection library.
The designer allows for quick API configuration through automatic configuration from a URL, where JSON is loaded from a URL and Data Sync attempts to define a schema and fetch operation automatically.
You can quickly connect your API to the source or target of your project through the designer by right clicking on a data source and selecting Connect to Source like you would in the connection library.
You can open the JSON API designer from Data Sync by opening the Tools menu and selecting JSON API Tool.
When using the designer you may wish to auto hide the connection library, source and target windows to maximise your workspace. Just click onto the pin icon in the top right of each window to hide them into tabs.
You can bring them back into focus by selecting the tabs to open them and clicking onto the pin to keep them open.
Getting Started
Once you have opened the tool a basic skeleton framework will be loaded. Here you can either use the helper functions to build the connection file or you can write everything yourself.
We recommend starting by adding the Authentication to the document and then connecting to a datasource. As all subsequent API calls will use these authentication details.
You should also start by saving the connection file to your documents so then you can keep saving and come back to it at any time.
The documentation found within this JSON API section should help guide you to connect to your chosen API.
A few of the topics covered are: