Le suivi des erreurs d'API vous aide à surveiller les performances de votre site et l'expérience des utilisateurs au fil du temps. Identifiez les erreurs d'API qui ont le plus d'impact sur les objectifs de votre site, trouvez les causes profondes des erreurs et résolvez-les.
Qu'est-ce qu'une API et une erreur d'API ?
Qu'est-ce qu'une API ?
Les interfaces de programmation d'applications (API) sont des intermédiaires de logiciels qui permettent à deux applications de communiquer entre elles. Une API comporte 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 consultez une application météo sur votre mobile ou votre desktop, vous utilisez une API.
L'application se connecte à l'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 vers votre appareil. Votre application météo interprète alors les données et vous présente les informations.
Qu'est-ce qu'une erreur API ?
Les erreurs API se produisent lorsqu'une requête API est invalide ou mal formulée, par exemple s'il manque un paramètre ou si elle comporte une faute de frappe.
Certaines de ces erreurs peuvent avoir un impact sur l'expérience utilisateur, tandis que d'autres ne peuvent être détectées par les utilisateurs. Surveiller les erreurs d'API permet de s'assurer qu'une baisse des performances de votre site n'est pas due à un problème lié à une requête API non réactive ou erronée.
Par exemple :
Si l'API d'un prestataire de services de paiement ne répond pas en raison d'une faute de frappe dans la requête, les utilisateurs ne pourront pas terminer leurs achats ; ou si une API d'inventaire n'affiche 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.
Collecte des erreurs d'API
Appels d'API que nous collectons
L'Analyse des Erreurs avec la surveillance des erreurs d'API suit deux types d'API basées sur l'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 Modern Fetch : Similaire à l'API XMLHttpRequest, mais avec un ensemble de fonctionnalités plus puissantes et plus flexibles.
Erreurs collectées par page vue
Un maximum de 20 erreurs d'API est collecté par page vue.
Analyser les erreurs d'API
1. Cliquez sur le menu déroulant des filtres ("Filtrer") pour filtrer par erreurs d'API.
2. Utilisez les onglets de l'Analyse des Erreurs pour mieux comprendre l'impact des erreurs. Par exemple : utilisez l'onglet "Groupes de pages" pour n'analyser que les erreurs associées à un groupe de pages de cartographie spécifique.
3. Cliquez sur le bouton ">" pour ouvrir le panneau latéral des erreurs et voir les informations clés concernant cette erreur.
4. Cliquez sur "Voir le replay" pour visionner la session.
Partager les détails d'API
- Ouvrez le panneau latéral de l'erreur.
- Cliquez sur le bouton "Copier les détails de l'erreur" pour copier les détails et pouvoir les partager.
Les détails suivants sont affichés pour chaque erreur :
-
URL de la requête : La destination de la demande (par exemple, la demande pourrait être d'effectuer un paiement auprès d'un fournisseur tiers).
-
Code d'état : Le code d'état de la réponse à l'erreur correspondant (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 grandes catégories d'erreurs :
-
Erreurs du client --- statuts 400 à 4xx
- L'erreur provient de la demande initiale envoyée par le navigateur/la web-app, ce qui signifie qu'elle contient une erreur.
- Ces erreurs sont plus problématiques puisque l'erreur provient du code lui-même dans la plupart des cas et que recharger la page ou renvoyer la requête ne résoudra pas le problème.
-
Erreurs de serveur --- statut 500 à 5xx
-
L'erreur est déclenchée pendant le traitement de la demande par le serveur, ce qui signifie que le serveur a rencontré une erreur interne et ne peut pas résoudre la demande.
- La plupart des erreurs côté serveur sont temporaires. Si l'agent utilisateur envoie la même demande ultérieurement, en rechargeant la page, la demande peut aboutir.
-
Codes d'erreur d'état les plus courants et leur signification :
Erreurs courantes côté client
|
Code |
Message |
Signification |
|
400 |
Mauvaise demande |
Le serveur n'a pas pu traiter une demande d'API en raison d'une erreur de syntaxe : une faute de frappe ou une erreur lors de l'élaboration 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é |
Envoyé lorsque la demande d'API est dépourvue d'informations d'authentification ou que les informations d'authentification fournies sont invalides. |
|
403 |
Interdit |
Envoyé dans le cas où l'utilisateur n'a pas demandé de jeton d'accès à l'API avec les autorisations d'accès correctes. |
|
Non trouvé |
Ressource non trouvée. Signifie soit :
|
|
|
408 |
Délai d'attente dépassé |
La demande 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 la demande trop grande |
Se produit lorsqu'une demande émanant d'un client est trop volumineuse pour être traitée par le serveur web. |
|
429 |
Trop de requêtes |
De nombreuses API publiques incluent une forme de limitation du débit. Il s'agit d'un moyen de protéger le fournisseur d'API contre le fait qu'un utilisateur effectue trop d'appels d'API, ce qui peut consommer trop de ressources et potentiellement provoquer des pannes d'API. |
Erreurs courantes côté serveur
|
Code |
Message |
Signification |
|
500 |
Erreur de serveur interne |
Le serveur a rencontré une condition inattendue qui l'a empêché de répondre à la demande. |
|
502 |
Erreur de passerelle ou de proxy |
Le serveur, agissant en tant que passerelle ou proxy, a reçu une réponse invalide du serveur en amont auquel il a accédé en tentant de répondre à 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. |