Quelles sont les bonnes pratiques pour un usage "raisonnable" des API ?

màj le Feb 7, 2025

Afin d'en faire une bonne utilisation et ne pas dégrader la qualité de service pour l'ensemble des usagers, des recommandations dans la façon d'utiliser les API sont souhaitables.

Exemples de mauvais usages entraînant une baisse de qualité de service global, préjudiciable donc pour tous les usagers de la plateforme, et conséquences induites :

1. saturation de la bande passante globale (possibilité de bannissement de l’adresse IP par nos administrateurs => plus de téléchargement possible),

2. sollicitation excessive de l'infrastructure par excès de la limite globale de requêtes en simultané (coupures de connexions par nos serveurs => erreurs lors des téléchargements),

3. sollicitation inappropriée d'une API par dépassement de quota sur une API (désactivation momentanée de l’autorisation d’accès => code HTTP 429),

4. sollicitation inadéquate d'une ressource par absence de donnée alors qu'un catalogue dynamique est disponible (pas d’accès à la donnée => code HTTP 404),

5. sollicitation redondante d’une ressource par requêtage multiple de la même ressource déjà téléchargée (cf saturation de la bande passante)

Guide détaillé

En fonction des cas de mauvais usage recensés ci-dessus, voici les recommandations que nous pouvons donner :

1. séquentialiser les requêtes plutôt que les paralléliser, éviter de télécharger plusieurs fois la même donnée, mettre en place un mécanisme de cache dans votre organisation,

2. temporiser les requêtes avec un délai entre 2 requêtes successives, gérer une reprise de téléchargement avec un délai en cas d'échec,

3. prendre en compte le quota de(s) l’API utilisée(s) dès la conception de votre programme afin de limiter le nombre de requêtes émises sous le plafond du quota,

4. utiliser les web services de catalogue dynamique pour identifier la présence de la donnée avant de la télécharger,

5. mettre en place un mécanisme de cache dans votre organisation.

Articles connexes