HTTP

Le composant HTTP permet de connecter votre app à d'autres apps ou services en utilisant des APIs. Vous pouvez par exemple vous connecter à Airtable pour afficher une collection externe (liste d'enregistrement), à Mailchimp pour envoyer un email ou à OpenWeatherMap pour afficher la météo du jour dans votre application.

Une API permet de rendre disponibles les données ou les fonctionnalités d’une application existante afin que d’autres applications les utilisent. Grâce aux APIs, il est possible de faire appel à des fonctionnalités déjà existantes au sein de votre application PandaSuite.

Chaque API possède son propre mode de fonctionnement. La connexion à une API se fait à l'aide du composant HTTP.

Préparer la connexion avec l'API

Obtenir l'URL de l'API

Insérez le composant HTTP dans votre projet, à l'endroit où il sera utilisé. Si les requêtes à l'API sont utilisées tout au long de l'application ou si elle contrôle le comportement de votre application, nous vous recommandons de mettre ce composant en Avant-plan

Ouvrez la fenêtre Propriétés du composant.

Vous avez besoin de l'URL de référence de l'API. Celle-ci se trouve dans la documentation technique du service que vous choisissez.

Voici par exemple l'URL de l'API d'OpenWeatherMap :

https://api.openweathermap.org/data/2.5/weather?q={city name}&appid={API key}

Dans le champ URL, copiez-collez tout ce qui se situe depuis le "https:" jusqu'au "?" sans inclure le "?". Le reste des informations correspond à des Query String qui seront spécifiés plus bas.

Définir les paramètres de l'API

L'API vous fournit également des paramètres pour personnaliser la requête.

Personnalisez les appels à l'API en utilisant les propriétés Headers et Query String.

Dans certains cas, il vous est demandé un Nom d'utilisateur et un Mot de passe pour utiliser l'API.

Personnaliser la gestion du cache

La mise en cache vous permet de réutiliser efficacement des données de l'API précédemment récupérées ou traitées. Ainsi les demandes futures sont traitées plus rapidement en accédant à l'emplacement de stockage principal des données et sans faire appel au réseau.

En fonction de votre utilisation des données de l'API, choisissez le comportement de votre application par rapport au cache :

  • Aucun cache : l'application fera un appel réseau et ne lira pas le cache
  • Cache en premier : l'application recherche le résultat dans le cache avant de faire une requête au réseau.
  • Réseau et cache : l'application retournera le contenu du cache mais fera tout de même la requête afin de le mettre à jour. Cette option permet d’avoir une réponse rapide.

L'option Cache persistant permet de conserver le cache même après la fermeture de l'application.

Paramétrer les actions

Le composant HTTP permet d'envoyer ou de recevoir de la donnée grâce à différentes méthodes disponibles. Tout dépend de ce que vous voulez faire de la donnée :

  • GET = requêter de la donnée depuis une ressource spécifique. C'est une des méthodes les plus courantes.
  • POST = créer une ressource.
  • DELETE = supprimer une ressource.
  • PUT or PATCH = mettre à jour une ressource.
  • HEAD

Choisir le contenu

 Cette option n'est requise que si vous choisissez la méthode POST, PUT, PATCH etc... Choisissez le type de contenu qui sera l'objet de votre requête :

  • Text
  • JSON
  • XML
  • HTML

Tester la connexion

Afficher les résultats de la requête

Cliquez sur le bouton Editer du composant HTTP (ou double-cliquez sur le champ visible du composant HTTP).

Des informations apparaissent.

Cliquez sur le bouton  Test Request.

Visualisez les résultats de votre requête : si les données brutes correspondent à votre souhait, l'API a été correctement configurée.

Choisir la pagination

Si votre requête fait appel à une base de données, vous obtiendrez un grand nombre de résultats. À vous de définir comment ils vont apparaître dans votre application. La pagination est le processus qui permet de séparer des données en sous-ensembles. Comme les pages d'un livre.

Il existe plusieurs types de pagination dans les API : 

  • La pagination Offset : cette pagination est souvent associée à une interface qui utilise des pages explicites que l'on fait basculer, comme on feuillette les pages d'un livre.
  • La pagination Cursor : cette méthode permet d'offrir un défilement infini (comme le fil d'actualités Facebook par exemple).

Dans PandaSuite, vous pouvez utiliser la pagination Offset, en ajoutant deux paramètres supplémentaires dans la requête : un offset et une limite

Lancer la requête

Il vous faut désormais lancer la requête à l'API, par exemple automatiquement à l'affichage de l'écran.

Dans ce cas, sélectionnez l'écran et cliquez sur  Actions.

Sélectionnez   Affichage courant > Agir sur composant > Composant HTTP > Lancer la requête

Récupérer l'identifiant

L’identifiant est indispensable pour connecter votre composant et donc votre API à un autre composant de PandaSuite, par exemple une collection

Pour récupérer l’identifiant, double-cliquez sur le nom. Collez dans un champ de texte et récupérez l'identifiant. 

Par exemple : 

HTTP -> 5f903e615ccbd73fda000453

5f903e615ccbd73fda000453 est l'identifiant de ce composant.

Vous avez encore besoin d'aide ? Contactez-nous Contactez-nous