Une API, en français, interface de programmation d'application, représente une solution informatique qui permet à des applications d'échanger des informations et des données entre elles. Elles communiquent avec des langages précis qui leur permettent de lancer des requêtes et de recevoir des réponses. Elles possèdent donc des canaux de communication, dont les extrémités sont appelées endpoints API ou en français, points de terminaison API. Ces derniers constituent les emplacements numériques à partir desquels les API demandent et reçoivent des données et comportent l'URL du serveur auquel ils s'adressent. En d'autres termes, les endpoints API assurent les transferts d'informations nécessaires au bon fonctionnement des logiciels et applications sur internet.

 

Téléchargez ce guide et découvrez les bases des langages HTML et CSS 

 

 

2 Exemples d'endpoint API

 

L'endpoint API de Spotify

Sur l'API de Spotify, les développeurs ont accès aux chansons, artistes, playlists ainsi qu'aux données de chaque utilisateur. Accéder à un album précis, par exemple, nécessite d'aller le chercher dans le catalogue, ce qui implique d'utiliser l'endpoint suivant : https://api.spotify.com/v1/albums/{id}. Dans cette URL, la particule « -id » renvoie à l'identifiant unique de l'album recherché.

Il s'avère également possible de faire en sorte qu'un utilisateur suive une playlist donnée. Dans ce cas, il faut envoyer une requête PUT à partir d'un autre point de terminaison API : https://api.spotify.com/v1/playlists/{playlist_id}/followers. Là encore, la mention « -id » correspond à l'identifiant unique de la playlist sélectionnée.

 

L'endpoint API de YouTube

L'API de YouTube permet notamment d'embarquer un contenu du site sur un autre. En d'autres termes, copier le code d'une vidéo YouTube sur un autre site revient à envoyer une requête à l'API de YouTube. Une autre manière d'obtenir des vidéos de la plateforme consiste à utiliser une requête à partir de cet endpoint : https://www.googleapis.com/youtube/v3/videos. Dans ce contexte, le point de terminaison API renvoie une liste de vidéos correspondant aux critères indiqués dans la requête initiale.

 

Pourquoi les endpoints API sont-ils importants ?

Chaque jour, de plus en plus d'échanges d'informations, de processus et de transactions se déroulent en ligne par le biais de différentes applications. Les API permettent d'assurer la communication entre l'humain et la machine : elles se composent d'interfaces de programmation et d'architectures précises pour faire communiquer toutes les structures nécessaires entre elles. Il en existe de nombreuses versions, comme l'API de Hubspot. Parmi les exemples d'architectures de base, on trouve notamment les API rest. Ainsi, l'utilisateur envoie une demande au système, aussi appelée requête, informatiquement traduite en call API. À ce stade, le programme « appelle » le serveur qui détient la réponse à la demande de l'utilisateur pour lui demander d'effectuer une certaine opération. Les endpoints API, quant à eux, constituent le point d'émission de cet appel et garantissent le transfert de données nécessaires au bon déroulement de ces opérations. Ces échanges constituent la base du fonctionnement de nombreuses API, c'est pourquoi les points de contact que représentent les endpoints doivent absolument s'avérer intacts. Ces derniers servent à localiser l'emplacement des ressources dans une API et aident les développeurs à mettre en place leur organisation. Les endpoints permettent, de fait, d'aller chercher les données nécessaires et de les réceptionner : sans cette étape, les multiples API sur internet ne peuvent plus fonctionner. Le succès de ces dernières dépend donc de leur capacité à communiquer de façon efficace avec les points de terminaisons.

Comment gérer son site web grâce aux langages HTML et CSS ?

Téléchargez ce guide gratuit et découvrez les définitions, les différences et les éléments de code de base de ces deux langages de programmation pour gérer votre site web.

 

Comment créer un endpoint ?

Un endpoint API comporte une requête spécifique mais aussi l'URL du serveur auquel il s'adresse. Le nommage revêt donc une grande importance et doit intégrer à la fois la ressource concernée ainsi que la nature de l'action à effectuer.

Le processus d'échange commence par une connexion à l'API, ce qui nécessite d'envoyer une requête. Celle-ci doit posséder un pointeur de ressource universel, l'URL, la méthode HTTP et, en fonction de cette dernière, ajouter des corps, en-têtes et paramètres de requêtes. Pour assurer la sécurité des données, il se révèle d'ailleurs important d'utiliser un protocole comme le HTTPS, qui protège les informations échangées. Quant aux requêtes, il en existe 5 types principaux pour indiquer le point de terminaison concerné : GET, POST, PUT, PATCH et DELETE. La première sert à récupérer des informations sur un autre serveur et n'implique pas de corps de requête. La requête POST, de son côté, créé un nouvel élément dans la base de données contactée. PUT permet d'y réinitialiser un objet tandis que PATCH réinitialise un objet mais ne met à jour que les éléments indiqués dans le corps de requête. Enfin, DELETE sert à supprimer des objets.

Une fois la requête définie, il faut concevoir l'URI, Uniform Resource Identifier, qui indique l'emplacement et la manière de trouver la donnée recherchée. L'URI se compose de l'URL du site ainsi que de l'URN, Uniform Resource Name, qui correspond au nom de la ressource en question. Enfin, il convient de préciser, dans la terminaison, la version du logiciel ou du site. Concrètement un exemple d'endpoint API sur la plateforme Twitter ressemble au suivant.

https://api.twitter.com/2/tweets/{id} : cet endpoint mentionne l'URL du site, https://twitter.com, sa version, 2, et le type d'élément recherché, un tweet accompagné de son identifiant unique, id. L'API Twitter permet également de publier des tweets en temps réel depuis un ordinateur à partir d'un endpoint spécifique : https://api.twitter.com/2/tweets/search/stream.

Communauté HubSpot

 

Pour aller plus loin dans votre stratégie , téléchargez Guide d'introduction aux langages HTML et CSS.CTA : Guide d'introduction aux langages HTML et CSS

 

Publication originale le Jan 16, 2023 1:29:00 AM, mise à jour le 21 janvier 2023

Sujet(s):

API