Passer au contenu principal

Ouvrir dans AthenaHQ

app.athenahq.ai/settings/api

​
Objectif

La page Paramètres API vous permet de gérer l’accès programmatique aux données de votre organisation. Vous pouvez y générer et révoquer des clés API, consulter les guides d’intégration de Looker Studio et du Model Context Protocol (MCP), et configurer les identifiants d’intégration par iframe pour afficher le tableau de bord dans vos propres applications.

​
Contenu de la page

Bannière de lecture seule Si vous ne pouvez pas gérer les clés API, une bannière « Lecture seule · API » apparaît en haut. Son infobulle indique : « Demandez à un administrateur de l’organisation un accès en écriture à l’API pour effectuer des modifications ici. »

​
Onglet Clés API

Commandes de l’en-tête
  • Nombre de clés : nombre total de clés (par exemple « 3 clés »).
  • Menu Guides : instructions rapides de configuration d’intégrations précises.
  • Bouton Créer une clé API : ouvre la génération d’une nouvelle clé.
Tableau des clés API Liste toutes les clés API que vous avez le droit de consulter.
  • Nom : nom d’affichage attribué à la clé.
  • Clé : aperçu du préfixe suivi d’un suffixe masqué (par exemple sk_live_••••••).
  • Sites web : sites auxquels la clé peut accéder. Affiche « Tous les sites web » pour une clé globale, « Aucun » pour un périmètre vide ou jusqu’à 4 logos de sites. Au-delà, une pastille +N affiche au survol les noms des sites restants.
  • Création : date de génération de la clé.
  • Créée par : e-mail de l’utilisateur ayant généré la clé.
  • ... (menu Actions) : menu à l’extrémité droite de chaque ligne avec Modifier et Supprimer.
États verrouillés / vides
  • Proposition d’accès API : si l’offre n’inclut pas l’API, tout le panneau est remplacé par « Exploitez vos données AthenaHQ ». Selon votre rôle, vous voyez S’abonner (qui ouvre un devis en direct et un paiement) ou Contacter l’équipe.
  • État vide : si l’organisation a accès à l’API mais ne possède aucune clé, une carte illustrée indique « Créez votre première clé API » avec Créer une clé API.

​
Onglet Intégration embarquée

Domaines autorisés
  • Section listant les domaines web autorisés à intégrer le tableau de bord par iframe.
  • Ajouter un domaine : ouvre l’assistant d’autorisation d’un nouveau domaine.
  • Liste des domaines : URL du domaine autorisé et date d’« Ajout ». Chaque ligne possède un menu ... avec Supprimer.
Jetons d’intégration
  • Section listant les jetons sécurisés utilisés par votre backend pour authentifier les sessions intégrées.
  • Créer un jeton : ouvre la génération d’un jeton.
  • Liste des jetons : nom, badge de statut (« Actif » ou « En pause ») et « Dernière utilisation le [date] » (ou « Jamais utilisé »). Le survol révèle la date de création. Chaque ligne possède un menu ... avec Mettre en pause (ou Réactiver) et Supprimer.
Comment intégrer Athena Accordéon en bas de l’onglet contenant la documentation de référence : extrait HTML exact <iframe ...>, détail des paramètres d’URL requis et exemple Node.js de signature d’un JWT côté backend.

​
Actions disponibles

  • Créer une clé API : cliquez sur Créer une clé API et nommez-la. Les administrateurs peuvent choisir « Tous les sites web » ou « Sites web spécifiques » (dans une liste). Créer la clé révèle le secret une seule fois pour le copier.
  • Modifier une clé API : dans le menu ... de la ligne, sélectionnez Modifier pour renommer la clé ou changer les sites auxquels elle accède.
  • Supprimer une clé API : sélectionnez Supprimer dans le menu ..., puis confirmez. La suppression révoque immédiatement et définitivement la clé.
  • Accéder aux guides d’intégration : cliquez sur Guides.
    • Configuration MCP ouvre les instructions pour Claude.ai ou un autre client MCP.
    • Configuration Looker Studio explique comment connecter les tableaux de bord Looker Studio.
    • Documentation API ouvre la documentation développeur externe dans un nouvel onglet.
  • Ajouter un domaine d’intégration : dans l’onglet Intégration embarquée, cliquez sur Ajouter un domaine. Saisissez le domaine (par exemple example.com), puis poursuivez pour générer automatiquement un jeton d’intégration et un secret JWT pour ce domaine.
  • Créer un jeton d’intégration : cliquez sur Créer un jeton et nommez-le. Une boîte de dialogue affiche une seule fois le jeton d’intégration et le secret JWT pour les copier.
  • Mettre en pause / réactiver un jeton : dans le menu ..., Mettre en pause désactive temporairement le jeton (interrompant les intégrations qui l’utilisent). Réactiver rétablit l’accès.
  • Supprimer un domaine ou un jeton : sélectionnez Supprimer dans le menu ... de sa ligne.
  • Copier les identifiants : cliquez sur un bloc de code affichant un jeton ou secret JWT pour le copier instantanément. L’infobulle « Copié ! » confirme l’action.
  • Acheter l’accès API : si la fonctionnalité est verrouillée et que vous êtes administrateur, S’abonner (ou Obtenir l’accès API) ouvre un devis avec le montant proratisé dû aujourd’hui. La confirmation débite la carte enregistrée ou vous dirige vers Stripe Checkout.

​
Données affichées

  • Clés API : clés de votre organisation. Un membre externe, invité uniquement à certains sites, ne voit que les clés limitées aux sites auxquels il peut accéder.
  • Domaines et jetons d’intégration : tous ceux configurés pour le tableau de bord intégrable de l’organisation.
  • Devis d’abonnement : lors d’un achat d’accès API, la boîte de dialogue récupère les tarifs proratisés en direct depuis la facturation selon votre cycle actuel.

​
Parcours courants

Créer une clé API pour un site précis
  1. Dans l’onglet Clés API, cliquez sur Créer une clé API.
  2. Saisissez un nom explicite.
  3. Sous « Périmètre d’accès », sélectionnez Sites web spécifiques.
  4. Cochez les sites auxquels cette clé doit accéder.
  5. Cliquez sur Créer la clé.
  6. Cliquez sur la clé générée pour la copier, conservez-la en lieu sûr, puis cliquez sur Terminé.
Configurer un nouveau tableau de bord intégré
  1. Cliquez sur l’onglet Intégration embarquée.
  2. Cliquez sur Ajouter un domaine.
  3. Saisissez le domaine hébergeant l’iframe (par exemple internal.mycompany.com), puis appuyez sur Entrée ou cliquez sur Ajouter un domaine.
  4. À l’étape « Domaine ajouté », cliquez sur Créer un jeton.
  5. Sur l’écran « Intégration prête », copiez votre Jeton d’intégration, votre Secret JWT et l’extrait Exemple d’iframe.
  6. Transmettez-les à votre équipe de développement avec les instructions de signature JWT au bas de l’onglet.

​
États vides, de chargement et d’erreur

  • Chargement : un indicateur animé centré apparaît pendant la vérification des autorisations et la récupération des données. Pour les listes, « Chargement des domaines… » ou « Chargement des jetons… » peut s’afficher.
  • Aucune clé API : carte illustrée « Créez votre première clé API » avec une description des usages.
  • Listes d’intégration vides : une icône de globe avec « Aucun domaine ajouté pour le moment », ou de clé avec « Aucun jeton créé pour le moment ».
  • Erreurs : les échecs de création, modification ou suppression affichent une notification rouge en haut (par exemple « Échec de la mise à jour de la clé API »). Si le devis ne se charge pas, le message indique « Impossible de charger les tarifs pour le moment. Fermez cette fenêtre et réessayez. »
  • Liens entrants : menu principal des paramètres (Paramètres > API), ou badge « API » verrouillé de la barre latérale pour l’offre Free.
  • Liens sortants :
    • Documentation API : ouvre docs.athenahq.ai dans un nouvel onglet.
    • Contacter l’équipe : ouvre une réservation Cal.com pour l’équipe commerciale/l’assistance.
    • Claude.ai et Model Context Protocol : liens externes du guide MCP.
    • Stripe Checkout : si un utilisateur sans carte enregistrée souscrit à l’accès API.

​
Questions fréquentes à l’assistance

Pourquoi « Créer une clé API » est-il désactivé ? Le bouton est grisé sans autorisation d’écriture API. Son infobulle indique « Seuls les administrateurs peuvent créer des clés API ». Demandez à un administrateur l’accès api:write ou la création de la clé pour vous. J’ai perdu ma clé API / mon secret JWT. Comment le revoir ? Pour des raisons de sécurité, les clés et jetons secrets ne sont affichés qu’une fois, immédiatement après leur création. Si vous les perdez, supprimez-les (ou mettez en pause le jeton d’intégration) et générez-en de nouveaux. Puis-je limiter une clé API à un seul site ? Oui. À la création ou à la modification, sélectionnez « Sites web spécifiques » dans le périmètre d’accès et cochez uniquement les sites souhaités. Pourquoi ne puis-je rien cliquer ? Je ne vois qu’un écran verrouillé. L’accès API est payant. Avec l’offre Free, la page entière est bloquée par « Exploitez vos données ». Un administrateur doit changer d’offre pour déverrouiller ces paramètres.