Utiliser des API rest avec python

Qu’est-ce qu’une API REST (du point de vue de Python)

Types de demandes

Les types de requêtes ou les méthodes de requête HTTP caractérisent l’action que nous allons entreprendre en nous référant à l’API.

Au total, il existe quatre grands types d’actions :

• GET : récupération d’informations (comme les résultats de recherche). C’est le type de requête le plus courant. Grâce à elle, nous pouvons obtenir les données qui nous intéressent auprès de celles que l’API est prête à partager.
• POST : ajoute de nouvelles données au serveur. Ce type de requête permet, par exemple, d’ajouter un nouvel élément à votre inventaire.
• PUT : modifie les informations existantes. Par exemple, en utilisant ce type de requête, il serait possible de changer la couleur ou la valeur d’un produit existant.
• DELETE : supprime les informations existantes

import requests
response = requests.get('https://google.com/')
print(response)
>> <Response [200]>

Codes de statut

Les codes de statut sont renvoyés avec une réponse après chaque appel au serveur. Ils décrivent brièvement le résultat de l’appel. Il existe un grand nombre de codes de statut, nous vous donnons ceux que vous rencontrerez le plus souvent :

• 200 - OK. La demande a abouti. La réponse elle-même dépend de la méthode utilisée (GET, POST, etc.) et de la spécification de l’API.
• 204 - Pas de contenu. Le serveur a traité la demande avec succès et n’a renvoyé aucun contenu.
• 301 - Déplacé de façon permanente. Le serveur répond que la page demandée (endpoint) a été déplacée vers une autre adresse et redirige vers cette adresse.
• 400 - Mauvaise requête. Le serveur ne peut pas traiter la demande en raison d’erreurs côté client (format de demande incorrect).
• 401 - Non autorisé. Se produit lorsque l’authentification a échoué, en raison d’informations d’identification incorrectes ou même de leur absence.
• 403 - Interdit. L’accès à la ressource spécifiée est refusé.
• 404 - Non trouvé. La ressource demandée n’a pas été trouvée sur le serveur.
• 500 - Erreur interne du serveur. Se produit lorsqu’une erreur inconnue s’est produite sur le serveur.

La bibliothèque request possède plusieurs propriétés utiles pour travailler avec les codes de statut. Par exemple, vous pouvez simplement visualiser le statut du code de réponse en accédant à .status_code :

print(response.status_code)
>>> 200

Ce n’est pas tout. Vous pouvez utiliser l’instance de réponse dans une expression conditionnelle. Elle évaluera à Vrai si le code de statut était compris entre 200 et 400, et à Faux dans le cas contraire.

if response:
  print('Request is successful.')
else:
  print('Request returned an error.')

Endpoints

Afin de travailler avec les API REST, il est important de comprendre ce qu’est un Endpoint.

Généralement, un point terminal est une adresse spécifique (par exemple, https://weather-in-london.com/forecast), par laquelle vous avez accès à certaines caractéristiques/données (dans notre cas, les prévisions météorologiques pour Londres). Généralement, le nom (adresse) du point final correspond à la fonctionnalité qu’il fournit.

Pour en savoir plus sur les endpoints, nous allons examiner un exemple d’API simple dans le cadre du service RapidAPI. Ce service est un hub API qui permet d’accéder à des milliers d’API différentes. Un autre avantage de RapidAPI est que vous pouvez accéder aux terminaux et tester le travail de l’API directement dans sa section au sein du service RapidAPI.

Exemples sur rapidApi

https://rapidapi.com/blog/how-to-use-an-api-with-python/