Gestion et rapports

Cloud CNM SecuReporter

SecuReporter OpenAPI de Zyxel

Trouvez les ressources qui vous aideront à automatiser et à créer rapidement des applications personnalisées avec les API pour la plateforme SecuReporter de Zyxel.

Accès aux données de l'équipement avec le service SecuReporter OpenAPI

SecuReporter propose une interface permettant aux logiciels d'interagir directement avec la plateforme.
Ces API permettent aux utilisateurs de SecuReporter de récupérer les logs des équipements des 31 derniers jours à l'aide d'un token API.

Avec l'OpenAPI de SecuReporter, vous pouvez facilement accéder aux données de votre équipement par le biais de requêtes HTTP en utilisant n'importe quel langage de programmation ou des commandes cURL. Pour utiliser ce service, assurez-vous que votre équipement dispose d'une licence SecuReporter valide et d'un token OpenAPI. Ces informations d'identification sont nécessaires pour authentifier et autoriser vos requêtes à l'API.

Découvrez les Avantages du Token OpenAPI de SecuReporter

Simplifiez vos workflows, améliorez la scalabilité et favorisez l'automatisation en toute simplicité. Faites confiance à une méthode sécurisée, efficace et conviviale pour accéder aux fichiers log de votre firewall, conçue pour prendre en charge à la fois les processus manuels et automatisés.

Praticité et Efficacité

Accédez aux logs de votre firewall directement par le biais de requêtes HTTP en utilisant n'importe quel langage de programmation ou de commandes cURL. Aucune connexion au portail n'est nécessaire. Cela permet de simplifier votre workflow, de gagner du temps et est parfait pour les systèmes automatisés ou les scripts nécessitant une récupération régulière des logs.

Evolutif

Les tokens OpenAPI permettent un accès évolutif aux logs de firewall. Générez plusieurs logs pour différents utilisateurs ou systèmes, pour garantir la flexibilité et le contrôle.

Capacité d'Automatisation

Integration homogène avec d'autres systèmes et logiciels à l'aide de token d'API. Automatisez la récupération de logs de firewall et intégrez ces données dans vos systèmes de gestion des informations et des événements de sécurité (SIEM) sans intervention manuelle.

Pourquoi intégrer le Token OpenAPI de SecuReporter ?

SecuReporter fournit une méthode sûre, efficace et conviviale pour accéder aux fichiers logs des firewalls. Il prend en charge les processus manuels et automatisés tout en maintenant des normes de sécurité élevées. Pour plus d'informations sur l'intégration de SecuReporter OpenAPI, visitez notre GitHub.

GitHub de Zyxel

FAQ sur l'Intégration Homogène

Ne vous inquiétez pas, nous vous aidons ! Pendant que vous cherchez à intégrer OpenAPI avec SecuReporter, voici quelques conseils utiles et FAQs pour vous guider à travers le processus.

Le service de logs archivés est le premier service ouvert offert par SecuReporter OpenAPI. Il permet aux utilisateurs de récupérer des logs de firewall datant de 31 jours en utilisant un token API. Chaque token API autorise un maximum de 50 requêtes API par heure. Restez à l'écoute pour connaître les prochains services qui seront proposés à l'avenir.

Veuillez transmettre le ticket/cas par email à votre commercial Zyxel pour valider votre demande de fonctionnalité en termes d'impact.

Prérequis:

Assurez vous que votre firewall dispose d'une licence SecuReporter active et que le service SecuReporter est activé. Si votre licence est expiré, contactez le fabricant de l'équipement ou achetez une nouvelle licence sur la Marketplace de Zyxel pour accéder au service OpenAPI.

Les étapes pour générer un token OpenAPI sur SecuReporter :

Etape 1 : Selectionnez l'équipement avec une licence SecuReporter valide et cliquez sur le bouton "Accès API".

Etape 2 : Cliquez sur le bouton "Créer un nouveau token API".

Etape 3 : Copiez le token OpenAPI.

Deux méthodes sont possibles pour tester l'OpenAPI : cURL et Python.

[1] Test avec cURL

  • Vérifiez l'intallation : Pour vérifier si cURL est installé, ouvrez la fenêtre "Command Prompt" ou "Terminal" et tapez "curl". Si vous recevez une erreur indiquant que cURL n'est pas trouvé, suivez les instructions d'installation disponibles sur le dépôt GitHub de cURL.
  • Effectuez votre première requête OpenAPI : Ouvrez le Command Prompt/Terminal et utilisez la directive suivante. Remplacez yyy-MM-dd par une date des 31 derniers jours (à l'exception de la date actuelle) en utilisant le format yyyy-mm-dd.mydir par le chemin d'accès au dossier de téléchargement sur votre ordinateur.

macOS

curl -X POST \

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download \

-H "Content-Type: application/json" \

-H "X-Authorization: Bearer $OPEN_API_TOKEN" \

-d "{\"device_date\":\"yyyy-MM-dd\"}" \

-o mydir/archive.tar

Windows

curl -X POST ^

https://secureporter.cloudcnm.zyxel.com/open-api/v1/archive-logs/download ^

-H "Content-Type: application/json" ^

-H "X-Authorization: Bearer %OPEN_API_TOKEN%" ^

-d "{\"device_date\":\"yyyy-MM-dd\"}" ^

-o mydir\archive.tar

Remplacez "https://api.example.com/endpoint" avec l'actuel endpoint de l'API et "your_api_token" avec votre token API.

[2] Test avec Python

  • Verifiez l'installation de Python : Pour vérifier si Python est installé, ouvrez votre Command Prompt ou votre Terminal et tapez "python". Si vous recevez une erreur indiquant que Python n'est pas trouvé, vous pouvez l'installer en suivant les instructions disponibles sur le site internet officiel de Python. Assurez-vous d'avoir installé Python 3.8 ou une version plus récente pour utiliser la bibliothèque Requests.
  • Créez et activez un environnement virtuel :
    Créez un répertoire de projet et un environnement virtuel : Suivez la documentation officielle Python venv pour créer votre environnement virtuel dans un répertoire de projet.

macOS

source your-virtual-environment-path/bin/activate

Windows

your-virtual-environment-path\Scripts\activate

Remplacez le chemin d'accès à votre environnement virtuel par le chemin d'accès au répertoire de votre environnement virtuel.

Chaque site peut générer un token API, qui peut être utilisé par plusieurs systèmes ou applications software. Cependant, il y a une restriction d'utilisation de 50 requêtes par heure pour chaque token API.