Aller au contenu

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

Dans cet article

La clé API est un moyen pratique d'authentification pour un accès fluide aux requêtes API vers Invapi.

Attention

L'obtention d'une clé API de compte n'est possible que si le compte possède un solde positif (non nul).

La clé d'accès API est générée dans le compte personnel du panneau de contrôle Invapi pour l'accès à l'ensemble du compte ou à un serveur spécifique. Pour obtenir une clé API pour le compte, suivez ces instructions :

Obtenir une clé API pour l'ensemble du compte Invapi

  1. Naviguez vers Invapi et cliquez sur Username >> API keys.

  2. Cliquez sur le bouton New API key pour créer une clé API.

    • Pour identifier la clé dans le champ Name, saisissez 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 à partir desquelles l'accès sera autorisé en utilisant cette clé dans le champ IP ACL, ou laissez le champ vide pour un accès illimité.
    • Choisissez une méthode de notification pour l'accès au compte en utilisant cette clé API dans la liste déroulante Set login notification method. Les options incluent :
      • None (aucune notification) ;
      • E-mail
      • Webhook - envoie les informations de connexion via un appel HTTP vers votre site web.
    • Si vous sélectionnez E-mail ou Webhook, saisissez l'e-mail ou l'URL correspondante 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 nommé 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 affichée qu'une seule fois. Invapi ne stocke que la valeur de hachage de la clé ; par conséquent, si la clé originale est perdue, elle devra être recréée.

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

Pour modifier ou supprimer une clé API, naviguez vers votre compte où elle a été générée et cliquez sur la clé souhaitée. Dans la fenêtre qui s'affiche, allez sur l'onglet General Info où vous pouvez :

  • modifier 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 la connexion avec cette clé API. Cela s'applique uniquement aux clés émises pour l'ensemble du compte et concerne le champ Notification address (email/URL) ;
  • activer ou désactiver temporairement cette fonctionnalité en utilisant la case à cocher Active.

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

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

Attention

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

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

La clé API peut être utilisée pour obtenir le jeton de session requis pour les requêtes API ultérieures vers un compte dans Invapi ; l'autorisation est nécessaire. L'autorisation peut être obtenue via une clé API pour l'accès soit à l'ensemble du compte, soit à un serveur spécifique via l'appel auth/login, 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 renverra le jeton de session $HOSTKEY_TOKEN.

Informations sur l'utilisation de la clé 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 période donnée. Le résultat inclura l'e-mail 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.

Obtenir 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 les clés API. Ces méthodes peuvent être exécutées depuis la ligne de commande ou intégrées dans des solutions web.