Aller au contenu

Gestion des clés API pour l'accès au compte Invapi

Dans cet article

Information

La clé API est un moyen pratique d'authentification pour accéder sans accroc aux requêtes API à Invapi.

Une clé API est une méthode pratique pour autoriser les requêtes API vers Invapi et accéder au Panneau de Contrôle d'un serveur spécifique indépendamment du centre de contrôle personnel et du compte.

Obtention d'une clé API pour l'ensemble du compte Invapi

  1. Accédez à Invapi et cliquez sur Username >> API keys.

  2. Cliquez sur le bouton Add new pour créer une clé API.

    • Pour identifier la clé dans le champ Name, entrez son nom ;
    • Dans la liste déroulante Restrict a new API key only for the server, sélectionnez si la clé s'appliquera à l'ensemble du compte (Any) ou à un serveur spécifique ;
    • Spécifiez les adresses IP depuis lesquelles l'accès sera autorisé en utilisant cette clé dans le champ IP ACL, ou laissez-le vide pour un accès non restreint.
    • Choisissez une méthode de notification pour l'accès au compte via cette clé API à partir de la liste déroulante Set login notification method. Les options incluent :
      • None (aucune notification) ;
      • E-mail
      • Webhook - envoyez des informations de connexion via un appel HTTP vers votre site web.
    • Si vous sélectionnez E-mail ou Webhook, entrez l'adresse e-mail correspondante ou URL dans le champ Notification address (email/URL).
    • Pour activer la clé, cochez la case Active ;
    • Pour ajouter une nouvelle clé API, cliquez sur le bouton Create.

    La clé API vous sera affichée.

Attention

Assurez-vous de copier et de sauvegarder la valeur de la clé API car elle ne sera visible qu'une seule fois. Invapi n'enregistre que la valeur hachée de la clé, donc si la clé originale est perdue, elle devra être recréée.

Gestion des clés API pour l'ensemble du compte Invapi

Pour éditer ou supprimer une clé API, accédez à votre compte où elle a été générée et cliquez sur la clé souhaitée. Dans la fenêtre qui apparaît, allez dans l'onglet General Info où vous pouvez :

  • changer le nom de la clé dans le champ Name ;
  • définir les adresses IP à partir desquelles les appels utilisant la clé seront interdits dans le champ IP ACL ;
  • modifier ou définir la méthode de notification pour se connecter avec cette clé API. Cela s'applique uniquement aux clés émises pour l'ensemble du compte et concerne le champ d'adresse de notification (email/URL) ;
  • activer ou désactiver temporairement cette fonctionnalité en utilisant la case Active.

Ensuite, cliquez sur le bouton Save API key pour sauvegarder vos modifications.

Pour supprimer une clé API, cliquez sur le bouton Delete API key.

Attention

Une fois qu'une clé API a été supprimée, elle ne peut pas être restaurée.

Utilisation de la Clé API pour l'ensemble du compte Invapi

La clé API peut être utilisée pour obtenir un jeton de session requis pour les requêtes API ultérieures à un compte dans Invapi. L'autorisation est nécessaire. Elle peut être obtenue via une clé API pour accéder soit à l'ensemble du compte, soit à un serveur spécifique en utilisant la auth/login appel, selon la clé API utilisée. Si l'autorisation réussit et que la clé est trouvée dans la base de données, le système retournera le jeton $HOSTKEY_TOKEN.

Informations d'utilisation des Clés API pour l'ensemble du compte Invapi

Dans l'onglet Usage history, sélectionnez une clé spécifique pour un compte et cliquez dessus pour voir toutes les connexions effectuées avec cette clé API pendant une certaine période. La sortie inclura l'email et l'adresse IP utilisés pour la connexion, son statut de réussite, ainsi que la date et l'heure de l'événement.

Obtention d'une clé API pour l'ensemble du compte Invapi sans panneau de contrôle web

Une clé API peut être obtenue sans utiliser le panneau de contrôle web en utilisant les méthodes API pour travailler avec des clés API. Ces méthodes peuvent être exécutées depuis la ligne de commande ou intégrées dans des solutions web.

Une partie du contenu de cette page a été créée ou traduite à l'aide d'une IA.