Introduction à la gestion des API

Les API (interfaces de programmation d’applications) permettent aux applications de communiquer entre elles. La bibliothèque Python requests facilite l’interaction avec les API en envoyant des requêtes HTTP et en gérant les réponses.

Dans cette leçon, vous apprendrez à utiliser la bibliothèque requests pour envoyer des requêtes d’API et traiter les réponses.

Installer requests

Pour installer la bibliothèque requests, utilisez la commande suivante dans votre terminal :

pip install requests

Une fois l’installation terminée, vous pouvez l’importer dans vos scripts Python :

# Importing requests
import requests

print("Requests library imported successfully")

Envoyer une requête GET

La méthode GET sert à récupérer des données depuis une API. Utilisez la fonction requests.get() pour envoyer une requête GET :

# Sending a GET request
import requests

response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
print(response.json())  # Outputs the JSON response

Envoyer une requête POST

La méthode POST sert à envoyer des données à une interface de programmation d'applications. Utilisez la fonction requests.post() :

# Sending a POST request
import requests

payload = {"title": "foo", "body": "bar", "userId": 1}
response = requests.post("https://jsonplaceholder.typicode.com/posts", json=payload)
print(response.json())  # Outputs the response

Gérer les réponses

La bibliothèque requests fournit plusieurs attributs pour gérer les réponses, notamment :

• response.status_code : code d’état HTTP.
• response.json() : données de la réponse au format JSON.
• response.text : contenu brut de la réponse.

# Handling responses
response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Failed with status code:", response.status_code)

Ajouter des paramètres de requête

Vous pouvez transmettre des paramètres de requête aux API à l’aide de l’argument params dans une requête GET :

# Adding query parameters
params = {"userId": 1}
response = requests.get("https://jsonplaceholder.typicode.com/posts", params=params)
print(response.json())

Ajouter des en-têtes

Les en-têtes vous permettent d’envoyer des informations supplémentaires, comme des clés d’API ou des types de contenu, avec vos requêtes :

# Adding headers
headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get("https://jsonplaceholder.typicode.com/posts", headers=headers)
print(response.status_code)

Gérer les erreurs

La bibliothèque requests fournit une gestion intégrée des exceptions pour les erreurs liées au réseau :

# Handling errors
try:
    response = requests.get("https://jsonplaceholder.typicode.com/invalid")
    response.raise_for_status()
except requests.exceptions.HTTPError as err:
    print("HTTP error occurred:", err)
except requests.exceptions.RequestException as err:
    print("Request error occurred:", err)

Erreurs courantes avec requests

Voici quelques erreurs à éviter :

• Ne pas gérer les erreurs HTTP avec response.raise_for_status().
• Inscrire en dur des informations sensibles, comme les clés d'API, dans le script.
• Oublier de préciser la méthode HTTP correcte (par exemple, GET, POST).

Qu’avons-nous appris ?

Dans cette leçon, vous avez appris :

• À installer et à importer la bibliothèque requests.
• À envoyer des requêtes GET et POST aux API.
• À gérer les réponses, à ajouter des paramètres de requête et des en-têtes, et à gérer les erreurs.

Excellent travail ! Passons au sujet suivant.