La fiche d'une clé d'API

C'est la fiche de lecture d'une clé d'API déjà créée. Vous l'ouvrez depuis l'onglet Développeurs des réglages, par le lien « Voir détails » ou « Logs d'usage » d'une carte de clé. Elle sert à savoir ce que la clé a le droit de faire, et ce qu'elle a réellement fait.

#Ce que l'écran affiche

• En tête : le nom de la clé, sa pastille d'état (active, revoked ou expired) et le début de la clé suivi de points de suspension.
• Une rangée de 5 compteurs : « Requêtes (7j) », « Succès », « Erreurs », « Items traités », « Temps moy. ». Les succès et les erreurs portent aussi leur part en pourcentage.
• Trois onglets : « Informations », « Logs d'usage », « Statistiques ».
• Onglet « Informations » : « Brand ID », « Scopes », « Quota quotidien » sous la forme consommé du jour sur quota autorisé, « Créée le », « Dernière utilisation », « Expire le », et la description si elle a été renseignée.
• Onglet « Logs d'usage » : une ligne par appel, avec la méthode et le chemin appelé, une pastille, le code de réponse, l'horodatage, le nombre d'items, la durée en millisecondes et l'adresse IP d'origine. Le message d'erreur s'affiche sous la ligne quand il y en a un.
• Onglet « Statistiques » : « Total de requêtes », « Taux de succès », « Taux d'erreur », « Temps de réponse moyen » et « Items traités ».

#Ce que vous pouvez y faire

• Passer d'un onglet à l'autre. Les trois onglets sont alimentés par un seul chargement, cliquer un onglet ne relance rien.
• Revenir à la liste des clés par le bouton « Retour ».
• La fiche est en lecture seule. Aucun bouton n'y modifie ni n'y révoque la clé, la révocation reste dans l'onglet Développeurs.

#Ce qui conditionne l'accès

• Les compteurs et l'onglet « Statistiques » couvrent une période fixée à 7 jours par l'écran. Le serveur accepte de 1 à 90 jours, la fiche ne propose pas de changer cette valeur.
• L'onglet « Logs d'usage » demande les 50 appels les plus récents, du plus récent au plus ancien, alors que le serveur en accepte 500 par appel.
• Un appel compte comme un succès quand son code de réponse est compris entre 200 et 299, et comme une erreur à partir de 400. Dans la liste, la pastille reste verte en dessous de 400.
• « Quota quotidien » affiche « Illimité » quand aucun quota n'est fixé sur la clé.
• « Dernière utilisation » et « Expire le » affichent « Jamais » tant que la date est absente.
• L'écran est sous la porte d'offre des clés d'API : une marque dont l'offre ne porte pas api_access ne l'ouvre pas et se voit proposer une montée en offre. Ce n'est pas ce qui protège les données, le serveur décide seul, et une marque sans api_access ne peut créer aucune clé donc n'en a aucune à afficher.

#Ce que l'écran refuse

• Le secret de la clé ne se réaffiche jamais ici. La fiche ne montre que le début de la clé.
• Sans aucun appel enregistré : « Aucun log d'usage pour cette clé API ».
• Sans statistique : « Aucune statistique disponible ».
• Une clé qui n'appartient pas à une marque de votre périmètre n'affiche aucune donnée.
• Un chargement en échec n'attend pas indéfiniment : l'écran affiche « Une erreur est survenue » et un bouton pour réessayer.