Se connecter aux API sans code : 8 étapes

2024 Auteur: John Day | [email protected]. Dernière modifié: 2024-01-30 09:05

Ce guide est conçu pour les personnes qui souhaitent accomplir quelque chose qui nécessite l'utilisation d'une API, mais qui ne savent pas trop par où commencer. Vous savez déjà pourquoi il est utile de pouvoir travailler avec une API, et ce guide vous montrera comment le faire.

Si cela vous ressemble, vous avez de la chance ! Nous sommes ici pour expliquer comment travailler avec les API, comment lire les documents d'API et comment utiliser réellement les données provenant d'une API.

Nous avons amené un ami pour rendre le voyage beaucoup plus facile.

Rencontrez Slash

Slash est le chien adorable et adorable de Michelle (photo ci-dessus). Michelle est un ingénieur logiciel qui crée des API. Michelle aime vraiment son travail et s'est inspirée de son travail de création d'API dans la formation Slash.

Comme vous le savez peut-être, une API est un ensemble de commandes qu'un utilisateur peut donner à un service Web ainsi qu'un ensemble de réponses qui correspondent à la demande. Michelle a entraîné Slash à faire de même. Slash est un bon garçon, connaît une variété de commandes et répond toujours correctement tant que vous lui donnez une demande qui lui a été enseignée. Quand il est très excité, sa queue devient folle - ce n'est pas quelque chose que Michelle lui a appris concernant les API, c'est juste parce que c'est un chiot adorable et qu'il aime vraiment son entraînement !

Étape 1: Décidez de l'API dont vous avez besoin

Quelles informations recherchez-vous ou souhaitez-vous modifier ?

Essayez-vous de récupérer toutes les publications Instagram de @dougthepug ? Peut-être que vous voulez automatiquement tweeter à toute personne qui suit le twitter de votre chien (car même si les chiens ne peuvent pas parler, ils ont beaucoup à dire, nous savons que Slash le fait certainement).

Si vous connaissez déjà le site ou l'API auquel vous essayez de vous connecter, passez directement à l'étape 2. Si vous essayez de trouver des données, mais ne savez pas par où commencer, Google est votre ami. Recherchez "[trucs qui vous intéressent] API" et voyez ce qui se passe. Vous pourriez être surpris de la quantité d'informations disponibles.

Si vous souhaitez un exemple d'API simple, vous pouvez utiliser celui que Michelle a créé lors de l'entraînement de Slash. Il a certaines de ses commandes préférées comme récupérer des balles et creuser des trous. Nous l'utiliserons dans le reste de nos exemples.

Étape 2: Trouvez les documents de l'API

Les API fournies par des entreprises bien connues doivent disposer d'une documentation complète sur la façon de les utiliser.

Pour les trouver, google "[Insert Company] API documentation" ou "[Insert Company] developer".

Les résultats devraient vous amener au portail des développeurs. Recherchez un lien indiquant « Docs », « Documentation », « Référence » ou « Référence technique ».

Dans les documents, vous devrez peut-être rechercher l'API spécifique que vous souhaitez, car il peut parfois y avoir de nombreuses options. Facebook, par exemple, dispose d'API distinctes pour le marketing, les publicités, les pages, etc.

Si l'API à laquelle vous souhaitez vous connecter n'est pas bien connue (comme celle de Slash), vous devrez peut-être demander de la documentation au développeur. Ils peuvent avoir un PDF contenant les informations dont vous avez besoin ou une documentation en ligne qui ne figure pas sur leur site Web.

Si vous avez manqué le lien à l'étape précédente, la documentation de l'API de Slash est disponible ici.

Étape 3: Trouver le point de terminaison

Les documents d'API peuvent sembler intimidants, mais une fois que vous savez quoi rechercher, ils sont généralement bien structurés et assez standardisés.

La première chose à rechercher est le(s) point(s) final(s) approprié(s). Il devrait y avoir un point de terminaison correspondant à chaque type de données que vous souhaitez. Un point de terminaison pourrait ressembler à ceci:

slashtheapidog.com/api/bones/{id}

ou juste

/OS

La documentation doit avoir une liste de points de terminaison. Ils peuvent être de niveau supérieur dans la documentation ou dans une section appelée "référence", "points finaux" ou "méthodes". Pour trouver le bon point de terminaison, recherchez le nom qui correspond aux données que vous recherchez. Par exemple, si vous voulez une liste de tous les trous que Slash a creusés, /holes est probablement le bon. Dans tous les cas, chaque point de terminaison doit avoir une description pour aider à expliquer ce qu'il fait.

D'après ses documents, voici les points de terminaison de l'API de Slash liés aux trous:

OBTENIR

OBTENIR

POST

METTRE

POST

Étape 4: Déterminez votre type de demande

Maintenant que vous avez trouvé le bon point de terminaison, vous devez déterminer le type de demande pour l'envoyer.

Il existe 4 types de demandes différentes:

AVOIR

Une requête GET est la façon dont vous demandez à l'API de répondre avec quelque chose dont elle dispose, le plus souvent des données. Vous pouvez demander des informations spécifiques sur un élément ou un groupe d'éléments en fonction du point de terminaison et des paramètres. C'est l'équivalent de demander à Slash de vous apporter un de ses os ou tous ses os.

PUBLIER

Une requête POST est la façon dont vous dites à l'API de créer quelque chose de nouveau. Cela revient à demander à Slash de creuser (créer) un nouveau trou pour vous.

METTRE

Une requête PUT est la façon dont vous dites à l'API de mettre à jour quelque chose qui a été précédemment créé. Cela revient à demander à Slash de creuser plus profondément (mettre à jour) dans le trou qu'il a creusé.

EFFACER

Une demande DELETE est la façon dont vous dites à l'API de supprimer quelque chose qui a été précédemment créé. Cela revient à demander à Slash de couvrir (supprimer) un trou qu'il a précédemment creusé.

Pensez à ces quatre types. Obtenez-vous des informations, créez-vous une nouvelle entrée, modifiez-vous une entrée existante ou en supprimez-vous une ? Cette réponse vous indique exactement de quel type de demande vous avez besoin.

Étape 5: comprendre les paramètres

De nombreuses requêtes nécessitent des paramètres supplémentaires. Les paramètres sont les détails de votre demande. Par exemple, si vous voulez que Slash vous apporte toutes les boules qui sont rouges, vous devez spécifier la couleur. Si vous voulez qu'il crée un nouveau trou, vous devez lui dire où le mettre et à quelle profondeur creuser.

La documentation de l'API que vous référencez doit comporter une section intitulée « Paramètres » ou « Options » pour chaque point de terminaison et type de demande. Faites attention aux paramètres requis car certains sont facultatifs. Si un paramètre est marqué comme facultatif, la documentation peut fournir un exemple qui est également la valeur par défaut.

Les paramètres de l'API de Slash peuvent ressembler à ceci pour récupérer les balles:

OBTENIR

Étape 6: Formatez votre demande

Nous avons toutes les informations dont nous avons besoin, il ne nous reste plus qu'à faire la demande !

Voici deux façons différentes de se connecter à une API qui ne nécessitent aucun code. Connectons-nous à l'API de Slash pour obtenir sa liste de balles en faisant une requête GET à

Parabola - si vous souhaitez vous connecter et travailler avec des données sans code

Parabola est une application Web qui vous permet de vous connecter facilement aux API, puis de travailler avec les données via un outil visuel de glisser-déposer.