Docs Menu
Quick Start Syncloop / Hello World API

Create your first API “Hello World”

Right-click on Packages select New Package


A create package window will be displayed

Create package

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

New Folder

Type the name of the folder and click Ok button

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 Web to create an API.

New Folder

Type the name of the new API and click Ok Button

Ok Button

A new Service will be created under Messaging 🡪 DemoMessage package

Demo Message

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

Messages Service

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 API 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

Response Section

Right Click on the STRING parameter and rename it to strMessage


Click on the Pen tool

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.

Hello World...!!

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

Output Parameter Section

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

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.

Service Endpoint

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

Request URL

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

Bearer Token

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

API Token

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


Now click on save 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.