Introduction

Notre API est conçue pour interagir avec l'écosystème du portail Field Effect MDR afin de fournir aux clients les données dont ils ont besoin concernant leurs opérations en cours.

L'API s'efforce d'adopter les principes RESTful dans la mesure du possible. Elle utilise des données d'entrée et de sortie au format JSON pour permettre une représentation flexible des objets.

Cet article aborde les thèmes suivants :

• Accéder à la documentation de l'API
• S'authentifier auprès de l'API
• Cas d'utilisation courants

Accéder à la documentation de l'API

Notre API est accessible depuis la section « Assistance » du portail MDR. Vous pouvez y découvrir cette API et l'utiliser.

S'authentifier auprès de l'API

Avant de pouvoir utiliser nos API, vous devez créer une clé API sur le portail MDR.

Une fois que vous disposez de votre clé API, rendez-vous sur la page de documentation de l'API et cliquez sur le bouton « Autoriser ».

La fenêtre d'autorisation s'ouvre. Dans la section api_key (apiKey), saisissez le mot « Bearer », suivi d'un espace, puis de votre clé API, comme indiqué ci-dessous.

Une fois ces informations saisies, cliquez sur Autoriser. 

Vous pouvez désormais fermer la fenêtre d'autorisation et commencer à utiliser l'API.

Cas d'utilisation courants

Notre interface Swagger peut être utilisée pour diverses tâches ; les cas d'utilisation ci-dessous présentent quelques-uns des cas d'utilisation courants de notre API :

• Exportation des données des terminaux :
  • Générer une liste de tous les terminaux, y compris leurs niveaux de risque associés.
• Gestion des terminaux des partenaires :
  • Exporter une liste de tous les terminaux rattachés à un partenaire pour l'ensemble de ses clients.
• Rapports ARO :
  • Créer des rapports pour tous les ARO, ou exporter des ARO spécifiques, en fonction du type ou de l'état (clos/résolu/ouvert).
• Téléchargement des rapports SEAS :
  • Téléchargez tous les rapports SEAS pour des clients individuels ou pour tous les clients d'un partenaire.
• Données sur les clients et les appliances :
  • Les partenaires peuvent télécharger une liste de tous leurs clients, y compris des détails tels que le type d'appliance (physique ou virtuelle) et le type de licence attribuée à chaque client.
• Exportation des informations sur les vulnérabilités : 
  • Exportez toutes les informations sur les vulnérabilités pour tous les terminaux au sein d'une organisation.