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 à l'API RESTful dans WatchGuard Cloud.
Pour obtenir des informations plus détaillées, accédez à l'Aide des API WatchGuard.
Votre rôle d'opérateur détermine ce que vous pouvez afficher et faire dans WatchGuard Cloud. Vous devez disposer des permissions Administration de Compte dans le rôle Owner ou Administrator pour afficher ou configurer cette fonctionnalité. Pour de plus amples informations, accédez à Gérer les Opérateurs et Rôles de WatchGuard Cloud.
Activer l'Accès à l'API
Lorsque vous activez l'accès à l'API, vous établissez des informations d'identification 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 à l'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, accédez à Afficher l'Utilisation de l'API.
Pour activer l'accès à l'API, vous devez posséder le rôle d'opérateur Propriétaire ou Administrateur.
Pour activer l'accès à l'API :
- Connectez-vous à WatchGuard Cloud.
Si vous êtes Service Provider, dans le Gestionnaire de Comptes, sélectionnez Mon Compte ou un compte géré. - Sélectionnez Administration > Accès Géré.
- Cliquez sur Activer l'Accès à l'API.
-
Spécifiez les mots de passe readwrite (lecture-écriture) et readonly (lecture seule) à utiliser comme vos informations d'identification d'accès à l'API. Les mots de passe doivent comporter au moins 12 caractères et inclure une lettre minuscule, une lettre majuscule, un chiffre et un symbole. Le mot de passe ne doit pas inclure <, >, d'émojis ou d'espaces.
Le mot de passe readwrite et le mot de passe readonly doivent être différents.
- 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 examiner les détails du contrat. - Cliquez sur Enregistrer.
Après avoir activé l'accès à l'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 informations d'identification dans une requête d'API afin de générer un jeton d'accès à l'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 informations d'identification dans une requête d'API afin de générer un jeton d'accès à l'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 de l'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-Keydans toutes les requêtes transmises aux API publiques de WatchGuard.
L'URL de l'API d'Authentification et l'URL de l'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 informations d'identification à l'API en lecture-écriture de votre compte encodés en base64.
Pour de plus amples informations concernant l'envoi de requêtes API, accédez à l'Aide des API WatchGuard. Pour de plus amples informations concernant les statistiques d'utilisation des API publiques de WatchGuard pour votre compte, accédez à Afficher l'Utilisation de l'API.
Modifier Vos Mots de passe d'API
Pour modifier les mots de passe de vos Identifiants d'Accès à l'API :
- 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.
- Cliquez sur Modifier les Mots de Passe.
- Spécifiez les nouveaux mots de passe de readwrite et readonly.
- 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 examiner les détails du contrat. - Cliquez sur Modifier les Mots de Passe.
Révoquer l'Accès à l'API
Pour révoquer l'accès à l'API de votre compte WatchGuard Cloud :
- Connectez-vous à votre compte WatchGuard Cloud.
Si vous êtes Service Provider, sélectionnez Mon Compte dans le Gestionnaire de Comptes. - Sélectionnez Administration > Accès Géré.
- Cliquez sur Révoquer l'Accès.