Dans cet article, vous apprendrez où est localisé la documentation de l'API et comment l'utiliser.

SOMMAIRE

• Accéder à la documentation de l'API
• Description des méthodes
  • Spécifique à Serenety
  • Spécifique à Yuno
  • Spécifique à l'Audit
  • Spécifique à Phisherman

Accéder à la documentation de l'API

• Se connecter au Portail
• Aller dans le menu Documentation (?)
  
• Cliquer sur le sous-menu API
  

Vous arriverez sur la description des méthodes d'appels à l'API, auto-généré par Swagger.

Qu'est-ce que Swagger ? 

C'est un langage de description d'interface permettant de décrire des API exprimées à l'aide de JSON. Swagger est utilisé avec toute une série d'outils logiciels open source pour concevoir, créer, documenter et utiliser des services Web. 

Description des méthodes

Pour utiliser une route décrit par le Swagger, il faut utiliser l'url https://leportail.xmco.fr/api/

Les routes suivantes sont disponibles :

• /oplog : archivage des logs de toute modification, création, suppression sur le Portail
• /user : liste des utilisateurs (et le détail de votre compte)
• /profile : liste des profils de votre société
• /company : liste des sociétés (et le détail de votre société)
• /scope : liste des périmètres
• /project : liste des abonnements (par produit)
  
• /asset : liste des composants techniques / assets
• /action_plan : le plan d'action associé à un périmètre, un utilisateur ou un asset
• /actionticket : la liste des tickets
• /tracker : la liste des trackers de votre société
• /markdown/preview : pré-visualiser du langage Markdown
• /file : liste des fichiers de la société ou d'un périmètre

Spécifique à Serenety

• /serenetyscope pour les périmètres associés côté Serenety

Spécifique à Yuno

• /advisory : la liste des bulletins
• /tag : les tags associés au bulletin
• /platform : les plateformes (exemple : Java) associées au bulletin
• CVE
  
  • /cve : voir le détail d'une CVE
    
  • /vulndb : rechercher une CVE (produit, vendeur, version)
• CPE
  • /cpename : liste des technologies CPE existantes
  • /followedcpename : liste des technologies CPE suivies par XMCO
  • /followed_vendors : liste des vendeurs suivies par XMCO
    
• /watch : lié au module de veille
  
  • /watch/stats/advisories : rechercher des statistiques par type, nombre ou criticité de bulletin

Spécifique à l'Audit

• /pentest : les audits
• /vulnerability : les vulnérabilités associés à un audit

Spécifique à Phisherman

• /phisherman : avoir accès aux statistiques d'une campagne Phisherman