Accueil › Python › Appeler une API HTTP sans se faire piéger
Appeler une API HTTP sans se faire piéger
Données, JSON et APIavance
Appeler une API, c'est trois gestes : construire la requête, lire le code d'état, puis seulement décoder le corps.
import json
from urllib.error import HTTPError, URLError
from urllib.request import Request, urlopen
requete = Request(
"https://api.boutique.test/commandes/42",
headers={"Accept": "application/json", "User-Agent": "boutique/1.0"},
)
try:
with urlopen(requete, timeout=5) as reponse: # timeout : jamais optionnel
commande = json.loads(reponse.read().decode("utf-8"))
except HTTPError as e: # 4xx / 5xx : le serveur a répondu
print("erreur HTTP", e.code, e.read().decode("utf-8", "replace"))
except TimeoutError: # le serveur n'a pas répondu à temps
print("trop lent")
except URLError as e: # pas de réponse du tout
print("réseau indisponible :", e.reason)
Trois choses à retenir de ce bloc :
timeoutn'a pas de valeur par défaut. Sans lui, un serveur muet bloque votre programme pour toujours.urlopenlève une exception sur4xxet5xx. Il n'y a pas deif reponse.status == 200à écrire : le code d'erreur arrive parHTTPError.- La réponse est en octets.
reponse.read()rend desbytesqu'il faut décoder.
Le code de cette leçon s'exécute dans votre navigateur. Les appels réseau y sont restreints : lisez ces exemples comme la forme à écrire dans un vrai programme, pas comme des appels à lancer ici.
Les termes à connaître
- Code d'état (status code)
Nombre à trois chiffres renvoyé par le serveur. Le premier chiffre porte le sens :
2xxréussi,3xxredirigé,4xxvotre requête est fautive,5xxle serveur est fautif. C'est la première chose à lire, avant le corps de la réponse.- Délai d'attente (timeout)
Durée maximale qu'on accepte d'attendre. Sans délai, un appel HTTP peut bloquer indéfiniment : si le serveur accepte la connexion puis ne répond plus, votre programme attend sans fin.
urlopen(..., timeout=5)lèveTimeoutErrorau bout de cinq secondes.- urllib.request.urlopen
La fonction HTTP de la bibliothèque standard : disponible partout, sans installation. Elle prend une URL ou un objet
Request, acceptetimeout, et renvoie une réponse qu'on lit en octets. Dans un vrai projet on lui préfère souventrequestsouhttpx, qui demandent une installation.- HTTPError
Exception levée par
urlopenpour un code4xxou5xx. Elle est aussi une réponse :e.codedonne le statut,e.read()le corps d'erreur,e.headersles en-têtes. Elle hérite deURLError, donc l'ordre desexceptcompte.- URLError
Exception levée quand la requête n'a pas pu aboutir du tout : nom de domaine introuvable, connexion refusée, câble débranché. Son attribut
reasonporte la cause. Rien n'indique si le serveur a traité ou non la demande.- Idempotence
Une requête est idempotente si la rejouer ne change rien de plus.
GET,PUTetDELETEle sont par convention,POSTne l'est pas. C'est ce qui décide si une nouvelle tentative après un délai dépassé est sûre ou non.- 429 et Retour-après (Retry-After)
429 Too Many Requestssignifie que vous appelez trop vite. L'en-têteRetry-Afterindique en secondes le temps à attendre. Le respecter est la différence entre un client correct et un client banni.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.