Qu'est-ce que l'API analytique ?

La publication d'une API pour une consommation externe n'est qu'une étape du cycle de vie d'une API. Pour mieux comprendre l'impact commercial et technique de vos API, il convient d'adopter des API analytiques robustes. L'adoption réussie des API par les développeurs nécessite le suivi et la gestion de tous les aspects opérationnels d'un programme d'API.

Diagramme d'API analytique

Pourquoi utiliser les API analytiques ?

  • Obtenir des résultats axés sur la perspicacité : données en temps réel sur l'écosystème (applications, consommation, performances et mesures d'utilisation (pics, latence, temps de réponse)) pour obtenir une visibilité de bout en bout du programme.
  • Gérer les risques : les mesures opérationnelles en temps réel permettent de prendre des décisions et de protéger le programme API contre les cyberattaques.
  • Améliorer l'expérience client : établir de meilleures relations avec les clients (développeurs et consommateurs d'API) et prendre des décisions en fonction des données (mesurer l'engagement et les performances des API).
  • Contrôler les indicateurs clés de performance : suivre et mesurer l'utilisation de l'API sur les produits, les applications, les canaux et les sites.
Ressource d'API analytique
Le guide définitif du succès pour le chef de produit API
Exploitez la puissance des API grâce à un guide de réussite en sept parties expliquant comment les entreprises peuvent créer des programmes d'API pour développer leurs activités numériques !

Questions fréquemment posées

Les réponses aux questions suivantes vous aideront à améliorer votre plateforme API, à résoudre les problèmes et à prendre de meilleures décisions commerciales :

  • Quelles sont les performances de mon trafic API ?
  • Quelles sont les méthodes d'API les plus populaires ?
  • Qui sont les principaux développeurs d'API ?
  • Y a-t-il des problèmes qui entravent le temps de réponse ?
  • Où se trouve la plus grande partie du trafic API ?

Avantages des API analytiques

Obtenir une visibilité opérationnelle sur les performances des API

Surveiller les tendances et les modèles d'utilisation de votre API, notamment la latence, les taux d'erreur, les performances du cache, les modèles d'utilisation et les pics d'appels. Afficher les résultats dans une variété de tableaux de bord faciles à comprendre pour permettre une analyse intelligente des API.

Comprendre comment vos API sont utilisées

Voyez d'un coup d'œil qui utilise vos API et comment elles sont utilisées. L'API analytique vous permet de comprendre leur utilisation au niveau de la méthode afin de repérer les tendances en matière d'adoption et de modèles d'utilisation.

Dépannage à l'aide du suivi des appels d'API

Vous avez des problèmes d'erreurs d'API ? Utilisez notre fonction de suivi des appels en temps réel pour analyser en profondeur les flux d'appels d'API afin d'identifier les zones problématiques et les points de défaillance.

Exporter les données du journal d'appels pour un usage externe

Faites comme bon vous semble. Exportez l'ensemble des données du journal d'appels d'API vers TIBCO Spotfire (ou l'environnement d'API analytique personnalisé de votre choix) et poussez les données du journal vers un logiciel de facturation pour monétiser vos API.

Obtenez un accès API aux données du tableau de bord et des rapports

Accédez à toutes les données affichées dans les tableaux de bord et les rapports prêts à l'emploi via un outil de rapport API pour l'exportation et la réutilisation programmatiques.

Types de rapports d'API analytiques

Haut niveau : résumé exécutif

La page du résumé exécutif fournit une vue d'ensemble de votre programme d'Application Programming Interface (API), avec de nouvelles mesures et tendances analytiques fournies dans un format facile à partager avec les parties prenantes de votre organisation.

Le résumé exécutif est conçu pour fournir un ensemble complet d'informations rapidement et efficacement sans aucune tâche de collecte et d'analyse des données. Le résumé exécutif est un complément aux rapports existants également disponibles sur le tableau de bord d'administration et est conçu pour un large public tel que les administrateurs d'API, les gestionnaires de solutions d'API, les responsables du développement commercial, les responsables du marketing et les responsables techniques.

Niveau moyen : rapports

Les rapports fournissent des data visualizations pour aider à surveiller les performances techniques et les mesures commerciales des API, des progiciels, des plans, des points de terminaison et des développeurs.

Les utilisateurs accèdent aux rapports pour :

  • Afficher le résumé de l'utilisation de l'API
  • Voir les données techniques sur les performances de l'API
  • Voir l'activité des développeurs
  • Visualiser et analyser la latence des appels d'API
  • Afficher et analyser les réponses aux erreurs

Bas niveau : exportations de journaux d'appels, flux de journaux d'appels et inspecteur d'appels

Exportations de journaux d'appels

La fonction d'exportation des journaux d'appels vous permet d'accéder aux journaux d'appels d'API bruts, de les filtrer et de les exporter sous forme de fichiers CSV. Les nouveaux journaux sont fournis toutes les 30 minutes et comprennent des informations détaillées sur les appels d'API, telles que l'adresse IP source, l'URL, le nom du service et les noms des points de terminaison. Il existe de nombreux cas d'utilisation possibles pour ces données, notamment la facturation fine, la détection des abus et la résolution de problèmes.

Flux de journaux d'appels

La page principale des flux d'enregistrement des appels affiche une liste navigable de tous les enregistrements de canaux de flux d'enregistrement des appels. Vous pouvez accéder aux informations suivantes :

  • Nom du canal : le nom du canal du flux d'enregistrement des appels ; le nom par défaut est « Channel for area name (canal pour nom de la zone) »
  • Statut : le statut du canal, soit Activé ou Désactivé
  • Créé : la date et l'heure de création du canal
  • Mise à jour : la date et l'heure de la dernière mise à jour du canal

Inspecteur d'appels

L'inspecteur d'appels est une fonction de diagnostic utilisée pour suivre les appels d'API lors de leur passage dans le système. Il fournit des informations détaillées sur l'aspect réel des demandes et des réponses lorsqu'elles passent par différents points. Les clients peuvent utiliser l'inspecteur d'appels pour des cas d'utilisation tels que le dépannage des appels d'API ou la prise en charge de nouvelles intégrations. Les données des appels d'API peuvent être capturées en activant les journaux d'appels pour un point de terminaison et une période de temps spécifiés.

Mesures des API analytiques

Chaque équipe voudra utiliser des mesures différentes. Les mesures d'API pour les équipes chargées de l'infrastructure seront différentes des mesures d'API pour les équipes chargées des produits. Les mesures d'API peuvent également dépendre du cycle de vie de la Solution API. Par exemple, une nouvelle API se concentrera davantage sur l'amélioration de la conception et de l'utilisation, tandis qu'une API plus ancienne pourra se concentrer sur des fonctionnalités supplémentaires.

Il existe quatre groupes principaux qui dépendent des mesures d'API :

DevOps

Les équipes DevOps s'assurent que les serveurs fonctionnent et que les ressources limitées sont correctement allouées, potentiellement pour plusieurs équipes d'ingénieurs.

Plusieurs mesures sont importantes pour cette équipe :

  • Temps de fonctionnement
  • Utilisation du CPU
  • Utilisation de la mémoire

Ingénierie d'application

Les développeurs d'API ajoutent de nouvelles fonctionnalités aux API tout en résolvant les problèmes liés à la logique commerciale de l'API. Ils développent des produits tels que les plugins, les intégrations de partenaires, les API incorporées, etc.

Voici trois mesures importantes pour cette équipe :

  • Demande par minute (Request Per Minute, ou RPM)
  • Latence moyenne et maximale
  • Erreurs par minute

Gestion des produits

Les gestionnaires de Solutions API conçoivent les fonctionnalités d'API, s'assurent que les bons points de terminaison sont construits et concilient les besoins des clients avec les contraintes de temps.

Voici certaines mesures importantes pour cette équipe :

  • Croissance de l'utilisation de l'API
  • Clients uniques de l'API
  • Principaux clients par utilisation de l'API
  • Rétention de l'API
  • L'heure du premier Hello World (Time to First Hello World, ou TTFHW)
  • Appels API par transaction commerciale
  • Adoption du SDK et des versions

Croissance de l'entreprise

Les équipes en contact avec les entreprises, comme le marketing et les ventes, ne pensent généralement pas en termes de points de terminaison d'API. Elles s'intéressent davantage à l'adoption par les clients et à l'identification des utilisateurs susceptibles de représenter de nouvelles opportunités de vente.

Voici trois mesures importantes pour cette équipe :

  • Chiffre d'affaires
  • Adoption
  • Satisfaction des clients