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/v2/Apps/ImportFile .

Procédure

  1. Accédez à cloud.appscan.com/swagger et ajoutez-le aux signets pour référence ultérieure.
  2. Connectez-vous avec votre ID HCL.
    1. Développez l'API Accounts et cliquez sur POST api/v2/Account/ApiKeyLogin afin de développer les détails de l'opération.
    2. Cliquez sur le texte dans la zone d'édition Example Value afin de copier le texte en tant que demande d'objet JSON dans la zone apiKey.

    3. Remplacez les paramètres "string" par votre nom d'utilisateur et votre mot de passe ID HCL (en conservant les guillemets), puis cliquez sur Try it out!.
    4. Copiez la valeur "Token" se trouvant dans la zone Response Body.

    5. Collez-la dans le champ Access token de l'interface utilisateur de Swagger. Désormais, le jeton sera automatiquement appliqué à tous les appels API.
  3. Créez un groupe de fichiers métadonnées.
    1. Développez l'API Asset Groups et cliquez sur POST /api/v2/AssetGroups.
    2. Dans la section Paramètres cliquez sur le texte se trouvant dans la boîte d'édition Example Value afin de le copier en tant que demande d'objet JSON dans la zone ibmIdModel.
    3. Remplacez les paramètres "string" par un nom et une description du groupe de fichiers métadonnées (en conservant les guillemets), puis cliquez sur Essayez-le !.
      Obtention d'un ID de groupe de fichiers métadonnées
    4. Prenez note de l'ID dans la section Response Body. Vous devrez utiliser cet ID dans le prochain API.
  4. Importez un fichier d'inventaire d'applications.
    1. Développez l'API Applications et cliquez sur POST /api/V2/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 à votre fichier.
    2. Saisissez l' assetGroupId depuis l'étape 3d dans la zone Value de la section Parameters.
    3. Cliquez sur Browse dans la section fileToUpload afin de localiser votre fichier CSV d'applications à importer.
    4. Cliquez sur Try it out!.
    5. Dans la section Response Headers, copiez l'ID se trouvant à la ligne "Location".
      JobID pour l'importation d'applications
    6. Développez l'API POST /api/v2/Apps/ImportJobs/{jobId} .
    7. Entrez l'ID dans le champ jobID et cliquez sur Try it out!.

Résultats

Une importation réussie ressemble à l'exemple ci-dessous :
Importation d'application réussie