Dans cet article, vous aurez accès à des scripts qui récupèrent et accèdent à des données Portail via l'API à travers des exemples d'utilisations.

SOMMAIRE

• Télécharger les fichiers
  • Préambule
    • Description 
    • Installation 
    • Authentification
    • Liste des scripts disponibles
  • Téléchargement

Télécharger les fichiers

Préambule

Description 

Ce projet vise à fournir des exemples simples de scripts pour interagir avec l'API du portail CERT-XMCO.
11 scripts écrits en Python sont ainsi mis à disposition couvrant un large éventail des fonctionnalités de l'API afin de :

• apprendre à s'authentifier ;
• d'obtenir des informations sur la veille (périmètres, tous les bulletins ou bulletins filtrés)
• d'obtenir des informations sur Serenety (périmètres, assets et leurs propriétés)
• obtenir des informations sur les tickets d'action (de toute l'entreprise, qui me sont attribués ou qui sont associés à un module spécifique ou à un périmètre spécifique)
• mettre à jour les tickets d'action.

Installation 

Pour utiliser les scripts, vous avez besoin d'un environnement Python 3.

Une fois le projet récupéré, il faudra utiliser la commande suivante pour installer les quelques dépendances :

pip install -r requirements.txt

Chaque script peut être exécuté séparément.

Pour des raisons de présentation, plusieurs scripts ont une valeur fixe pour le champ d'application ou le ticket `_id`. N'oubliez pas de modifier ces valeurs lors du premier lancement du script.

Authentification

• La clé API peut être obtenue comme décrit dans la documentation : https://leportail.xmco.fr/doc/api ;
• Votre clé API doit être ajoutée dans le fichier `const.py` (variable `API_KEY`) ;
• Nous recommandons l'utilisation d'un compte de service dédié lorsqu'il est utilisé en mode production ;

Liste des scripts disponibles

• `1.get_watch_advisories.py`: pour obtenir tous les bulletins de veille récents
• `2.get_watch_scope.py`: pour obtenir toutes les informations sur les périmètres Yuno créés
• `3.get_watch_advisories_by_scope.py`: pour obtenir tous les bulletins de veille filtrés sur un ou plusieurs périmètres
• `4.get_serenety_scope.py`: pour obtenir tous les périmètres Serenety
• `5.get_serenety_assets.py`: pour obtenir tous les assets Serenety créés, y compris leurs propriétés (SSLLABS, ports ouverts, etc...)
• `6.get_tickets_company.py`: pour récupérer tous les tickets d'action Yuno, les recommendations Audit, les alertes Serenety créés
• `7.get_tickets_assigned_to_me.py`: pour récupérer tous les tickets d'actions qui vous sont assignés
• `8.get_tickets_by_module.py`: pour récupérer tous les tickets d'actions, filtrés par modules (Serenety, Yuno, Audit)
• `9.get_ticket_by_scope.py`: pour récupérer tous les tickets d'actions, filtrés par périmètres
• `10.update_ticket.py`: pour modifier et mettre à jour une alerte Serenety ou un ticket d'action Yuno, ou une recommendation Audit
• `11.update_status_serenety_ticket.py`: pour apprendre comment marquer une alerte Serenety comme résolue
• `12.send_ticket_to_the_hive.py`: pour transmettre les tickets d'actions créés la dernière heure à The Hive (outil de ticketing externe)
  • (AUTH_HIVE_TOKEN et THE_HIVE_CREATE_ENDPOINT sont des variables à configurer et à mettre à jour dans const.py)

Téléchargement

Les fichiers sont disponibles ici : leportail-api-demo.zip.