Que signifie l'API? Une définition de l'acronyme de codage en anglais simple.

Non, l'API ne signifie pas Apple Pie Inside. ?? API signifie Application Programming Interface. Les API permettent à deux applications de s'interfacer (ou d'interagir) l'une avec l'autre.

Une API un ensemble d'instructions de programmation et de fonctions utilisées pour accéder à un site Web ou à une application logicielle Web. Une API permet à d'autres développeurs d'utiliser les données et les fonctionnalités de votre application. Il permet à votre produit d'interagir avec d'autres produits.

Les API ont été utilisées pour la première fois dans le développement de logiciels et de matériel dans les années 1980. Mais maintenant, lorsque les gens parlent d'API, ils font généralement référence aux API Web, ou plus spécifiquement aux API RESTful. Il est devenu pratique courante d'utiliser des API RESTful lors du développement d'applications Web.

Une API Web est essentiellement un programme avec lequel vous interagissez complètement via des URL. Normalement, lorsque vous envoyez une demande à une URL avec votre navigateur, un serveur renvoie une réponse qui s'affiche pour que vous puissiez la consulter. Les choses sont différentes lorsque vous envoyez une requête à une URL d'une API. Le serveur renvoie quelque chose qui est censé être utile uniquement à l'ordinateur. Une API renvoie des données qui peuvent être utilisées dans un autre site Web ou programme.

À quoi servent les API?

Les API ne sont pas destinées à être utilisées par un utilisateur final. Ils sont utilisés pour que les logiciels interagissent avec d'autres logiciels. Par exemple, un site Web peut appeler l'Open Weather API pour obtenir des informations météorologiques à afficher sur le site Web.

Les API sont également parfois utilisées en interne au sein d'une même entreprise. Ils peuvent être utilisés pour créer des sites Web et des systèmes internes qui interagissent facilement les uns avec les autres.

Comment fonctionne une API?

Une API donne généralement aux autres accès à une grande quantité de données organisées. Le gardien de ces données autorise un développeur (sous la forme d'une clé API ) à demander des informations à un serveur. Si la demande aboutit, le serveur répond par un message, généralement au format JSON ou XML.

Habituellement, il y aura de la documentation pour une API que vous souhaitez utiliser, appelée spécification d'API. Cela explique les contrôles et comment utiliser l'API.

Voici un exemple de la spécification API pour l'API OpenWeather qui vous permet d'obtenir la météo actuelle à un emplacement spécifique: //openweathermap.org/current

Les spécifications de l'API contiennent une liste d'URL que vous pouvez utiliser pour récupérer des données. L'utilisation de l'une des URL s'appelle une demande d' API ou un appel d'API . Souvent, la spécification affiche les paramètres et la réponse pour chaque URL faisant partie de l'API.

Paramètres

Les paramètres sont ce que vous ajoutez à la fin d'une URL pour spécifier les informations que vous souhaitez que l'API renvoie. Les paramètres sont essentiellement des variables que vous transmettez à l'API.

L'URL pour obtenir des informations météorologiques à partir de l'API OpenWeather est:

api.openweathermap.org/data/2.5/weather.

Cependant, vous devez ajouter une ville en tant que paramètre pour spécifier l'emplacement pour lequel renvoyer les données météorologiques. Voici l'URL avec le paramètre city:

api.openweathermap.org/data/2.5/weather?q=London

Parfois, des paramètres sont nécessaires pour obtenir une réponse. Parfois, les paramètres sont facultatifs. Dans l'API OpenWeather, il est nécessaire de fournir un emplacement, mais il existe d'autres moyens de spécifier l'emplacement en plus du nom de la ville. Tous les moyens sont indiqués dans la spécification de l'API.

Les paramètres peuvent également spécifier des choses comme:

  • Comment les résultats doivent-ils être triés?
  • Combien de résultats faut-il renvoyer?
  • Dans quel format les résultats doivent-ils être?
  • Pour quelle plage de dates souhaitez-vous obtenir des résultats?

La réponse

Lorsque vous envoyez une requête à une API, vous obtiendrez une réponse. Vous récupérerez soit les données que vous avez demandées, soit une raison pour laquelle la demande a échoué.

Ci - dessous un exemple de la réponse que vous obtenez lorsque vous envoyez la demande suivante: api.openweathermap.org/data/2.5/weather?q=London. C'est une réponse JSON.

{ "coord": { "lon": -0.13, "lat": 51.51 }, "weather": [ { "id": 300, "main": "Drizzle", "description": "light intensity drizzle", "icon": "09d" } ], "base": "stations", "main": { "temp": 280.32, "pressure": 1012, "humidity": 81, "temp_min": 279.15, "temp_max": 281.15 }, "visibility": 10000, "wind": { "speed": 4.1, "deg": 80 }, "clouds": { "all": 90 }, "dt": 1485789600, "sys": { "type": 1, "id": 5091, "message": 0.0103, "country": "GB", "sunrise": 1485762037, "sunset": 1485794875 }, "id": 2643743, "name": "London", "cod": 200 }

Une réponse API peut ne pas être formatée comme cet exemple. Tout le texte est souvent sur une seule ligne. Puisqu'il est principalement destiné à être lu par un ordinateur et non par une personne, le formatage n'a pas d'importance.

Clés API

Si vous essayez vous-même l'URL ci-dessus, vous n'obtiendrez pas la réponse ci-dessus. Cela ressemblera probablement plus à:

{ "cod": 401, "message": "Invalid API key. Please see //openweathermap.org/faq#error401 for more info." }

La plupart des API nécessitent une sorte d'authentification avant de renvoyer des données. Cela se présente généralement sous la forme d'une clé API . Ces clés sont un peu comme un mot de passe. Il s'agit d'une longue chaîne de lettres et de chiffres que vous devez envoyer avec votre demande d'API afin que le serveur sache que vous êtes autorisé à accéder aux informations.

Pour l'API OpenWeather, et avec de nombreuses autres API, vous pouvez obtenir une clé API gratuitement après avoir créé un compte. De nombreuses entreprises utilisent des clés API sur des API gratuites pour s'assurer que les gens ne font pas de nombreuses demandes en une journée. Cela pourrait vraiment enliser un serveur si une seule personne faisait des milliers de demandes chaque minute.

Certaines API sont publiques sans clé API. Vous trouverez ci-dessous une API qui vous permet de trouver des mots qui riment. Cliquez sur le lien, puis essayez de changer le dernier mot dans l'URL pour rechercher différents mots qui riment.

//api.datamuse.com/words?rel_rhy=camp

Envie d'en savoir plus?

Si vous souhaitez en savoir plus sur l'utilisation des API, regardez la vidéo ci-dessous sur la chaîne YouTube freeCodeCamp.org.