---
title: 'Diagnostic API'
description: "Vérification de service de l'échange de données entre AI Analytics et la plateforme des dispositifs de comptage, qui sonde chaque requête dont dépendent les autres rapports."
section: AI Analytics
weight: 9
---

import Alert from '@/components/docs/Alert.astro';

Vérification de service de l'échange de données entre AI Analytics et la plateforme des dispositifs de comptage. Le rapport interroge, une à une, toutes les requêtes de la plateforme utilisées par les autres rapports, et indique lesquelles répondent normalement et lesquelles renvoient une erreur. Le public visé est l'administrateur et le support technique : exécutez-le lorsque vous soupçonnez une défaillance d'intégration, et vous verrez immédiatement où la liaison avec le dispositif ou le serveur est rompue.

<Alert type="info">
  Il s'agit d'un outil de service destiné à l'administrateur. Il est accessible par un lien direct
  plutôt que depuis la liste générale des rapports présentée aux opérateurs.
</Alert>

## Ce qu'il affiche

Pour chaque type de requête de la plateforme — une ligne avec le résultat : quel point de terminaison a été appelé, si le serveur a répondu avec succès, combien de lignes de données il a renvoyées et quels champs figuraient dans la première ligne (pour confirmer que le format des données n'a pas changé).

| Élément de la ligne                | Ce qu'il signifie                                                                                                                                  |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| Point de terminaison de la requête | quel type de données a été vérifié (connexion, liste de la flotte, répertoires, sessions de liaison, archives de relevés, passeport du dispositif) |
| État                               | si le serveur a répondu avec succès ou a renvoyé une erreur                                                                                        |
| Nombre de lignes                   | combien d'enregistrements sont parvenus dans la réponse                                                                                            |
| Échantillons de champs             | noms des champs du premier enregistrement — un signe que le format n'a pas changé                                                                  |

La couleur de la ligne est déterminée par le code de réponse du serveur :

| Couleur                                                     | Ce qu'elle signifie                                            |
| ----------------------------------------------------------- | -------------------------------------------------------------- |
| Vert («200»)                                                | la requête fonctionne normalement                              |
| Jaune (erreur de permission, sauf «non trouvé»)             | les droits d'accès doivent être vérifiés                       |
| Rouge (erreur serveur ou absence de réponse en temps voulu) | un problème côté serveur                                       |
| Gris («404» — non trouvé)                                   | cette requête n'existe pas dans cette version de la plateforme |

<Alert type="note">
  Les points de terminaison comme `/api/v1/stations` et les noms de champs comme `archive_type` sont
  des identifiants techniques des requêtes et des champs de la plateforme, et non des paramètres
  destinés à l'opérateur.
</Alert>

## Comment il est calculé

Le rapport interroge, une à une, toutes les requêtes de la plateforme utilisées par les autres rapports : connexion, liste de la flotte, répertoires (types de dispositifs, distributeurs d'énergie, clients), sessions de liaison (en quatre variantes de paramètres), archives de relevés (horaires, journalières, mensuelles, paramètres), archives des situations anormales et journaux d'événements, ainsi que le passeport du dispositif. Pour chaque appel, le point de terminaison, la réponse du serveur, le nombre de lignes et un échantillon de champs sont enregistrés. Si un nœud précis est défini, les archives des situations anormales sont en outre vérifiées pour ce nœud.

## Paramètres d'exécution

| Paramètre                                                      | Valeur par défaut | Signification                                                                                                               |
| -------------------------------------------------------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------- |
| ID du nœud pour le sondage des archives anormales (facultatif) | issu du contexte  | s'il est défini — la vérification s'exécute sur ce nœud ; s'il est vide — le premier nœud de la liste de la flotte est pris |

## Comment le lire

Observez les couleurs des lignes. Tout en vert — l'échange de données est sain. Les lignes jaunes signifient que le serveur est en place mais ne renvoie pas de données sans les droits requis — une raison de vérifier les accès. Les lignes rouges sont une défaillance côté serveur et sont traitées en premier. Les lignes grises («non trouvé») sont souvent normales : tous les dispositifs ne prennent pas en charge tous les types d'archives, de sorte que l'absence d'archives anormales sur un dispositif précis n'est pas une erreur.

Notez une particularité de la connexion : la plateforme réutilise un laissez-passer obtenu précédemment pendant environ deux semaines, de sorte que la vérification de connexion réussit généralement même sans véritable reconnexion sur le serveur.

## Rapports liés

Ce rapport est autonome et ne dépend de rien. Tous les autres rapports de flotte utilisent les mêmes requêtes de plateforme qu'il vérifie — c'est donc ici qu'il faut commencer le diagnostic lorsqu'ils échouent.
