Demander une première API dans Raccourcis sur Mac
Pour effectuer votre première demande API, vous créez l’URL qui pointe vers le « point final » de l’API avec laquelle vous souhaitez communiquer, puis vous transmettez cette URL à l’action Obtenir le contenu de l’URL. À l’exécution du raccourci, cette action effectue la demande API.
Construire la demande API
Le point final Typicode requiert que les demandes URL soient formatées de la façon suivante :
https://jsonplaceholder.typicode.com/[RESOURCE]
Le texte entre crochets est la ressource à laquelle vous souhaitez accéder. Typicode fournit de nombreux exemples pour tester les demandes. Dans cet exemple, nous utilisons https://jsonplaceholder.typicode.com/users pour demander une liste d’utilisateurs.
Dans l’app Raccourcis
sur votre Mac, ajoutez la requête à l’URL.La demande
usersretournera une liste d’utilisateurs.Vous pouvez affiner votre recherche en précisant un utilisateur en particulier à l’aide de l’identifiant :
https://jsonplaceholder.typicode.com/users/6. L’utilisateur dont l’identifiant est 6 sera trouvé.La plupart des API autorisent les requêtes sous le format suivant :
https://jsonplaceholder.typicode.com/users?username=Bret. Le « ? » lance 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.
Réaliser la demande API avec l’action Obtenir le contenu de l’URL
Dans l’app Raccourcis
sur votre Mac, cliquez sur « Afficher plus » dans l’action « Obtenir le contenu de l’URL ».Les options suivantes pour les types de demandes API pouvant être effectuées sont 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.DELETEvous permet de supprimer un objet mentionné dans la demande d’URL.
Pour cet exemple, utilisez une demande
GETpour récupérer les données à partir de l’API Typicode.Maintenant que l’action URL comprend votre demande et que l’action Obtenir le contenu de l’URL est réglée sur
GET, vous êtes prêt à effectuer la demande API.Remarque : Lorsque l’action Obtenir le contenu de l’URL passe à
POST,PUTouPATCH, un nouveau paramètre appelé Demander le corps est ajouté. Demander le corps vous permet d’envoyer à l’API du contenu JSON, un formulaire ou un fichier comme faisant partie de votre demande. Cela vous permet de saisir de nouvelles données manuellement ou en utilisant des variables afin d’envoyer les données à l’API à des fins de création, de remplacement ou de modification d’une entrée.Pour tester le raccourci, cliquez sur
.
À première vue, l’API semble renvoyer du texte désordonné. Les données sont encodées en JSON, ce qui signifie JavaScript Object Notation.
Pour en savoir plus sur l’utilisation de JSON et pour poursuivre l’exemple d’API Typicode, consultez Introduction à l’utilisation de JSON dans Raccourcis sur Mac.