Aller au contenu

Gestion des clés API de serveur

Dans cet article

Information

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

Pour accéder à l'ensemble du compte ou à un serveur spécifique, générez une clé d'accès API dans la zone personnelle du panneau de contrôle Invapi. Suivez ces instructions pour l'obtenir.

Obtention d'une clé API pour un serveur spécifique

  1. Accédez à Invapi;

  2. Sélectionnez le serveur auquel vous souhaitez accéder via le panneau de contrôle externe : Mes Serveurs >> Vous avez besoin d'un serveur;

  3. Générez une clé API :

    • Naviguez vers l'onglet Info et choisissez l'option API keys.
    • Cliquez sur le bouton Add new.

    • Dans le champ Name, entrez le nom de la clé pour l'identifier;
    • Spécifiez les adresses IP uniquement à partir desquelles cette clé aura accès dans le champ IP ACL, ou laissez-le vide pour un accès non restreint;
    • Cochez la case Active pour activer la clé;
    • Cliquez sur le bouton Add new API key.

    La clé API vous sera affichée.

Attention

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

Modification ou suppression d'une clé API

Pour modifier ou supprimer une clé API, naviguez vers votre compte ou le serveur spécifique où elle a été générée et cliquez sur la clé souhaitée. Dans la fenêtre qui apparaît, allez à 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 adresse de notification (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 supprimée.

Utilisation d'une clé API

La clé API peut être utilisée de la manière suivante :

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

  2. Pour accéder au Server Control Panel, qui permet d'accéder aux serveurs sans se connecter à votre compte du panneau de contrôle Invapi, et l'incorporer en tant que module autonome dans votre système de facturation pour gérer les serveurs HOSTKEY, vous devez générer des server-specific API keys.

Informations d'utilisation de la clé API

Dans l'onglet Usage history, sélectionnez une clé spécifique pour un compte ou serveur 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.

Obtenir une clé API sans panneau web

Une clé API peut être obtenue sans utiliser le panneau de contrôle web en utilisant les API methods for working with API keys. 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'IA.