Traduit de l'anglais à l'aide de l'IA
Veuillez noter que cet article a été traduit à l'aide de la technologie IA. Bien que nous travaillions à maintenir l'exactitude, certains détails peuvent ne pas refléter parfaitement le texte original. Si vous avez des doutes sur une information, veuillez vous référer à la version anglaise.
La remontée des erreurs d'API vous aide à surveiller la performance du site et l'expérience utilisateur au fil du temps. Identifiez les erreurs d'API ayant le plus d'impact sur vos objectifs de site, trouvez la cause profonde de l'erreur et résolvez-la.
En savoir plus sur les API et les erreurs d'API
Qu'est-ce qu'une API ?
Les interfaces de programmation d'applications (API) sont des intermédiaires logiciels qui permettent à deux applications de communiquer entre elles. Une API a un ensemble de protocoles, de procédures et d'outils qui facilitent l'interaction entre, par exemple, un navigateur web et un serveur.
Chaque fois que vous vérifiez une application météo sur votre appareil mobile ou desktop, vous utilisez une API.
L'application se connecte à Internet et envoie des données à un serveur. Le serveur récupère ensuite ces données, les interprète, effectue les actions nécessaires et les renvoie à votre machine. Votre application météo interprète ensuite les données et présente l'information.
Qu'est-ce qu'une erreur d'API ?
Les erreurs d'API se produisent lorsque quelque chose ne va pas avec une requête d'API, par exemple s'il manque un paramètre ou s'il y a une faute de frappe.
Certaines de ces erreurs peuvent impacter l'expérience utilisateur tandis que d'autres passent inaperçues pour les utilisateurs. Surveiller les erreurs d'API aide à s'assurer qu'une baisse de la performance de votre site n'est pas due à un problème avec une requête d'API non réactive ou erronée.
Exemple :
Si une API de fournisseur de paiement ne répond pas en raison d'une faute de frappe dans la requête, un visiteur ne pourra pas finaliser son achat ; ou si une API d'inventaire ne montre pas les bonnes données parce qu'un paramètre est manquant, les utilisateurs pourraient être en mesure d'acheter un produit non disponible ; et ainsi de suite.
Comment les erreurs d'API sont collectées
Appels d'API collectés
L'analyse des erreurs avec la surveillance des erreurs d'API suit deux types d'API basées sur HTTP, envoyées par l'agent utilisateur (navigateur) aux serveurs :
- API XMLHttpRequest : L'API la plus couramment utilisée, qui peut être utilisée pour échanger des données entre un agent utilisateur (navigateur) et un serveur.
- API Fetch moderne : Semblable aux API XMLHttpRequest mais avec un ensemble de fonctionnalités plus puissant et flexible.
Erreurs collectées par page vue
Un maximum de 20 erreurs d'API sont collectées par page vue.
Filtrer les erreurs d'API depuis l'Explorateur d'erreurs
1. Accédez à l'Explorateur d'erreurs et filtrez les erreurs d'API.
2. Sélectionnez l'un des onglets d'erreur disponibles pour examiner l'impact des erreurs.
3. Cliquez sur l'erreur pour ouvrir le panneau latéral des erreurs et voir les détails de l'erreur.
4. Cliquez sur 'Voir les replays' pour rejouer la session et continuer votre analyse.
Partager les détails de l'API
1. Ouvrez le panneau latéral des erreurs.
2. Cliquez sur le bouton 'Copier les détails de l'erreur' pour copier et partager.
Les détails suivants sont affichés pour chaque erreur individuelle :
URL de la requête - La destination de la requête (si par exemple, la requête pourrait être pour finaliser un paiement d'un fournisseur tiers).
Code d'état - Le code d'état de réponse d'erreur pertinent (codes 400-599).
Méthode - La méthode de requête, les deux méthodes HTTP les plus courantes sont “GET” et “POST”. GET demande des données et POST les envoie.
Examiner le code d'état
En lisant les codes d'état, les développeurs peuvent rapidement voir ce qui se passe avec l'application et vérifier rapidement les erreurs.
Il existe deux principales catégories d'erreurs :
-
Erreurs client --- statut 400 à 4xx
- L'erreur provient de la requête initiale envoyée par le navigateur/application web, ce qui signifie qu'elle contient une erreur.
- Ces erreurs sont plus problématiques, car l'erreur provient du code lui-même dans la plupart des cas, et recharger la page ou renvoyer la requête ne résoudra pas le problème.
-
Erreurs serveur --- statut 500 à 5xx
L'erreur se produit lors du traitement de la requête par le serveur, ce qui signifie que le serveur a rencontré une erreur interne et ne peut pas résoudre la requête.
- La plupart des erreurs côté serveur sont temporaires, si l'agent utilisateur envoie la même requête plus tard, en rechargeant la page, la requête pourrait réussir.
Codes d'erreur d'état les plus courants et leurs significations
Erreurs courantes côté client
Code |
Message |
Signification |
400 |
Mauvaise demande |
le serveur n'a pas pu traiter une requête API en raison d'une syntaxe non valide : une faute de frappe ou une erreur lors de la construction de la requête, un paramètre de requête requis manquant ou non valide, un corps JSON mal formé avec un point-virgule ou une virgule manquante... |
401 |
Non autorisé |
retourné lorsque la requête API manque d'informations d'authentification ou que les informations fournies sont non valides |
403 |
Interdit |
retourné dans le cas où l'utilisateur n'a pas demandé un jeton d'accès API avec les permissions d'accès correctes. |
Non trouvé |
Ressource non trouvée. Cela signifie soit :
|
|
408 |
Délai d'attente de la requête |
la requête envoyée au serveur du site web a pris plus de temps que le serveur du site web n'était prêt à attendre |
413 |
Entité de requête trop grande |
se produit lorsqu'une requête faite par un client est trop grande pour être traitée par le serveur web |
429 |
Trop de requêtes |
Beaucoup d'API publiques incluent une forme de limitation de taux. C'est un moyen de protéger le fournisseur d'API d'un utilisateur effectuant trop d'appels API, ce qui peut utiliser trop de ressources et potentiellement provoquer des crashs d'API. |
Erreurs courantes côté serveur
Code |
Message |
Signification |
500 |
Erreur Interne du Serveur |
Le serveur a rencontré une condition inattendue qui l'a empêché de satisfaire la demande |
502 |
Porte d'entrée incorrecte ou Erreur de Proxy |
Le serveur, agissant en tant que passerelle ou proxy, a reçu une réponse non valide du serveur en amont auquel il a accédé en tentant de satisfaire la demande. |
503 |
Service Indisponible |
Le serveur est actuellement incapable de traiter la demande en raison d'une surcharge temporaire ou de la maintenance du serveur. |