Skip to content
Zyllio Documentation English
Welcome
First application
Dashboard
Design tool
Screen editor
Screen sequence editor
Simulation
Publications
Plugins
Tutoriels
Tutoriels

icon picker
REST Integration

info
Available from the Enterprise plan.
This integration allows you to connect an external data source to your Zyllio application. This external system must expose a REST API, which is the current standard for data exchange between systems.
This integration enables you to query, create, and update external data.

Configurations

It is necessary to provide the configurations for your REST integrations from the Settings tab, then Integrations.
Enable the REST integration by clicking on Enable
⁠
image.png
configuration des configurations REST
⁠
⁠
Zyllio allows you to define as many REST configurations as needed. A REST configuration enables you to set the parameters for the REST service (Endpoint URL, Headers, etc.).
For example:
A first integration with XANO
A second integration with BigQuery
A third integration with Instagram

Defining a REST Configuration

Click on the + button to add a configuration.
The following parameters are required:
Parameter
Comment
1
Name
The name of your integration, which must be unique.
2
Endpoint URL
The base URL of the REST request, which will be used as a prefix in the actions.
3
Headers
The necessary HTTP headers to invoke the REST request. For example, an authentication token or API key can be provided.
There are no rows in this table
⁠
⁠
image.png
Example of a REST Configuration
⁠
⁠

Triggering a REST Request

Actions are available in the REST section of the action editor. There is one action for each type of request: GET, PATCH, PUT, POST, DELETE
Method
Objective
1
GET
Reading Data
2
POST
Creating Data
3
PUT
Updating Data
4
DELETE
Deleting Data
5
PATCH
Partially Updating Data
There are no rows in this table
⁠

Query Request

The Get Request action allows you to query an external data source.
⁠
image.png
Example of a GET request that relies on the Retrieve memes configuration
⁠
⁠
The following parameters are available:
Parameter
Comment
Optionnal
1
Variable
The name of the variable where the result of the request will be stored.
2
Additional path
Additional path to be added to the URL of the REST service (endpoint of the configuration).
3
Request parameters
Additional parameters that depend on the called REST service to refine the data search.
Example: sort=ASC
4
Response expression
An expression that indicates the path to the data in the returned JSON message.
The above example selects the first meme (meme[0]) present in the data field.
There are no rows in this table
⁠

Response Expression

A response expression allows you to select the data you want to extract from the JSON response.
The following public REST service:
https://api.imgflip.com/get_memes
⁠
returns this JSON structure.
{
"success":true,
"data": {
"memes": [{
"id": "0",
"name": "Drake Hotline Bling",
"url": "https://i.imgflip.com/30b1gx.jpg"
},{
"id": "1",
"name": "Two Buttons",
"url": "https://i.imgflip.com/1g8my4.jpg"
}]
}
}
A response expression allows you to select only the data that the mobile application needs.
Example
Result
Description
1
success
“true”
Returns a simple value.
2
data
"memes": [{
"id": "0",
"name":"Drake Hotline Bling",
"url":"https://i.imgflip.com/30b1gx.jpg"
},{
"id": "1",
"name":"Two Buttons",
"url":"https://i.imgflip.com/1g8my4.jpg"
}]
Returns an array of memes.
3
data.memes[0]
{
"id": "0",
"name":"Drake Hotline Bling",
"url":"https://i.imgflip.com/30b1gx.jpg"
}
Retourne le premier meme
4
data.memes[0].name
"Drake Hotline Bling"
Returns the name property of the first meme.
5
data.memes[id=1].url
"https://i.imgflip.com/1g8my4.jpg"
Returns the URL of the meme whose id property is 1.
There are no rows in this table
⁠

Creation Request

The Post Request action allows the REST service to create a data or data structure.
Parameter
Comment
Optionnal
1
Variable
The name of the variable where the result of the request will be stored.
2
Additional path
Additional path to be added to the URL of the REST service (endpoint of the configuration).
3
Request parameters
Additional parameters that depend on the called REST service to refine the data search. Example: sort=ASC
4
Request data
The structured JSON data to be submitted. The format of this data is specific to the REST service.
5
Response expression
An expression that indicates the path to the data in the returned JSON message. The response often contains a reference to the created data. Some REST services do not return any data in response.
There are no rows in this table
⁠

Update Request

The Put Request action allows the REST service to update a data or data structure.
Parameter
Comment
Optionnal
1
Additional path
Additional path to be added to the URL of the REST service (endpoint of the configuration).
2
Request parameters
Additional parameters that depend on the called REST service to refine the data search. Example: sort=ASC
3
Request data
The structured JSON data to be submitted. The format of this data is specific to the REST service.
There are no rows in this table
⁠

Delete Request

The Delete Request action allows the REST service to delete a data or data structure.
Parameter
Comment
Optionnal
1
Additional path
Additional path to be added to the URL of the REST service (endpoint of the configuration).
2
Request parameters
Additional parameters that depend on the called REST service to refine the data search. Example: sort=ASC
There are no rows in this table
⁠

Partial Update Request

The Patch Request action allows the REST service to update a single property of a data. It is not necessary to provide all the properties of that data.
Parameter
Comment
Optionnal
1
Additional path
Additional path to be added to the URL of the REST service (endpoint of the configuration).
2
Request parameters
Additional parameters that depend on the called REST service to refine the data search. Example: sort=ASC
3
Request data
The partial structured JSON data to be submitted. The format of this data is specific to the REST service.
There are no rows in this table
⁠

Display a REST Data

Simple Data

The data stored by the REST action can be simple, especially through the use of a response expression. For example: 'Paris', 'True', or 123.
In this case, the component on the screen can refer to this data directly.
⁠
image.png
LabelText displays the name of a meme
⁠
⁠

Structured Data

The data stored by the REST action can be structured and can contain properties, for example, a meme with all its properties: id, name, and url.
In this case, a formula that uses the JSON Query function allows you to select the properties to display.
Below, the LabelText component calls a formula that uses the JSON Query function. This function defines two properties:
Properties
Comment
1
JSON object
The structured data stored by the action.
2
Expression
An expression that indicates the path to the data in the returned JSON message.
There are no rows in this table
⁠
⁠
image.png
⁠
⁠
Here is the screen in operation in the simulator.
⁠
image.png
⁠
⁠
info
Once the REST request is executed, the JSON Query function can be used as many times as needed without generating additional REST requests.

Want to print your doc?
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.