Une clé API permet à une autre application, comme votre CRM ou votre propre code, d'accéder à votre compte ActiveTrail sans votre mot de passe. Chaque requête API doit contenir une clé dans l'en-tête Authorization.

Créer une clé API

Les utilisateurs qui ont les droits de gestionnaire (Manager) peuvent créer et consulter les clés API.

  1. Allez dans Intégrations → API → Clés API et cliquez sur Nouveau.
  2. Saisissez un Nom qui indique quelle application utilise la clé, par exemple « Salesforce ».
  3. Facultatif : ajoutez une Description, des Ips autorisées (la clé ne fonctionne que depuis ces adresses IP, séparées par des virgules) et une Date d'expiration.
  4. Enregistrez, et copiez la clé tout de suite. Elle n'est affichée qu'une seule fois.

Pour en savoir plus sur les réglages de la clé, consultez Clés API et autorisation.

Désactiver une clé API

Si une clé a pu être exposée, ou si l'intégration qui l'utilisait ne sert plus, désactivez-la : ouvrez la clé dans la liste des clés API, décochez la case Actifs et enregistrez.

Protéger vos clés

Une clé API donne un accès complet à votre compte ActiveTrail : protégez-la comme un mot de passe.

  • Donnez à chaque intégration sa propre clé, avec un nom clair. Si une clé est exposée, vous pouvez la désactiver sans toucher à vos autres intégrations.
  • Si vous savez quelles adresses IP utiliseront une clé, ajoutez-les dans Ips autorisées.
  • Donnez une Date d'expiration aux clés de test et de développement.
  • Ne montrez pas de clés dans des captures d'écran, des vidéos ou de la documentation. Le floutage ne suffit pas toujours : retirez complètement la clé de l'image.
  • N'envoyez pas de clés par e-mail. Si vous devez partager un accès, créez une nouvelle clé dans ce but, pour pouvoir la désactiver plus tard.
  • Si vous supprimez un utilisateur de votre compte, les clés API qu'il a créées sont supprimées aussi.

Support de l'API

Le support ActiveTrail peut vous aider pour les questions de compte et de clés, mais le dépannage approfondi de l'API et le travail de développement peuvent prendre plus de temps. Pour la liste complète des points de terminaison, consultez les guides de référence de l'API de cette section.