Zyllio Documentation French
Pages
Tutoriels
Intégration REST
Disponible depuis le plan Enterprise
Cette intégration permet d’intégrer une source de données externe à votre application Zyllio. Ce système externe doit exposer une API de type REST qui est aujourd’hui le standard d’échange de données entre systèmes.
Cette intégration permet d’interroger, de créer et mettre à jour des données externes.
Configurations
Il est nécessaire de renseigner les configurations de vos intégrations REST depuis l’onglet Settings puis Integrations
Activez l’intégration REST en cliquant sur Enable
configuration des configurations REST
Zyllio permet de définir autant de configurations REST que nécessaire. Une configuration REST permet de définir les paramètres du service REST (Endpoint URL , Headers, ...)
Par exemple :
Définir une configuration REST
Clichez sur le bouton + pour ajouter une configuration
Les paramètres suivants sont requis
Paramètre
Commentaire
Name
Le nom de votre intégration, doit être unique
Endpoint URL
L’URL de base de la requête REST, elle sera utilisée en tant que préfixe dans les actions
Headers
Les entêtes HTTP nécessaires pour invoquer la requête REST. Par exemple un token d’authentification ou clé d’API peuvent être renseignés
There are no rows in this table
exemple de configuration REST
Déclencher une requête REST
Des actions sont disponibles dans la section REST de l’éditeur d’action. Il existe une action par type de requête: GET, PATCH, PUT, POST, DELETE
Méthode
Objectif
GET
Lire des données
POST
Créer des données
PUT
Mettre à jour des données
DELETE
Supprimer des données
PATCH
Mettre à jour partiellement des données
There are no rows in this table
Requête d’interrogation
L’action Get Request permet d’interroger un source de données externe
exemple de requête GET qui s'appuie sur la configuration Retrieve memes
Les paramètres suivants sont disponibles
Paramètre
Commentaire
Optionnel
Variable
Le nom de la variable où le résultat de la requête sera stocké
Additional path
Chemin additionel à ajouter à l’URL du service REST (endpoint de la configuration)
Request parameters
Paramètres additionnels qui dépendent du service REST appelé afin d’affiner la recherche de données
Exemple : sort=ASC
Response expression
Une expression qui indique le chemin de la donnée dans le message JSON de retour
L’exemple ci-dessus sélectionne le premier meme (meme[0]) présent dans le champ data
There are no rows in this table
Expression de réponse
Une expression de réponse permet de sélectionner les données que l’on souhaite extraire depuis la réponse JSON.
{
"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"
}]
}
}
Une expression de réponse permet de sélectionner uniquement les données dont l’application mobile a besoin.
Exemple
Résultat
Description
success
“true”
Retourne une valeur simple
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"
}]
Retourne un tableau de memes
data.memes[0]
{
"id": "0",
"name":"Drake Hotline Bling",
"url":"https://i.imgflip.com/30b1gx.jpg"
}
Retourne le premier meme
data.memes[0].name
"Drake Hotline Bling"
Retourne la propriété name du premier meme
data.memes[id=1].url
"https://i.imgflip.com/1g8my4.jpg"
Retourne l’URL du meme dont la propriété id vaut 1
There are no rows in this table
Requête de création
L’action Post Request permet au service REST de créer une donnée ou une structure de donnée
Paramètre
Commentaire
Optionnel
Variable
Le nom de la variable où le résultat de la requête sera stocké
Additional path
Chemin additionel à ajouter à l’URL du service REST (endpoint de la configuration)
Request parameters
Paramètres additionnels qui dépendent du service REST appelé afin d’affiner la recherche de données
Exemple : sort=ASC
Request data
La donnée structurée JSON à soumettre. Le format de cette donnée est spécifique au service REST
Response expression
Une expression qui indique le chemin de la donnée dans le message JSON de retour. Le réponse contient souvent une référence vers la donnée créée.
Certains services REST ne renvoient pas de données en retour
There are no rows in this table
Requête de mise à jour
L’action Put Request permet au service REST de mettre à jour une donnée ou une structure de donnée
Paramètre
Commentaire
Optionnel
Additional path
Chemin additionel à ajouter à l’URL du service REST (endpoint de la configuration)
Request parameters
Paramètres additionnels qui dépendent du service REST appelé afin d’affiner la recherche de données
Exemple : sort=ASC
Request data
La donnée structurée JSON à soumettre. Le format de cette donnée est spécifique au service REST
There are no rows in this table
Requête de suppression
L’action Delete Request permet au service REST de supprimer une donnée ou une structure de donnée
Paramètre
Commentaire
Optionnel
Additional path
Chemin additionel à ajouter à l’URL du service REST (endpoint de la configuration)
Request parameters
Paramètres additionnels qui dépendent du service REST appelé afin d’affiner la recherche de données
Exemple : sort=ASC
There are no rows in this table
Requête de mise à jour partielle
L’action Patch Request permet au service REST de mettre un jour une seule propriété d’une donnée. Il n’est donc pas nécessaire de fournir toutes les propriétés de cette donnée
Paramètre
Commentaire
Optionnel
Additional path
Chemin additionel à ajouter à l’URL du service REST (endpoint de la configuration)
Request parameters
Paramètres additionnels qui dépendent du service REST appelé afin d’affiner la recherche de données
Exemple : sort=ASC
Request data
La donnée structurée JSON partielle à soumettre. Le format de cette donnée est spécifique au service REST
There are no rows in this table
Afficher une donnée REST
Donnée simple
La donnée stockée par l’action REST peut être simple notamment grâce à l’usage de l’expression de réponse. Par exemple : ‘Paris’ ou bien ‘True’ ou bien 123
Dans ce cas, le composant dans l’écran peut faire référence à cette donnée directement
LabelText affiche le nom d'un meme
Donnée structurée
La donnée stockée par l’action REST peut être structurée et donc contenir des propriétés, par exemple, un même avec toutes ses propriété : id, name et url
Dans ce cas, une formule qui utilise la fonction JSON Query permet de sélectionner les propriétés à afficher.
Ci-dessous, le composant LabelText fait appel à une formule qui utilise la fonction JSON Query. Cette fonction définit 2 propriétés:
Propriété
Commentaire
JSON object
La donnée structurée stockée par l’action
Expression
Une expression qui indique le chemin de la donnée dans le message JSON de retour.
There are no rows in this table
Voici l’écran en fonctionnement dans le simulateur
Une fois la requête REST exécutée, la fonction JSON Query peut être utilisée autant de fois que nécessaire sans générer de requêtes REST additionnelles
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.