Obtenir des ID par API
Les utilisateurs d'Axe Monitor peuvent générer une clé API dans Axe Account et rechercher les ID nécessaires à l'utilisation d'autres points de terminaison API Axe Monitor, sans utiliser l'interface utilisateur.
En savoir plus sur Premiers pas.
Points de terminaison
| Méthode | Point de terminaison | Objectif |
|---|---|---|
| GET | /lookups/presets |
Récupérer des ID de préréglages pour appliquer un préréglage à une analyse. Et, lorsqu'une analyse est actuellement assignée à un préréglage – voir quels champs peuvent être modifiés. |
| GET | /lookups/teams |
Obtenir les noms et les ID des équipes pour fournir l'accès aux analyses via l'API. |
| GET | /lookups/scans |
Obtenir les noms et les ID des analyses pour obtenir les résultats, modifier ou lancer des analyses. |
| GET | /scans/[scanId]/runs |
Lister toutes les exécutions d'analyse pour une analyse, avec des informations générales sur l'analyse. Vous permet de récupérer runId. |
| GET | /lookups/scan-groups |
Obtenir les noms et les ID des groupes d'analyses pour organiser les analyses via l'API. |
| GET | /lookups/scripts |
Obtenir des ID pour assigner des scripts partagés aux analyses via l'API. |
Préréglages
Vous pouvez appliquer les paramètres de préréglage à une analyse via l'API, mais l'ID et le nom du préréglage sont requis au préalable. Utilisez ce point de terminaison pour les rechercher.
L'ID de préréglage est également nécessaire pour comprendre quels paramètres d'analyse sont modifiables lorsqu'un préréglage est déjà appliqué.
Exemple de requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/presets
X-API-Key: <your_api_key>
Content-Type: application/jsonExemple de réponse
Statut : 200 Succès
{
"presets": [
{ "id": 3, "name": "Gov Baseline" },
{ "id": 1, "name": "Marketing sites" }
]
}Équipes
Vous pouvez attribuer des autorisations d'équipe lors de la création ou de la modification d'une analyse via l'API. Utilisez ce point de terminaison pour rechercher les noms et les ID des équipes.
Exemple de requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/teams
X-API-Key: <your_api_key>
Content-Type: application/jsonExemple de réponse
Statut : 200 Succès
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "Accessibility" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "Web Platform" }
]
}Analyses
Les ID et les noms des analyses sont nécessaires pour obtenir les résultats, modifier et exécuter des analyses. Utilisez ce point de terminaison pour les rechercher.
Exemple de requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scans
X-API-Key: <your_api_key>
Content-Type: application/jsonExemple de réponse
Statut : 200 Succès
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "French Marketing Site" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "My Account Platform" }
]
}Exécutions d'analyse
Les ID des exécutions d'analyse peuvent être récupérés avec ce point de terminaison pour obtenir des données de résultats détaillées.
Exemple de requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>Exemple de réponse
{
"scanRuns": [
{
"runNumber": 1,
"status": "Completed",
"queuedAt": "2025-08-21T06:50:27Z",
"startedAt": "2025-08-21T06:50:37Z",
"completedAt": "2025-08-21T06:51:52Z",
"axeVersion": "4.10.3",
"standard": "WCAG 2.1 AA",
"score": 0,
"issues": {
"total": 392,
"critical": 77,
"serious": 315,
"moderate": 0,
"minor": 0
},
"pages": {
"total": 18,
"completed": 17,
"critical": 17
},
"violationGroups": [
{
"name": "color",
"pageCount": 17
},
{
"name": "forms",
"pageCount": 17
},
{
"name": "name-role-value",
"pageCount": 10
},
{
"name": "parsing",
"pageCount": 1
},
{
"name": "text-alternatives",
"pageCount": 13
}
]
}
]
}Groupes d'analyse
Vous pouvez organiser les analyses par groupes d'analyse lors de la création ou de la modification d'analyses à partir de l'API. Utilisez ce point de terminaison pour rechercher les ID et les noms des groupes d'analyse.
Exemple de requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scan-groups
X-API-Key: <your_api_key>
Content-Type: application/jsonExemple de réponse
Statut : 200 Succès
{
"scanGroups": [
{ "id": 1234, "name": "Marketing" },
{ "id": 1200, "name": "Storefront" }
]
}Scripts partagés
Les scripts partagés qui sont stockés dans la section Administration d'Axe Monitor et utilisés dans plusieurs analyses peuvent être appliqués lors de la création ou de la modification d'analyses via l'API. Utilisez ce point de terminaison pour rechercher les ID des scripts partagés.
Exemple de requête
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scripts
X-API-Key: <your_api_key>
Content-Type: application/jsonExemple de réponse
Statut : 200 Succès
{
"scripts": [
{ "id": 12, "name": "Dismiss cookie banner", "type": "TASK" },
{ "id": 9, "name": "SSO login", "type": "SESSION" }
]
}