Input Parameters:

Output Parameter:

Input Parameter:

Input Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Input Parameter:

Input Parameter:

Input Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Input Parameter:

Output Parameter:

Syncloop API Development Platform Documentation

At Syncloop, dedicated developers, Architects, and Tech Leaders plan and create APIs on a start-up-friendly and enterprise-ready API development platform. The platform acts as a bridge between the vendor database and the visual experience interface. It provides a high-quality, fast, comprehensive API development, management & deployment platform to enable organizations to be more agile. Syncloop offers the following key features:

• Provide a visual experience-based development environment where APIs are efficiently built, integrated, deployed, and made go live in seconds.
• Reduce 65% of the time in API development, 80% in debugging, and 90% in API deployment and management as compared to its other counterparts.
• Work with API development objectives to bring the most value and the quickest return on investment by automating workflows from a single platform.
• Address various integration issues that are mostly the outcome of legacy system adaptation.
• Furnish a collaborative role for all stakeholders to work in the best no-code technical architecture.
• Improve team agility through continuous coaching, training, documentation, discussion, blogs, case studies, and use cases.

Syncloop comes in four editions

Syncloop Shared Cloud

Empowers you to create highly optimized, managed, and massively scalable APIs in minutes with limited features. It includes extra reliability, monitoring, caching, tracing, security, and deployment features.

Syncloop Dedicated Cloud

Empowers you to create highly optimized, managed, and massively scalable APIs minutes with unlimited features. It includes extra reliability, monitoring, caching, tracing, security, and deployment features. This is the most popular solution for small enterprise production.

Syncloop Enterprise Cloud

Builds on all the features of the API Development Platform while giving you an enterprise-ready solution - complete with key features like observability, security, and performance - deployable in minutes. It uses the Syncloop Cloud for Deployment.

Syncloop Enterprise On-Prem

Builds on all the features of the API Development Platform while giving you an enterprise-ready solution - complete with key features like observability, security, and performance - deployable in minutes. Syncloop container can be hosted on the private/on-premise cloud.

QUICK START SYNCLOOP

Visit www.syncloop.com and click the button link Start Building Your API

Go to the screen Login in with Syncloop and register or login with existing username and password or login with google credentials.

Once registered login into the workspace, and you will get this window. This window is called the Integrated Development Environment workspace wherein APIs are built, managed & migrated.

The various tools present in the workspace are shown in the figure above and their brief functions are discussed below

• Workspace
• Scheduler
• Documentation
• API
• Create Build
• Import
• API Token
• Settings
• Package Explorer

Get started for FREE

Create your APIs easily by saving up to 65% time on development.

Get started for FREE View Pricing & Plans

Create your first web service/API “Hello World”

Right-click on Packages select New Package

A create package window will be displayed

Type the name of the package as Messaging and click Ok button. A package named Messaging will be created successfully and will be visible in the package explorer window.

A dependency folder, a config folder and a default package will be created in the Package Explorer Window.

Right Click on Messaging Package and select New Folder

Type the name of the folder and click Ok button

After clicking the folder, the folder DemoMessage will be visible as the child item of Package Messaging.

Right-click on DemoMessage click on New 🡪 New Folder and select Flow to create an API.

Type the name of the new Service Flow and click Ok Button

A new Service will be created under Messaging 🡪 DemoMessage package

Double click on MessageService and this will open a Workspace Window on the right side of the environment. The works

Click on the Save Button placed at the top in the workspace window to save the service. This should be done periodically so as the work remains saved.

The Service will be saved.

Right click on the Workspace window, a FLOW DESIGNER menu will appear. Select MAP from the menu.

This will open a new window having input and output variable/parameter sections

The parameters will mostly be input and output which are responsible for getting the request from the client and providing the necessary response. These sections are used to create variables & Parameter and also to manipulate them.

Right click on the response section of Parameter Mapping, a OUTPUT SCHEMA will appear and select String in the context menu.

A string parameter will be created in the Response Section

Right Click on the STRING parameter and rename it to strMessage

Click on the Pen tool

A Set window will appear. This window is used to assign value to the parameter strMessage. Once the window appears type Hello World...!! I in the text box and click Ok button.

Right Click on the Output Parameter Section of the Workspace Window, Output Schema Menu will appear. Select String from the menu.

Create the similar parameter strMessage as String in the Output Parameter Section.

Click on the Save Button placed at the top in the workspace window to save the service. This should be done periodically so as the work remains saved.

The Save message box will appear confirming the save operation has been done successfully.

With this our first web service MessageService is created and now we need to test this service.

Any client tool can be used for testing. Here we are using Postman for testing.

Note: if you have not installed postman click on the link below and install it.

https://www.postman.com/downloads/

Once the post is installed click on the

Get the URL from the Syncloop platform by double clicking on MessageService and selecting configuration tool form Workspace Window. Copy the Service Endpoint path from the window by clicking on copy icon.

Paste the Service Endpoint link in the Request URL text box of the Postman API tester.

For authorization, select the Bearer Token option from the Authorization menu in the Postman API testing.

Copy the token text from API platform workspace by clicking on API token in the Syncloop IDE Tool Box.

Copy the token text from the API Token window and click Ok button

Paste the token value in the token text box of the Postman API tester.

Now click on button and send the request to the server. Visualize the output in the response section of the Postman API tester.

The output Hello World...!! is clearly visible in the response window. With this, you have successfully tested your first API on the Syncloop Platform.

Building API using Conditional Logic

In this web service, we are sending the country name as a request and getting the capital of that country in response using the Syncloop Platform.

Login into the Syncloop API Development Platform and let us start creating that Service.

Right Click on Package root in the package explorer window and select New Package

A Package dialog box will appear.

In the Package Name Text-Box, type the name of the package as hands-on and click on Ok Button.

Package handson will be created in the package explorer with one dependency folder, a child folder config, and a default child package. Now Right-Click on the handson package and create a new folder api. Type the name of the folder and click the button Ok.

A new folder named api will be created under the handson folder.

Right-Click on the api folder select New 🡪 Services and click on Flow.

A Create Flow dialog box will appear. Click on the Flow Name text box and type findCapital and left-click on the Ok button.

A service flow named findCapital will be created.

Double Click on the findCapital and visualize the workspace on the right side of the development environment.

The details of the workspace environment have already been shown in the Quick Start Document. Click save to save the web service.

A message dialog box will appear confirming the save operation.

Going ahead in creating the API by creating an input parameter by right-clicking on the input parameter section and selecting String

An input parameter String named STRING will be created in the Input Parameter Section of the workspace.

Right-click on the input parameter STRING and select rename and rename it as country_name

The input parameter is renamed to country_name. This input parameter will be sent by the client and the same parameter will be evaluated for its capital and that will be sent to the requesting client.

Now we are going to create the switch statement on the workspace. Right-Click on the Statement Control Section of the workspace, a FLOW DESIGNER context menu will appear. Select Switch from the context menu.

A structure of the switch statement will be created in the Statement Control Section of the Workspace.

Right-Click on the SWITCH and select properties

A Properties dialog window will appear. Type the name of the Switch Variable in the Textbox and click the Ok button. Here the switch variable is country_name, therefore type the said variable name in the Switch Textbox.

Now Right-Click on the SWITCH and Select Add 🡪 Case

A CASE statement will be added as a child to the SWITCH Statement. Click on the SWITCH to view the CASE

Add four CASEs under the SWITCH by repeating the steps mentioned above.

The four CASEs will be added as a child to the Graphical User Interface (GUI) SWITCH statement.

Click on the Save button in the toolbox of the Workspace

A message dialog box will appear confirming the save operation.

Click the Ok button to complete the save operation.

Now populate the cases of the SWITCH by Right-Clicking on the first CASE and selecting Properties in the context menu strip.

A properties window will appear. Type the name of the CASE value and click the Ok button. Here the value added is INDIA

Repeat the above step and add the CASE value as USA. For handling the default values in the GUI SWITCH Statement enter #default in the third CASE value.

Click on the Ok button to confirm when the case value provided is not specified in the SWITCH statement.

When no value is specified for the input parameter country_name then the CASE value to handle such values is specified as null. This handles empty or null values for the SWITCH statement.

Click on the Ok button to confirm the null value which is specified as #null.

Now the SWITCH-CASE statement is populated with the values.

These SWITCH-CASE statement values are viewed in a tree structure.

Now mapping is done for input and output parameters. To perform the said operation Right-click on the first CASE: INDIA and select Add 🡪 Map from the context menu strip.

A map will be created as a child to the first CASE.

Click on the Map and the input and output parameters will be displayed in the Request and Response section of the Workspace.

Now Right-Click on the Response Section of the Workspace an Output Schema context menu will be displayed. Select String from the context menu.

A variable named STRING will be created. Right-Click on the STRING variable and rename it as capital.

Save the web service as specified above.

Select on the variable capital and click on the pen toolbar in the Response Section. A Set dialog window will be displayed. Type the name New Delhi in the Set Value Text Box and Click on the Ok button. This value is the capital of India.

Repeat the above steps and assign the value to the capital as shown in the table below

Save the changes and Right Click on the Output Parameter Section of the Workspace. An Output Schema context menu will appear. Select String from the context menu.

A STRING variable will be created in the Output Parameter Section.

Right-Click on the STRING variable and rename STRING to capital. This capital is the Output Parameter Section that will store the capital of the requested country_name value. The rename operation is already shown above.

The name of the variable capital should be the same as the capital name specified earlier in the Response Section of the Workspace.

Save the API as shown above so that changes are successfully saved.

Click on the configuration toolbar in the Workspace to get the endpoint.

A configuration window will appear. Copy the endpoint path specified in the Service endpoint by clicking on Copy icon at the end of the Service Endpoint Textbox.

Once the Service Endpoint is copied, open the postman API testing application and paste the link in the URL.

In the postman application, click on the Authorization 🡪 Bearer Token

Go to the Syncloop platform and select API token from the Toolbar.

Click on the API Token tool, API Token dialog box will be displayed with a Bearer token value. Copy that bearer token value.

Paste the token value from Syncloop Workspace into the bearer token textbox in the Postman Application.

Go back to the params tab in the Postman Application and do the following steps.

1. Click the Checkbox
2. Write the country_name variable name in the key section
3. Write the Country Name value ie. INDIA
4. Click on the send button
5. The output will be displayed in the Response Section. (here output is New Delhi).

Now Try giving different key values in the Postman app and Observe the Outputs

When country_name is USA

When country_name value is not specified in the SWITCH Statement.

When nothing is passed as a key and value for country_name

Building API using Looping Logic

This is the 3^rd Web Service that is connected to the conditional logic Web Service. In this service, we will send multiple countries and try to get their capital using the API created previously for conditional logic.

In this web service, we are sending the country name as a request and getting the capital of that country in response using the Syncloop Platform.

Login into the Syncloop Development Platform and let us start creating that Service.

Right Click on Package root in the package explorer window and select New Package

A Package dialog box will appear.

In the Package Name Text-Box, type the name of the package as hands-on and click on Ok Button.

Package handson will be created in the package explorer with one dependency folder, a child folder config, and a default child package. Now Right-Click on the handson package and create a new folder api. Type the name of the folder and click the button Ok.

A new folder named api will be created under the handson folder.

Right-Click on the api folder select New 🡪 Services and click on Flow.

A Create Flow dialog box will appear. Click on the Flow Name text box, type findCapitals and left-click on the Ok button.

The naming details of the Syncloop workspace environment have already been shown in the Quick Start Document. Click save to save the web service.

A message dialog box will appear confirming the save operation.

Double-click on the findCapitals in the Package Explorer and open the Workspace Window.

Right-Click on the input parameter section and an INPUT SCHEMA content menu will appear.  select From-> JSON from the context menu.

A JSON Input Dialog will appear prompting for “Enter JSON Payload here”. As we have to enter multiple countries as input, we will be using arrays for such inputs. This input is also termed Input Payload for the Web Service.

Type the input payload for the Web Service in an Array. Here specify “country_name”:”” in an array and click on Apply button.

This will create an Input Payload for the Web Service and is viewed in the Input Parameter section of the Workspace Window.

Right-Click on the Statement Control Section of the workspace. A FLOW DESIGNER context menu will appear. Select Map from the context menu and left-click on it.

The MAP will be displayed in the Statement Control Section and payloads will be displayed in the Request Section and Response Section of the Workspace window.

We clearly visualize the country_name parameter in the Request and Response section of the Workspace Window. As we need to transfer the value of country_name to some other container. Drop the Response Section Payroll by selecting the payload and clicking on the thumbs-down tool in the Response Section. It will not be used in further steps.

The thumbs-down image will be displayed with the payload.

Right-Click on the Response Section and the OUTPUT SCHEMA context menu will appear select the Document option.

A DOCUMENT Parameter will be created in the Response Section

Right-Click on the DOCUMENT parameter and select rename option.

Rename it as countries.

Right-Click on the countries parameter and select Properties from the context menu.

The Properties window of the countries parameter will be displayed.

Select the “It’s an array” check box and click the OK button.

Right Click on countries, and a context menu will appear. Select New 🡪 String from the menu

Save the Web Service by clicking on the Save tool at the top of the Workspace toolbar.

A message dialog box will appear confirming the save operation.

Rename the STRING as country_name

Rename the STRING parameter as country_name

Click on the payload 🡪 country_name in the Request Section and drag the cursor to the countries 🡪 country_name in the Response Section of the Workspace window.

A link will be created and will also be visible by a line joining/mapping the two Request and Response parameters. While mapping the child elements *payload 🡪 country_name will be mapped with countries 🡪 country_name, the parent elements *payload and countries will also be mapped.

Now we need to run the loop onto the countries document (array). So Right-click on the workspace and select loop.

A loop will be created in the workspace.

Now Right-Click on the loop and select properties.

The properties dialog will be displayed

In the input list textbox enter the element on which the loop will be implemented. It can be done using two ways.

1. Go to the Response Section of Syncloop IDE, copy the element’s XPath, and paste it into the input list textbox.

2. Type directly the name of the element in the input list TextBox (Here it is countries)

Type countries  in the input list text box and click on the OK button

Right Click on the loop and add invoke

An INVOKE element will be created under LOOP

This invokes elements will be used to invoke the previous web service that has been already created in the conditional logic documentation named as findCapital.

Right-Click on the INVOKE and select a Service menu option

A dialog will be displayed. Select the previous web service findCapital and click on the Done button to confirm.

The path of the web service in the package will be appended as the child of the INVOKE

Now we need to send the county in the loop and get the capital. Click on the packages/handson/api/findcapital link and observe the elements in the Request and Response Section of the Syncloop Workspace.

Let us map country_name with country_name in the request section of the workspace.

A link has been established between two country_name elements in the Request Section of Workspace.

Right click on countries and create one more STRING parameter.

Rename the parameter as capitals

Now map the capital with countries 🡪 capital from click and dragging capital to countries 🡪 capital to create a link shown below.

Now both mappings are displayed

Create an output parameter as document type by right-clicking on the Output Parameter Section.

A document type parameter will be created.

Right-Click on the DOCUMENT and select rename and rename it to countries.

DOCUMENT has been renamed to countries.

Right-click on countries and select properties .

Check it’s an array option and click on OK button. Now click on the save tool on the workspace tool bar.

A save confirmation dialog will be displayed. Click on Okay button to confirm it.

Click on the configuration button  from the tool bar. Configuration dialog will be displayed.

On the configure properties dialog change method to POST as we are sending the request payload. Copy the copy button on the service endpoint and copy the path.

Click on OK Button.

A save confirmation dialog will be displayed. Click on Okay button to confirm it.

Now open the Postman application and Click on the + to create a new HTTP request as Untitled Request

Copy the endpoint path in the Enter Request URL text box and change GET to POST in the drop-down menu.

Now change the authorization by copying the API Token from the Syncloop workspace

Paste the same into the Authorization 🡪 Bearer Token 🡪 Bearer Token text box.

No in the Postman application go into the Body 🡪 Raw section and create your payload in the text box as shown below. Also, change the Text drop-down property to JSON.

Now enter the payload for multiple countries in JSON format.

                                        
                                        [
                                        {
                                            "country_name" : "INDIA"
                                        },
                                        {
                                            "country_name" : "USA"
                                        },
                                        {
                                            "country_name" : "JAPAN"
                                        }
                                        ]
                                        
                                        

Place the JSON code in the text box and click on Send Button

Observe the response

Multiple Countries and Capitals are displayed in a single request when the payload is sent in JSON format.

Weather API

This tutorial deals with using an external API in the Syncloop API Development Platform. In this tutorial, we will try to consume an external API on the Syncloop platform and create the response.

In this tutorial we are using a weather API which is given by

http://api.openweathermap.org/data/2.5/weather?appid=8491317325e3d20e220876c31fce2812&lat=30.7179016&lon=76.65822

The above URL has three parameters appid, lat, lon. The appid is the API key, lat is latitude and lon is longitude. The response data after submitting the above URL is given in JSON format as:

                                        
                                        {
                                            "coord": {
                                                "lon": 76.6582,
                                                "lat": 30.7179
                                            },
                                            "weather": [
                                                {
                                                    "id": 800,
                                                    "main": "Clear",
                                                    "description": "clear sky",
                                                    "icon": "01n"
                                                }
                                            ],
                                            "base": "stations",
                                            "main": {
                                                "temp": 284.6,
                                                "feels_like": 283.73,
                                                "temp_min": 284.6,
                                                "temp_max": 284.6,
                                                "pressure": 1018,
                                                "humidity": 74,
                                                "sea_level": 1018,
                                                "grnd_level": 981
                                            },
                                            "visibility": 10000,
                                            "wind": {
                                                "speed": 3.22,
                                                "deg": 320,
                                                "gust": 5.73
                                            },
                                            "clouds": {
                                                "all": 0
                                            },
                                            "dt": 1674835755,
                                            "sys": {
                                                "country": "IN",
                                                "sunrise": 1674784069,
                                                "sunset": 1674822234
                                            },
                                            "timezone": 19800,
                                            "id": 1266960,
                                            "name": "Kharar",
                                            "cod": 200
                                        }

                                        
                                    

To start with click Login in the Syncloop workspace by clicking on the link below

Click on the Package and select the handson package which we have already created and select api folder. Right-click on the api folder and select new flow service.

A Create New Flow Dialog will appear.

Type the Flow Service name as weatherInfo and select developers from Developer and click on the OK Button.

As this is a Weather API, we expect two inputs one for the Latitude coordinate and one for the Longitude coordinate. Both values are of type string.

Create input parameters for latitude and longitude. Right-click on the Input Parameter Section and select String and rename it as lat

A parameter of type String will be created.

Now Right-Click on the Parameter String and select rename

Rename the String Parameter to lat (for latitude coordinate)

Repeat the process for creating another parameter lon (for longitude)

Now we have created two input parameters lat and lon for storing latitude and longitude coordinates

Right-click on the workspace and a FLOW DESIGNER context menu will appear. In the context menu select MAP.

This will create one MAP component in the workspace.

Now let us initialize a few parameters url and method

Right-Click on the Response Section and in the context menu select String. Right-Click on the String and rename it to url. Repeat the above steps to create one more element in the Response Section and rename it to method.

URL-A (Static) :http://api.openweathermap.org/data/2.5/weather?appid=8491317325e3d20e220876c31fce2812&lat=30.7179016&lon=76.65822

Here lat and lon values may be replaced by input parameters and the corresponding url will be rewritten as. This will make these values dynamic.

URL-B (Dynamic) http://api.openweathermap.org/data/2.5/weather?appid=8491317325e3d20e220876 c31fce2812&lat=#{lat}&lon=#{lon}

Click on the url element and select initialize an element from the toolbar. A Set dialog window will be displayed. Enter the above url in the below format.

Copy and paste the above URL-B in the value textbox and select evaluate expression from the options and click on the OK button.

Now select the method element in the Response Section and click on initialize an element.

A Set window dialog will be displayed. Type GET in the value textbox and click on OK button.

Now let us add one HTTP Client. Click on the Syncloop workspace, a FLOW DESIGNER context menu will appear. Select service option from the context menu by clicking on it.

An invoke element will be added to the workspace.

Right-Click on the invoke element displaying a context menu.

Click on Select a service from the menu. Select a service dialog will be displayed.

Now type request into the package explorer search text box so as to search it. Click on the request and then click on the Done Button

Now click on the request service and all the parameters will be displayed in the Request and Response Section of the workspace.

Now pass the parameters for url and method elements.

Two connections between url-url and method-method will be created by clicking and dragging on the two element pairs.

Now Create one parameter resp of type String in the response section and map resPayload with it.

Save the project by clicking on the save tool bar in the workspace. A save dialog box will appear confirming the save operation. Click on Okay button to close the dialog.

Now we have the response in the form of the string and we need to convert this string into JSON format. For that we need to add one more HTTP Client. The service is to be created so that the string output may be converted to JSON format.

Click on the Syncloop workspace, and a FLOW DESIGNER context menu will appear. Select the service option from the context menu by clicking on it.

A new INVOKE element will be created in the workspace.

Right-Click on the INVOKE element and click on “Select a Service”

A select a service dialog will be displayed.

Now Type fromJSON keyword in the package explorer search text box  and click enter

Click on from.JSON in the package explorer and click on Done button to close the dialog. The from.JSON service will be added to the workspace. Now click on the service and observe the elements being displayed in the workspace.

This is done to convert the String element resp to JSON format we need to call the service fromJSON.

Map the input parameter resp with jsonString and create a new output parameter response of type Document and map it with output.

Create the same parameter response of type Document in the output section

Save the service by clicking on the save tool bar in the workspace. A save dialog box will appear confirming the save operation. Click on Okay button to close the dialog.

Our web service is complete and let us test it now. Click on the configuration tool in the workspace tool bar.

A configuration properties dialog will appear. Copy the endpoint value from the toolbar by clicking on the copy icon and then clicking on the OK button to close the dialog.

A copied message will be displayed on the copy tool confirming copy operation.

Open the Postman application and create a new request. Paste the service endpoint value in the request URL. Set authorization 🡪 Bearer Token value to the copied value of API token from the Syncloop workspace. Set method to GET

Add two key parameters lat and lon and set their values and click on Send button to send the request.

Here we clearly observe that we get the similar response from that external weather API

Now we can change the parameter values of lat and lon for various regions and observe the climatic conditions.

This is how you can create an integrate external API using a Syncloop API development platform.

Crypto Currency Converter

Welcome back to our new tutorial. This tutorial will show you how to consume an external API on the Syncloop API development platform. We are trying to use a Currency Convertor API which provides the currency conversion rates of any two currencies. The details including the endpoint of the API are shown below:

The API URL is given by

https://min-api.cryptocompare.com/data/price?fsym=BTC&tsyms=USD

Let us create the service for this API on the Syncloop API Development Platform

Login into the Syncloop API Development Platform workspace and create a new Flow Service

While clicking on the flow menu item a New Flow dialog will appear. Enter the name Flow Service name as cyptoService and select developers from the developers and click on OK button.

In this service we expect two parameters from-currency and to-currency. So to implement that we need to create two input parameters in the Syncloop workspace of type String and name them from and to.

Right-Click on the Input Parameter Section and an input Schema context menu will be displayed. Click on the String option.

A new String input parameter will be created.

Right-Click on the String parameter and select Rename. Rename the parameter to from.

Repeat the above two steps for creating the second parameter in the input parameter section and name it as to.

Now we have successfully created two input parameters from and to

Right-Click on the workspace and a FLOW DESIGNER context menu will appear. Select MAP from the context menu to create a new MAP.

A new MAP will be created with two elements from and to in the Request Section  and the Response Section of the workspace.

Now right-click on the Response Section of the Workspace. An OUTPUT SCHEMA context menu will appear. Select String from the context menu.

Right-Click on STRING parameter and a context menu will be displayed. On the content, menu click on Rename option to rename the STRING to url

Now go to the Currency Convertor URL shown below and copy it:

https://min-api.cryptocompare.com/data/price?fsym=BTC&tsyms=USD

Click on the url element in the Response Section of the workspace and select initialize the element tool from the section toolbar. 

A Set dialog window will appear. In the value text box of the dialog paste the URL of the currency converter that was already copied.

Now modify the path which has been pasted in the value textbox in the Set dialog window for fsym and tsym parameters. Modify the URL string by passing dynamic parameters (from and to) from the workspace to the URL for the above two parameters.

The modified URL string will look like this

https://min-api.cryptocompare.com/data/price?fsym=#{from}tsyms=#{to}

Modify the string in the textbox also by manually changing it or copy-pasting the above URL string in the value textbox of the Set dialog. Select the evaluate expression from the option list.

Click on the OK button to confirm the initialization.

Create another parameter of type STRING in the Response Section of the Syncloop workspace and rename it to method.

Click on the method element in the Response Section of the workspace and select initialize the element tool from the toolbar.  A Set dialog will be displayed. Type GET in the value textbox and click on the OK Button.

Let us call the HTTP Client now. Right-Click on the workspace and a FLOW DESIGNER context menu will be displayed. Select Service from the context menu.

A new INVOKE will be added to the workspace

Right Click on the INVOKE and select “Select Service”

A dialog for selecting a service will be displayed. Search the service in the package explorer window by typing request in the search package textbox.

Select the request by searching in the package search textbox and then clicking on the request service once searched. Once the request service is selected click on the Done button to confirm. HTTP client path will be added to the workspace.

Now click on the HTTP Client path and observe the input and output parameters

Now map the parameters in the Input and Output sections of the workspace.

First map the url and the method elements in the Input Section of the workspace by clicking and dragging url element with url and the method with the method.

Now taking the response in the Response Section of the workspace. To get the response create a new element in the Response Section of the type STRING and rename it to resp.

Right-Click on the response section and an OUTPUT SCHEMA context menu will be displayed. Select String from the context menu.

Right-click on the STRING and Select Rename. Rename the STRING element to resp.

Map the resp element with the respPayload in the Response Section.

Save the Service by clicking on the Save tool in the Workspace tool bar.

A Save dialog will be displayed confirming the save operation. Click on the Okay button to confirm.

Now we need to create another service for converting the string to JSON as we did in the WeatherAPI tutorial.

Now right-click on the Syncloop Workspace and a FLOW DESIGNER context menu will be displayed. Click on Service in the context menu.

A new INVOKE will be added to the workspace.

Now Right-Click on the INVOKE and a context menu will be displayed. Select “Select a Service” from the context menu.

A dialog for selecting a service will be displayed. Search the service in the package explorer window by typing request in the search package textbox. In this case, we have to type fromJSON in the search package textbox.

Select the fromJSON by searching in the package search textbox and then clicking on the fromJSON service once searched. Once the fromJSON service is selected click on the Done button to confirm. The fromJSON service will be added to the workspace.

Now click on the fromJSON service path and observe the input and output parameters in Request and Response sections of the workspace.

In the Request Section of the workspace map the resp element with jsonString

Now create the output parameter as response of type Document. To do that right-click on the Response Section in the workspace and an OUTPUT SCHEMA context menu will be displayed. Select the Document in the menu by clicking on it.

Right-Click on the Document element and a context menu will be displayed. Select Rename from the context menu by clicking on it. Rename the DOCUMENT element to the response.

Now map the output with the response element in the Response Section of the workspace by clicking and dragging.

We need to create one output parameter with same name response. Right-Click on the output section and an OUTPUT SCHEMA context menu will be displayed. Select DOCUMENT by clicking on it.

Right-Click on DOCUMENT and a context menu will be displayed. Select Rename to rename DOCUMENT to the response.

Save the Service by clicking on the Save tool in the Workspace tool bar.

A Save dialog will be displayed confirming the save operation. Click on the Okay button to confirm.

Click on the configuration tool and open the configuration dialog. Set method to GET and copy the service endpoint of the web service by clicking on the copy tool. While you copy the service endpoint a copied message will be displayed on the tool.

Now let us test the service now.

Open the Postman application and create new request and paste the endpoint in the request URL. Set the method to GET and pass the parameters from and to. Set from parameter value to ETH and to parameter value to BTC.

Set the Authorization to Bearer token and copy the API token value from the workspace.

and paste it into the bearer token textbox in the Postman Application and Click on Send button to send this request.

Observe the Response from the server.

The detailed output is shown in the response section of the Postman Application. In this example, the service is providing the conversion of ETH to BTC