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.

Avant de commencer

Remarque : Limite de taux de requête : Vous pouvez effectuer jusqu'à 500 requêtes par minute à partir de chaque adresse IP unique. Si vous dépassez cette limite, AppScan affiche un code de statut 403 et une réponse spécifique à votre navigateur.
Important : REST API V4 désormais disponible !

Nous sommes ravis d'annoncer la sortie de l'API REST version 4, qui vous offre des performances et des fonctionnalités améliorées. Cette API est un outil essentiel pour les utilisateurs qui s'appuient sur des scripts d'automatisation pour exécuter diverses tâches sur AppScan on Cloud.

Points clés :

  1. Période de transition : La version actuelle, v2, restera opérationnelle dans les prochains mois. Cependant, nous encourageons les utilisateurs à mettre à jour leurs scripts de manière proactive pour tirer parti des nouvelles fonctionnalités améliorées de l'API V4.

  2. Assistance à la migration : pour faciliter une transition transparente vers l'API mise à jour, reportez-vous à la présentation technique fournie. Elle comprend des informations et des conseils essentiels pour garantir un processus de migration fluide.

  3. Disponibilité de l'API v2 : l'API v2 restera disponible jusqu'au 30 juillet 2024. Cette disponibilité étendue est destinée à donner aux utilisateurs suffisamment de temps pour migrer vers l'API v4. Si vous utilisez l'API via des scripts d'automatisation, assurez-vous qu'un plan de migration est en place pour éviter les perturbations après la date spécifiée.

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. Accédez à votre page Swagger et ajoutez-la aux signets pour référence ultérieure.
  2. Connectez-vous à Swagger avec votre ID HCL.
    1. Développez l'API Account et cliquez sur POST api/v4/Account/ApiKeyLogin afin de développer les détails de l'opération.
      POST API affichant la connexion avec la clé API
    2. Remplacez les paramètres "string" par votre ID de clé API et votre secret de clé API. Conservez les guillemets.
    3. Cliquez sur Exécuter.
    4. Copiez la valeur "Token" qui figure dans la zone Response Body.Corps de la réponse affichant le jeton
    5. Collez-la dans le champ Access token en haut de l'interface utilisateur de Swagger.
      Désormais, le jeton est automatiquement appliqué à tous les appels d'API.
  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 on Cloud 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.