Activer l'Accès API

WatchGuard fournit des API RESTful publiques utilisables à des fins d'intégration avec les produits et services WatchGuard. Pour utiliser une API WatchGuard, vous devez activer l'accès API RESTful dans WatchGuard Cloud.

Pour obtenir des informations plus détaillées, consultez l'Aide des API WatchGuard.

Activer l'Accès API

Lorsque vous activez l'accès API, vous établissez des identifiants de lecture-écriture et de lecture seule pour les requêtes API, et vous générez une Clé API identifiant votre compte dans les requêtes transmises aux API WatchGuard. WatchGuard Cloud prend en charge l'accès API pour les comptes Service Provider et Subscriber. Pour de plus amples informations concernant les statistiques d'utilisation des API publiques de WatchGuard pour votre compte, consultez la section Utilisation de l'API.

Pour activer l'accès API, vous devez posséder le rôle d'opérateur Propriétaire ou Administrateur.

Pour activer l'accès API :

  1. Connectez-vous à WatchGuard Cloud.
    Si vous êtes Service Provider, dans le Gestionnaire de Comptes, sélectionnez Mon Compte ou un compte géré.
  2. Sélectionnez Administration > Accès Géré.

  3. Cliquez sur Activer l'Accès API.

  4. Spécifiez les mots de passe readwrite (lecture-écriture) et readonly (lecture seule) à utiliser pour votre accès API. Les mots de passe doivent comporter une majuscule, une minuscule, un chiffre et un caractère spécial.

    Le mot de passe readwrite doit être différent du mot de passe readonly.

  5. Cochez la case J'accepte les conditions d'utilisation du Contrat de Licence des API WatchGuard.
    Vous pouvez cliquer sur Afficher le Contrat de Licence des API WatchGuard pour consulter les détails du contrat.
  6. Cliquez sur Enregistrer.

Après avoir activé l'accès API, les informations suivantes s'affichent :

  • Identifiant d'accès (Lecture-écriture) — Spécifiez cet identifiant et le mot de passe de lecture-écriture comme identifiants dans une requête d'API afin de générer un jeton d'accès API autorisant un accès en lecture-écriture.
  • Identifiant d'accès (Lecture seule) — Spécifiez cet identifiant et le mot de passe de lecture seule comme identifiants dans une requête d'API afin de générer un jeton d'accès API autorisant un accès en lecture seule.
  • URL de l'API d'Authentification — Pour générer un jeton d'accès, envoyez une requête à l'URL de l'endpoint de l'API d'Authentification WatchGuard.
  • URL des API (base) — L'URL de base des requêtes aux API publiques de WatchGuard.
  • Clé API — Spécifiez-la en tant que valeur du paramètre d'en-tête X-API-Key dans toutes les requêtes transmises aux API publiques de WatchGuard.

L'URL de l'API d'Authentification et l'URL des API (base) dépendent de la région de stockage des données de votre compte WatchGuard Cloud.

Les API publiques de WatchGuard emploient une authentification par jeton. Dans chaque requête transmise à une API WatchGuard, vous spécifiez une Clé API identifiant votre compte, ainsi qu'un jeton d'accès qui autorise l'accès à l'API pendant une certaine durée. Pour obtenir un jeton d'accès, vous envoyez une requête à l'API d'Authentification WatchGuard. La requête de jeton d'accès doit inclure les identifiants d'API lecture-écriture de votre compte encodés en base64.

Pour de plus amples informations concernant l'envoi de requêtes API, consultez l'Aide des API WatchGuard. Pour de plus amples informations concernant les statistiques d'utilisation des API publiques de WatchGuard pour votre compte, consultez la section Utilisation de l'API.

Modifier Vos Mots de passe d'API

Pour modifier les mots de passe de vos Identifiants d'Accès aux API :

  1. Dans votre compte Subscriber WatchGuard Cloud, sélectionnez Administration > Accès Géré.
    Si vous êtes Service Provider, sélectionnez Mon Compte dans le Gestionnaire de Comptes.

Screen shot of RESTful API Access enabled

  1. Cliquez sur Changer les Mots de passe.

    Screen shot of the Change Passwords page.

  2. Spécifiez les nouveaux mots de passe de readwrite et readonly.
  3. Cochez la case J'accepte les conditions d'utilisation du Contrat de Licence des API WatchGuard.
    Vous pouvez cliquer sur Afficher le Contrat de Licence des API WatchGuard pour consulter les détails du contrat.
  4. Cliquez sur Changer les Mots de passe.

Révoquer l'Accès API

Pour révoquer l'accès API de votre compte WatchGuard Cloud :

  1. Connectez-vous à votre compte WatchGuard Cloud.
    Si vous êtes Service Provider, sélectionnez Mon Compte dans le Gestionnaire de Comptes.
  2. Sélectionnez Administration > Accès Géré.
  3. Cliquez sur Révoquer l'Accès.

    Screen shot of RESTful API Access enabled

Voir Également

Tableau de bord Utilisation de l'API

Aide des API WatchGuard

Configurer la MFA pour un RESTful API Client