Obtenir les paramètres depuis l'API

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Not for use with personal data

Utilisez cette page pour lire les paramètres d'un scan, consulter chaque paramètre que vous pouvez envoyer lors de la création ou de la modification d'un scan, et trouver quels sont les valeurs et les modifications autorisées.

Méthode Point de terminaison Objectif
GET /scans/[scanId]/settings Obtenez les paramètres complets d'un scan.
GET /axe-versions Listez les versions d'axe-core disponibles dans votre instance axe Monitor.
GET /presets Lister les préréglages
GET /presets/[presetId]/editability Listez quels paramètres peuvent être modifiés sur les scans utilisant un préréglage.

Obtenir les paramètres du scan

Renvoie les paramètres complets d'un scan. Vous pouvez renvoyer cette réponse à POST /scans or PATCH /scans/[scanId] sans la modifier.

Exemple de requête

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/settings
X-API-KEY: <your_api_key>

Paramètres requis

Nom Type Description
scanId Entier L'identifiant unique du scan.

Exemple de réponse

Statut : 200 OK

{
  "scanId": 12345,
  "presetId": null,
  "name": "Marketing Site - Production",
  "sites": ["https://www.example.com"],

  "axeCoreVersion": "latest",
  "standardLevel": "wcag22aa",
  "standardOptions": ["best-practice"],
  "customRules": [],
  "enablePdfUa": false,
  "publicShareLink": false,
  "axeReportsUpload": false,
  
  "depth": 3,
  "pageLimit": 100,
  "windowWidth": 1920,
  "windowHeight": 1080,
  "storeScreenshotsFileContent": false,
  "includeErrorPages": false,
  "excludeMimeTypes": [],
  "pdfTarget": -1,
  "pdfModifiedBetween": null,

  "commonComponents": [],
  "templateUris": [],
  "excludeCommonComponents": false,

  "scripts": [],
  "runSessionScriptFirst": false,
  "environmentVariables": [
    { "name": "ENV_API_KEY" }
  ],
  "userAgent": null,
  "referrer": null,
  "sessionEstablishment": {
    "authType": null,
    "authUserName": null
  },

  "restrictToFolder": false,
  "skipSpecificUrls": [],
  "mustHaveAll": [],
  "mustHaveAny": [],
  "mustNotHaveAny": [],
  "ignoreAllParams": false,
  "discardAnchorTags": false,
  "meaningfulParams": [],
  "meaninglessParams": [],

  "longPageOptimized": false,
  "pageWait": 0,
  "dynamicContentActive": false,
  "priority": 2,

  "scanGroups": [
    { "id": 7, "name": "Marketing Sites" }
  ],
  "teams": [
    { "name": "Digital Accessibility Team" }
  ],
  "notifyGroup": false,
  "notifyUsers": []
}

Remarque : Les mots de passe, les keystores et les valeurs des variables d'environnement ne sont jamais renvoyés. Ils sont totalement omis dans la réponse, pas renvoyés comme null. Les variables d'environnement sont listées uniquement par leur nom.

Remarque : presetId est le préréglage appliqué au scan, ou null s'il n'y en a pas. Lorsqu'un préréglage est appliqué, utilisez GET /presets/[presetId]/editability pour voir quels paramètres vous pouvez modifier.

Réponses d’erreur

Code de statut HTTP Description
401 La clé API est manquante ou invalide.
403 Vous n'avez pas accès à ce scan.
404 Le scan n'existe pas.

Paramètres complets du scan disponibles via l'API

Cette section répertorie chaque paramètre de scan que vous pouvez envoyer à POST /scans et PATCH /scans/[scanId], et que GET /scans/[scanId]/settings renvoie. Les paramètres sont regroupés de la même manière que les paramètres de scan dans l'interface utilisateur d'axe Monitor, et l'API accepte les mêmes valeurs que l'interface utilisateur.

Exception : les informations d'identification pour démarrer une session ne sont pas modifiables par l'API pour des raisons de sécurité. Les informations d'identification ne peuvent être modifiées que depuis l'interface utilisateur d'Axe Monitor.

Paramètres généraux (Requis)

Nom Type Description
nom Chaîne Le nom du scan.
sites Chaîne[] Les URL de départ pour le scan. Nécessaire uniquement s'il n'y a pas de scripts sur le scan.

Norme d'accessibilité (Requis)

Nom Type Description
versionAxeCore Chaîne La version d'axe-core avec laquelle effectuer le scan. Utilisez une valeur de version à partir de GET /axe-versions.
niveauStandard Chaîne La norme d'accessibilité à tester, par exemple wcag22aa. Utilisez une valeur des tags de la version axe-core choisie.

Paramètres de base (Optionnels)

Nom Type Par défaut Description
optionsStandard Chaîne[] [] Jeux de règles supplémentaires à inclure. Actuellement, seule la meilleure pratique est prise en charge.
règlesPersonnalisées Tableau [] Ajouter des phrases ou des mots à utiliser avec le paramètre Rechercher du texte.
activerPdfUa Booléen faux Vérifier les PDF par rapport à PDF/UA.
lienPartagePublic Booléen faux Créer un lien de partage public pour les résultats de l'analyse.
téléchargementRapportsAxe Booléen faux Envoyer les résultats de l'analyse aux rapports Axe.

Portée de l'analyse (Facultatif)

Nom Type Par défaut Description
profondeur Entier [] Combien de niveaux de liens à explorer à partir des URL de départ.
limiteDesPages Entier [] Le nombre maximum de pages analysées à chaque exécution.
largeurFenêtre Entier 1920 Largeur de la fenêtre du navigateur, en pixels.
hauteurFenêtre Entier 1080 Hauteur de la fenêtre du navigateur, en pixels.
enregistrerCapturesÉcran Booléen faux Enregistrer les captures d'écran avec les résultats de l'analyse.
enregistrerContenuFichiers Booléen faux Enregistrer la source complète de la page avec les résultats de l'analyse.
inclurePagesErreur Booléen faux Inclure les pages qui renvoient un statut d'erreur HTTP.
exclureTypesMime Chaîne[] [] Types de fichiers à ignorer lors de l'exploration, par exemple application/pdf.
ciblePdf Entier -1 La cible de l'analyse des PDF. -1 désactive l'analyse des PDF. Ne peut pas être utilisé lorsque application/pdf est dans exclureTypesMime.
pdfModifiéDepuis Objet ou null null Analyser uniquement les PDF modifiés après une certaine date.
pdfModifiéJusqu'à Objet ou null null Analyser uniquement les PDF modifiés avant une certaine date.

Composants Communs (Facultatif)

Nom Type Par défaut Description
composantsCommuns Tableau [] Définitions de composants partagées appliquées sur l'ensemble des pages.
urisModèles Chaîne[] [] URL utilisée pour détecter et consolider les composants communs.
exclureComposantsCommuns Booléen faux Ne pas inclure les résultats des composants communs dans les décomptes de problèmes.

Récupération et Session (Optionnel)

Nom Type Par défaut Description
scripts Tableau [] Scripts de tâches et de sessions. Chaque script a { "name", “id”, "contents", "shared", "mimeType" }.
runSessionScriptFirst Booléen faux Exécutez le script de session avant les scripts de page.
environmentVariables Tableau [] Variables disponibles pour les scripts. Chaque entrée est { "name" }. Les valeurs ne peuvent pas être modifiées et ne sont pas incluses dans les réponses pour des raisons de sécurité.
userAgent Chaîne ou null null Remplacer la chaîne de l'agent utilisateur du navigateur.
referrer Chaîne ou null null La valeur de l'en-tête HTTP Referer à envoyer.
sessionEstablishment.authType Chaîne ou null null La méthode de connexion, par exemple basique ou keystore.
sessionEstablishment.authUserName Chaîne ou null null Le nom d'utilisateur utilisé pour se connecter.
sessionEstablishment.script Objet [] Renvoi lorsqu'un script d'authentification est présent dans l'analyse. Chaque script a { "id", “name”, "contents", "mimeType", "shared" }.
sessionEstablishment.script.id Entier 0 Renvoi lorsqu'un script d'authentification est présent dans l'analyse. Pour ajouter un script partagé lors de l'utilisation des points de terminaison Create ou Edit Scan, allez dans Admin → Scripts partagés dans l'interface utilisateur Axe Monitor. Modifiez un script et récupérez l'ID à partir de l'URL dans la barre d'adresse : https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
sessionEstablishment.script.name Chaîne [] Nom du fichier script d'authentification appliqué à l'analyse.
sessionEstablishment.script.contents Chaîne [] Contenu du script d'authentification appliqué à l'analyse.
sessionEstablishment.script.mimeType Chaîne [] Type de fichier du script appliqué à l'analyse.
sessionEstablishment.script.shared Booléen faux Vrai indique que le script est un script partagé disponible dans la section Admin de Axe Monitor.

Portée URL (Optionnel)

Nom Type Par défaut Description
restrictToFolder Booléen faux Ne récupérer que les URL sous le chemin de l'URL de départ.
domains Chaîne[] [] Limiter l'analyse à ces domaines et à leurs sous-répertoires. Les liens vers d'autres domaines ne sont pas suivis. Dérivé de la valeur « sites ». Par défaut, seuls les domaines dans le champ « sites » sont analysés.
skipSpecificUrls Chaîne[] [] Modèles d'URL à exclure de la récupération.
mustHaveAll Chaîne[] [] Analyser uniquement les URL contenant toutes ces chaînes de texte.
mustHaveAny Chaîne[] [] Analyser uniquement les URL contenant au moins une de ces chaînes de texte.
mustNotHaveAny Chaîne[] [] Ignorer les URL contenant l'une de ces chaînes de texte.
ignoreAllParams Booléen faux Traiter les URL qui diffèrent uniquement par les paramètres de requête comme la même page. Lorsque c'est vrai, meaningfulParams et meaninglessParams doivent être vides.
discardAnchorTags Booléen faux Traiter les URL qui diffèrent uniquement par leur fragment # comme la même page.
meaningfulParams Chaîne[] [] Paramètres de requête qui rendent une URL une page distincte.
paramsSansSignification Chaîne[] [] Paramètres de requête à ignorer pour déterminer si deux URLs sont la même page.

Optimisation (Optionnel)

Nom Type Par défaut Description
pageLongueOptimisée Booléen faux Attendre avant de scanner chaque page. Définir le temps d'attente avec pageWait.
pageAttente Entier 0 Durée d'attente avant de scanner chaque page, en millisecondes. Plage autorisée : de 0 à 120000.
attenteToutesPages Booléen vrai Applique pageWait à chaque page du scan. Lorsqu'il est faux, il ne s'applique qu'aux URLs dans waitPageUrls.
attentePageURLs Chaîne[] [] Les URLs auxquelles pageWait s'applique lorsque attenteToutesPages est faux.
contenuDynamiqueActif Booléen faux Attendre que le contenu dynamique, tel que les animations, composants chargés paresseusement et médias intégrés, se charge avant de scanner chaque page. Définir le temps d'attente avec attenteContenuDynamique.
attenteContenuDynamique Entier 0 Durée d'attente pour le contenu dynamique avant de scanner chaque page. Utilisé lorsque contenuDynamiqueActif est vrai.
priorité Entier 2 La position du scan dans la file d'attente. Plage autorisée : de 1 (plus haute) à 3 (plus basse).

Fréquence de la Planification (Requis pour les scans planifiés)

Nom Type Description
planification Objet Contient l'option pour des scans manuels (ponctuels) ou planifiés, et les détails si le scan est planifié. Chaque planification comprend { "typeFréquence", « intervalleFréquence », "donnéesFréquence", "dateDébut", "heureDébut", « dateFin », « occurrencesMax », « délaiMinutes », « fuseauHoraire .» } . Envoyer null supprime la planification.
planification.typeFréquence Chaîne Requis avec les scans planifiés. Fréquence de répétition du scan. Manuel crée un scan sans planification. Semaine crée des scans hebdomadaires, et Mois crée un scan mensuel. M_DoW vous permet de lancer un scan mensuel un certain jour de la semaine.
planification.intervalleFréquence Entier Requis avec les scans planifiés. Nombre de périodes à attendre entre les lancements (Week ou Month) . Par exemple, 2 signifie toutes les 2 semaines ou mois.
planification.donnéesFréquence Chaîne (en JSON) Quels jours le scan est exécuté. La valeur est du JSON écrit en tant que chaîne, et ce qui va à l'intérieur dépend de frequencyType. Semaine : Tableau JSON avec les jours de la semaine à exécuter. Exemple : "[1,3]" exécute chaque lundi et mercredi. Mois : Objet JSON avec la date à exécuter chaque mois. Un numéro de jour, la chaîne « First », ou la chaîne « Last ». First et Last sont sensibles à la casse. Exemple : "{\"dayOfMonth\":15}" exécute le 15e. M_DoW : Objet JSON avec un jour de la semaine et lequel dans le mois. Exemple : "{\"weekOfMonth\":2,\"dayOfWeek\":2}" exécute le deuxième mardi. Utilisez weekOfMonth: 5 pour la dernière semaine du mois, donc "{\"weekOfMonth\":5,\"dayOfWeek\":5}" est le dernier vendredi de chaque mois. Les jours sont numérotés de 1 = lundi à 7 = dimanche.

Détails de Planification (Requis pour les scans planifiés)

Nom Type Description
planification.dateDébut Date Requis. Date du premier lancement, comme YYYY-MM-DD.
planification.heureDébut Heure-locale Requis. Heure locale. chaque lancement débute, sous la forme 24 heures HH:mm:ss, donc 14:30 est 14:30:00 (24 heures supposées). Interprété dans timeZone.
planification.dateFin Date Date de fin de la planification. Définir soit ceci soit maxOccurrences, pas les deux.
planification.occurrencesMax Entier Nombre de lancements après lequel la planification se termine. Définir soit ceci soit endDate, pas les deux.
planification.délaiMinutes Entier Durée maximale en minutes d'un scan, après laquelle il s'arrête automatiquement. Utile lorsqu'un site empêche la fin d'un scan (comme une URL redirigeant infiniment) ou lorsque de nombreux scans volumineux s'exécutent en même temps. S'il n'est pas présent, il n'y a pas de délai.
planification.fuseauHoraire Chaîne Nom du fuseau horaire IANA, tel que America/New_York. (Toutes les options de fuseaux horaires)

Équipes et Partage (Optionnel)

Nom Type Par défaut Description
groupesScan Objet[] [] Les groupes de balayage auxquels le scan appartient. Chaque entrée est { “id”, "nom" }.
scanGroups.id Chaîne [] Identifiants des groupes de balayage auxquels le scan appartient.
scanGroups.name Chaîne [] Noms des groupes de balayage auxquels le scan appartient.
équipes Objet[] [] Équipes avec accès au scan. Chaque entrée est { “id”, "nom", “niveauAccès” }.
teams.id Chaîne [] Identifiants des équipes ayant accès au scan.
teams.name Chaîne [] Noms des équipes ayant accès au scan.
teams.accessLevel Chaîne [] L'accès “viewer” offre l'accès Visionneur de scan pour l'équipe correspondante. L'accès “member” offre l'accès Membre de scan, et “admin” offre l'accès Administrateur de scan.
scanGroups.id Chaîne [] ID des groupes de balayage. Pour ajouter des groupes de balayage lors de l'utilisation des points de terminaison Créer ou Modifier un scan, accédez à Admin → Groupes de balayage dans l'interface utilisateur de Axe Monitor. Modifiez un script et récupérez l'ID dans l'URL de la barre d'adresse : https://yourcompany-axemonitor.dequecloud.com/monitor/admin/scripts/[ID]/edit
scanGroups.name Chaîne [] Nom des groupes de balayage
scanGroups.accessLevel Chaîne [] “viewer”, “member”, ou “admin”
notifierGroupe Booléen faux Envoyer un email aux membres du groupe de balayage lorsqu'une exécution se termine.
notifierUtilisateurs Tableau [] Utilisateurs spécifiques à notifier par email lorsque une exécution se termine.

Paramètres en lecture seule

GET /scans/[scanId]/settings renvoie également ceux-ci. Ils sont ignorés si vous les envoyez via POST ou PATCH.

Nom Type Description
scanId Entier L'identifiant unique du scan.
presetId Entier ou nul Le préréglage appliqué au scan, ou nul s'il n'y en a pas.
scanGroups[].id Entier L'identifiant unique de chaque groupe de balayage.

Exemple de réponse

{
  "scanId": 0,
  "name": "string",
  "sites": [
    "string"
  ],
  "axeCoreVersion": "string",
  "standardLevel": "string",
  "standardOptions": [
    "string"
  ],
  "enablePdfUa": true,
  "depth": 0,
  "pageLimit": 0,
  "axeReportsUpload": true,
  "publicShareLink": true,
  "includeErrorPages": true,
  "storeFileContent": true,
  "storeScreenshots": true,
  "pdfModifiedFromDate": "2026-11-03",
  "pdfModifiedToDate": "2026-11-03",
  "pdfTarget": 0,
  "scanGroups": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "teams": [
    {
      "id": "string",
      "name": "string",
      "accessLevel": "viewer"
    }
  ],
  "schedule": {
    "frequencyType": "Manual",
    "frequencyInterval": 0,
    "frequencyData": "string",
    "startDate": "2026-11-03",
    "startTime": "string",
    "endDate": "2026-11-03",
    "maxOccurrences": 0,
    "timeoutMinutes": 0,
    "timeZone": "string"
  },
  "scripts": [
    {
      "id": 0,
      "name": "string",
      "contents": "string",
      "mimeType": "string",
      "shared": true
    }
  ],
  "runSessionScriptFirst": true,
  "userAgent": "string",
  "referrer": "string",
  "sessionEstablishment": {
    "authType": "basic",
    "authUserName": "string",
    "script": {
      "id": 0,
      "name": "string",
      "contents": "string",
      "mimeType": "string",
      "shared": true
    }
  },
  "restrictToFolder": true,
  "skipSpecificUrls": [
    "string"
  ],
  "mustHaveAll": [
    "string"
  ],
  "mustHaveAny": [
    "string"
  ],
  "mustNotHaveAny": [
    "string"
  ],
  "ignoreAllParams": true,
  "discardAnchorTags": true,
  "meaningfulParams": [
    "string"
  ],
  "meaninglessParams": [
    "string"
  ],
  "domains": [
    "string"
  ],
  "excludeMimeTypes": [
    "string"
  ],
  "longPageOptimized": true,
  "pageWait": 0,
  "dynamicContentActive": true,
  "dynamicContentWait": 0,
  "waitAllPages": true,
  "waitPageUrls": [
    "string"
  ],
  "headlessMode": true,
  "eagerStrategy": true,
  "windowWidth": 0,
  "windowHeight": 0,
  "priority": 1,
  "templateUris": [
    "string"
  ],
  "commonComponents": [
    {
      "id": 0,
      "name": "string",
      "selectors": [
        "string"
      ]
    }
  ],
  "excludeCommonComponents": true,
  "customRules": [
    {
      "ruleId": "find-text",
      "options": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "notifyGroup": true,
  "notifyUsers": [
    "string"
  ],
  "presetId": 0,
  "draft": true
}

Lister les versions axe-core

Renvoie les versions axe-core disponibles dans votre instance Axe Monitor, et les normes que chacune supporte. Axe Monitor ne détecte pas automatiquement les nouvelles versions axe-core, donc utilisez ce point de terminaison pour voir quelles versions vous pouvez définir comme axeCoreVersion d'un scan.

Exemple de requête

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/axe-versions
X-API-Key: <your_api_key>

Exemple de réponse

Statut : 200 OK

{
  "versions": [
    {
      "version": "latest",
      "supported": true,
      "tags": [
        "wcag22a", "wcag22aa", "wcag22aaa",
        "wcag21a", "wcag21aa", "wcag21aaa",
        "wcag2a", "wcag2aa", "wcag2aaa",
        "section508", "EN-301-549", "TTv5", "RGAAv4",
        "best-practice"
      ]
    },
    {
      "version": "4.12.1",
      "supported": true,
      "tags": [
        "wcag22a", "wcag22aa", "wcag22aaa",
        "wcag21a", "wcag21aa", "wcag21aaa",
        "wcag2a", "wcag2aa", "wcag2aaa",
        "section508", "EN-301-549", "TTv5", "RGAAv4",
        "best-practice"
      ]
    }
  ],
  "default": "latest"
}

Champs de réponse

Nom Type Description
versions Tableau Les versions axe-core disponibles dans votre instance.
versions[].version Chaîne L'identifiant de la version. Utilisez cette valeur comme axeCoreVersion d'un scan.
versions[].supported Booléen Indique si la version est actuellement prise en charge.
versions[].tags Chaîne[] Les normes et ensembles de règles que cette version supporte. Utilisez ces valeurs pour standardLevel et standardOptions d'un scan.
défaut Chaîne La version axe-core par défaut pour votre instance.

Obtenir l'éditabilité des préréglages

Renvoie quels paramètres peuvent être modifiés sur les scans utilisant un préréglage. Vérifiez cela avant d'envoyer PATCH /scans/[scanId]/settings à un scan avec un préréglage, afin de savoir quels paramètres il acceptera.

Pour trouver le préréglage d'un scan, lisez presetId à partir de GET /scans/[scanId]/settings. Pour trouver d'autres ID de préréglages, allez dans l'interface utilisateur de Axe Monitor et naviguez vers Admin → Préréglages. Modifiez votre préréglage souhaité. Copiez l'ID à partir de l'URL dans la barre d'adresse : https://yourcompany-axemonitor.dequecloud.com/monitor/admin/presets/[ID]/edit

Exemple de requête

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/presets/[presetId]/editability

X-API-KEY: <your_api_key>

Paramètres requis

Nom Type Description
presetId Entier L'identifiant unique du préréglage.

Exemple de réponse

Statut : 200 OK

{
  "presetId": 42,
  "fields": {
    "name": true,
    "depth": false,
    "pageLimit": false,
    "axeCoreVersion": false
  }
}

Champs de réponse

Nom Type Description
presetId Entier L'identifiant unique du préréglage.
champs Objet Chaque clé est un nom de paramètre de Paramètres de balayage avancés. true signifie que vous pouvez le modifier sur les balayages qui utilisent ce préréglage ; false signifie que le préréglage le verrouille.

Envoyer un paramètre verrouillé avec une nouvelle valeur renvoie 400 field_locked_by_preset. L'envoyer avec sa valeur actuelle réussit et ne change rien.

Réponse d'erreur

Nom Type
401 La clé API est manquante ou invalide.
403 Vous n'avez pas accès à ce préréglage.
404 Le préréglage n'existe pas.

Is this page helpful?

Help us improve this page

Still need help?