API REST

L'interface d'API REST intégrée vous permet de visualiser les services Web RESTful. La documentation API est élaborée à l'aide de Swagger. Vous pouvez y tester des opérations API et consulter instantanément les résultats afin d'examiner vos applications plus rapidement.

Pourquoi et quand exécuter cette tâche

Apprenez à utiliser l'infrastructure interactive en suivant cet exemple pour importer un inventaire d'applications en utilisant l'API REST /api/v4/Apps/ImportFile.

Procédure

  1. Sélectionnez Outils > API.
  2. Cliquez sur le lien Swagger sur le côté droit de la page. Vous êtes automatiquement connecté à Swagger.
  3. Créez un groupe d'actifs :
    1. Développez l'API Groupes de fichiers métadonnées et cliquez sur POST /api/v4/AssetGroups.
    2. Remplacez les paramètres "string" par un nom et une description pour le groupe d'actifs. Conservez les guillemets.Création d'une API de groupe d'actifs
    3. Cliquez sur Exécuter.
    4. Prenez note de l'identifiant dans la section Corps de la réponse ; vous aurez besoin de l'utiliser pour accéder à l'API suivante.
      Copiez l'ID à partir du corps de la réponse.
  4. Importez un fichier d'inventaire d'applications :
    1. Développez l'API Applications et cliquez sur POST /api/v4/Apps/ImportFile.
      La section Implementation contient un exemple de fichier que vous pouvez télécharger pour obtenir une notion des types d'attributs à inclure dans votre fichier.
    2. Saisissez l'assetGroupId de l'étape 3d dans le champ Value de la section Paramètres.
    3. Cliquez sur Parcourir dans la section uploadedFile afin de localiser votre fichier CSV d'applications à importer.
    4. Cliquez sur Exécuter.
      Une importation réussie s'affiche comme suit :Importation d'application réussie

Exemple

Importation de fichiers d'examen, y compris les résultats à l'aide de l'API REST
Vous pouvez importer un fichier d'examen, y compris les résultats, sans exécuter l'examen dans AppScan 360° en procédant comme suit :
  1. Assurez-vous d'être connecté à Swagger à l'aide de l'API : api/V4/Account/ApiKeyLogin.
  2. Téléchargez le fichier d'examen à l'aide de l'API : api/V4/FileUpload et enregistrez l'ID de fichier pour plus tard. Par exemple,

    "FileId": "274bd3a7-a231-41d0-80f6-d22d684af50d"

  3. Développez l'API Examens et cliquez sur POST /api/v4/Scans/Dast. Mettez à jour les paramètres suivants pour générer uniquement les rapports sans exécuter l'examen.
    1. ScanOrTemplateFileId : Mettez à jour l'ID de fichier que vous avez copié à l'étape 2.

      "ScanOrTemplateFileId": "274bd3a7-a231-41d0-80f6-d22d684af50d"

    2. TestOperation : Définissez sur ReportOnly

      "TestOperation": "ReportOnly"

    Remarque : Assurez-vous d'avoir mappé l'AppID, ScanName et les autres paramètres requis pour exécuter l'API POST /API/V4/Scans/DAST.