S'authentifier
Créez une clé dans les paramètres. Elle n'est affichée qu'une fois. Envoyez-la dans X-Api-Key à chaque requête.
curl https://api.a11ysignal.com/v1/sites \ -H "X-Api-Key: a11y_xxxxxxxxxxxxxxxxxxxxxxxx"
Une clé est limitée à un espace de travail et y dispose des droits d'administration. La révoquer prend effet immédiatement.
Points d'accès
?siteId= restreint la liste.historique ?impact=critical&ruleId=color-contrastpaginéFaire échouer une build sur une régression
Deux façons. La plus simple ne demande aucune clé d'API — exécutez l'analyseur directement en CI sur un déploiement de prévisualisation :
npx @a11ysignal/scan https://preview.example.com \ --max-pages 25 --fail-on serious
L'autre déclenche une analyse hébergée après le déploiement et attend le verdict, pour que le résultat entre aussi dans l'historique de votre tableau de bord :
SCAN=$(curl -sX POST https://api.a11ysignal.com/v1/sites/$SITE_ID/scan \ -H "X-Api-Key: $A11YSIGNAL_KEY" | jq -r .id) # Interroger jusqu'à la fin, puis lire le verdict. until [ "$(curl -s https://api.a11ysignal.com/v1/scans/$SCAN \ -H "X-Api-Key: $A11YSIGNAL_KEY" | jq -r .status)" != "running" ]; do sleep 5; done curl -s https://api.a11ysignal.com/v1/scans/$SCAN -H "X-Api-Key: $A11YSIGNAL_KEY" \ | jq -e '.counts.critical == 0 and .counts.serious == 0'
Les formes que vous recevrez
Un détail d'analyse, réduit aux champs les plus utilisés :
{
"id": "cm...",
"status": "completed",
"startUrl": "https://example.com/",
"score": 87.4,
"counts": { "critical": 0, "serious": 9, "moderate": 2, "minor": 0 },
"pagesScanned": 24,
"pagesFailed": 0,
"axeVersion": "4.13.0",
"diff": {
"newIssues": [{ "url": "…/checkout", "ruleId": "label", "impact": "critical", "count": 2 }],
"fixedIssues": [{ "url": "…/", "ruleId": "image-alt", "impact": "critical", "count": 5 }],
"scoreDelta": -3.5
},
"ruleSummary": [
{ "ruleId": "color-contrast", "impact": "serious", "elements": 9, "pages": 4 }
]
}score vaut null quand une exploration n'a lu aucune page — une URL de départ en 404, ou un robots.txt qui interdit tout. Traitez cela comme un échec, pas comme une réussite ; l'analyse elle-même est marquée failed avec un motif.