Demander une première API dans Raccourcis sur l’iPhone ou l’iPad
Pour demander votre première API, vous créez l’URL qui pointe vers le « point de terminaison » de l’API qui vous intéresse, puis vous transmettez cette URL à l’action Obtenir le contenu de l’URL. Lorsque le raccourci est exécuté, cette action effectue la requête API.
Effectuer la requête API
Le point de terminaison de Typicode nécessite que la demande d’URL soit formatée comme suit :
https://jsonplaceholder.typicode.com/[RESSOURCE]
Le texte entre crochets est la ressource à laquelle vous souhaitez accéder. Typicode fournit de nombreux exemples différents pour tester les requêtes. Cet exemple utilisera https://jsonplaceholder.typicode.com/users pour demander une liste d’utilisateurs.
Dans l’app Raccourcis
sur votre iPhone ou iPad, ajoutez la requête à l’URL.La requête
usersrenverra une liste d’utilisateurs.Vous pouvez affiner votre recherche en précisant l’identifiant d’un utilisateur particulier :
https://jsonplaceholder.typicode.com/users/6. Cela renverra l’utilisateur dont l’identifiant est 6.La plupart des API autorisent les requêtes utilisant le format suivant :
https://jsonplaceholder.typicode.com/users?username=Bret. Le « ? » commence la requête, qui recherche des éléments à l’aide de paires clé/valeur. Dans cet exemple, la requête?username=Bretrecherche un utilisateur dont le nom d’utilisateur est Bret.Consultez la documentation de votre API pour connaître les recherches et les requêtes prises en charge.
Exécuter la requête API avec l’action Obtenir le contenu de l’URL
Dans l’app Raccourcis
sur votre iPhone ou iPad, touchez « En afficher plus » dans l’action « Obtenir le contenu de l’URL ».Les options suivantes, pour les types de requêtes API que vous pouvez effectuer, deviennent disponibles :
GETvous permet de récupérer des données.POSTvous permet de créer de nouvelles données.PUTvous permet de mettre à jour des données en les remplaçant.PATCHvous permet de mettre à jour des données en les modifiant.SUPPRIMERvous permet de supprimer un objet spécifié dans la requête URL.
Pour cet exemple, utilisez une requête
GETpour récupérer les données de l’API Typicode.Une fois que l’action URL a reçu votre requête et que l’action Obtenir le contenu de l’URL est définie sur données
GET, vous pouvez effectuer la requête API.Remarque : lorsque l’action Obtenir le contenu de l’URL est configurée sur
POST,PUTouPATCH, un nouveau paramètre du nom de Demander le corps est ajouté. Demander le corps vous permet d’envoyer des données JSON, un formulaire ou un fichier à l’API dans le cadre de votre requête. Ceci vous permet de saisir de nouvelles données manuellement ou en utilisant des variables afin d’envoyer les données à l’API pour créer, remplacer ou modifier une entrée.Pour tester le raccourci, touchez
.
En premier lieu, l’API semble afficher un texte qui n’a aucun sens. Ces données sont codées au format JSON, qui est une abréviation de JavaScript Object Notation, le nom d’un format de données textuelles dérivé de la notation des objets du langage JavaScript.
Pour en savoir plus sur l’utilisation du format JSON et pour continuer avec l’exemple de l’API Typicode, consultez la rubrique Introduction à l’utilisation de JSON dans Raccourcis sur l’iPhone et l’iPad.