Les points de terminaison d’API se trouvent généralement dans la documentation d’une API. C’est là que les développeurs placent les informations API telles que le type de requêtes qu’une API acceptera et comment les requêtes doivent être formatées. Idéalement, cette documentation comprend également une liste de tous les points de terminaison d’API disponibles et une brève description de leurs fonctionnalités.
Dans un contexte d’ API REST (un style d’architecture logicielle fréquemment utilisé pour les applications Web), le processus ressemble à ceci :
Le processus démarre lorsqu’un client d’API envoie une demande de ressource (appel d’API) au point de terminaison d’API correspondant. Les points de terminaison sont accessibles à l’aide de méthodes de requête HTTP de types POST, GET, PUT, PATCH et DELETE. Ces méthodes indiquent l’action que le client cherche à effectuer sur la ressource spécifiée.
Par exemple, si un client cherche à récupérer une liste des totaux de médailles olympiques pour une année donnée à partir de la base de données hypothétique Olympicfacts.com, une requête GET est envoyée à l’URL du point de terminaison suivante :
https://api.olympicfacts.com/v1/{year}
Cette requête renvoie une liste du total des médailles olympiques par pays. (v1 dans notre point de terminaison hypothétique indique la version de l’API, une pratique courante dans la gestion des versions d’API.) Si le client souhaite obtenir le total pour un pays spécifique pour une année donnée, un identifiant sera ajouté à l’URL de base :
https://api.olympicfacts.com/v1/year/{id}
Dans cet exemple, l’identifiant {id} est utilisé pour indiquer le pays à propos duquel le client souhaite recevoir des informations.
En outre, une demande peut inclure :
- Des en-têtes : les en-têtes peuvent fournir des informations supplémentaires sur la requête, comme un en-tête Accepter qui spécifie les types de médias acceptés
- Des paramètres : des paramètres de requête peuvent être ajoutés à l’URL de base ou dans le corps de la requête afin de filtrer davantage les critères de recherche ou d’ajouter d’autres caractéristiques.
- Corps de la requête : un corps de requête comprend les données nécessaires à la création ou à la modification d’une ressource. Par exemple, si la demande vise à créer un nouveau blog (demande POST), le contenu du nouveau blog sera inclus dans le corps de la requête.
Une fois que le serveur authentifie la requête et valide l’entrée, il récupère les données demandées et renvoie la réponse au client. De nombreuses organisations utilisent des passerelles d’API pour exécuter ces fonctions et gérer le flux de trafic des API.