Centre d'aideIntégrations

Pour: Administrateurs

Restreindre ou révoquer une clé API

Limitez une clé à certaines adresses IP, désactivez-la ou supprimez-la, et consultez la date de sa dernière utilisation.

Dans cet article6 sections

Avant de commencer

Vérifiez à chaque fois. Clé APIClé Un jeton secret, créé dans la section Intégration, qui permet à votre propre logiciel d'utiliser l'API du hub. Il est préférable de ne l’utiliser que dans le cadre de votre système informatique. Éteignez-le pendant un certain temps, ou effacez-le complètement. Cela se fait notamment lorsque la clé a été perdue, ou lorsque le système qui l’utilise est dépassé.

  1. Vérifiez sa dernière utilisation

    Dans la section Intégration › Clés, Dernière utilisation indique la date de la dernière utilisation de chaque clé. Dernière adresse IP utilisée, quant à lui, indique l’adresse d’où provient cette clé. Les appels rejetés, car la clé est invalide, ou parce qu’elle utilise une API incorrecte, ne sont pas comptabilisés. Un trait d’union signifie que la clé n’a pas été utilisée.

  2. Limitez-le à votre adresse

    Choisissez l’icône en forme de crayon, Touche Modifier, dans la ligne correspondante. Sous CIDR source, tapez l’adresse IPv4 publique de votre système, comme celle indiquée sous Dernière adresse IP utilisée, ou un intervalle d’adresses, par exemple 203.0.113.0/24. Pour permettre à cette adresse d’être utilisée depuis n’importe quelle adresse, videz le champ correspondant. Choisissez alors sauvegarder. Le message “La clé a été sauvegardée” s’affiche, et les appels provenant d’autres adresses seront refusés à partir de ce moment-là.

  3. Éteignez-le

    Pour l’instant, arrêtez l’utilisation de cette clé en utilisant Touche Modifier. Éteignez ensuite Actif et sélectionnez sauvegarder. Toute tentative d’utilisation de cette clé sera refusée jusqu’à ce que vous la rallumez à nouveau.

  4. Supprimez-le

    Pour supprimer une clé définitivement, sélectionnez l’icône de la boîte correspondante, Touche Suppr, dans sa ligne, puis Effacer. Le message “Clé supprimée” s’affiche. La clé cesse alors de fonctionner immédiatement, et ne peut plus être rétablie.

Que se passe-t-il ensuite ?

Personne ne est informé au moment où vous changez ou supprimez une clé. Les appels effectués par votre système envers cette clé seront refusés à partir de ce moment-là. Pour en savoir plus, veuillez consulter la section Authentification des demandes API avec une clé.

Si une clé a pu se perdre, éteignez-la immédiatement. Ensuite, créez une nouvelle clé, transférez votre système dessus, et supprimez la clé ancienne. Le type de la clé ne peut pas non plus être modifié : créez donc une nouvelle clé du type souhaité, puis supprimez cette dernière. Votre hub peut contenir deux clés de chaque type. Ainsi, après avoir déjà deux clés, supprimez-en une d’abord.

Articles connexes

Authentifiez les requêtes API avec une cléEnvoyez votre clé sous forme de jeton porteur à l'API du panneau d'administration pour une clé de gestion ou à l'API du portail pour une clé de hub, et limitez-la à vos adresses IP.Intégrations