API dell'Hub degli Sviluppatori Axe
Una panoramica delle API REST disponibili per l'Hub degli Sviluppatori Axe
Not for use with personal data
L'Hub degli Sviluppatori Axe espone un insieme di API REST che puoi chiamare con la tua chiave API dell'account Axe esistente: non è necessaria nessuna credenziale separata per nessuna di esse. Usale per delimitare i pipeline CI/CD sullo stato di accessibilità, recuperare i risultati di accessibilità in modo programmato, e creare, gestire e cercare i tuoi progetti.
Quale API Mi Serve?
| Voglio... | Usare... |
|---|---|
| Impostare l'autenticazione, trovare un ID progetto e fare una prima chiamata | Inizia con le API dell'Hub degli Sviluppatori Axe |
| Creare e gestire progetti e i loro membri, elencare i tuoi progetti o cercare un ID progetto per nome | Riferimento API dei Progetti |
| Automatizzare la creazione del progetto e la gestione dei membri, passo dopo passo | Inizia con l'Automazione della Gestione dei Progetti |
| Bloccare una pull request o un commit quando vengono trovati errori di accessibilità, da un pipeline CI/CD non-GitHub (GitLab, BitBucket e simili) | Riferimento API dello Stato del Commit |
| Fare lo stesso da un pipeline GitHub | Usa l'Azione GitHub invece di chiamare direttamente l'API REST |
| Recuperare i risultati di accessibilità completi per una sessione, o elencare le sessioni di un progetto | Riferimento API delle Sessioni e dei Risultati |
| Scaricare un rapporto di sintesi come facevano le integrazioni più vecchie | Ottieni i Risultati Programmati (Deprecato): migra invece all'API delle Sessioni e dei Risultati |
Autenticazione, in Sintesi
Ogni API di questo elenco si autentica nello stesso modo, con la tua chiave API dell'account Axe in un'intestazione X-API-Key. Vedi Inizia con le API dell'Hub degli Sviluppatori Axe per ottenere una chiave, trovare il tuo ID progetto e fare la tua prima chiamata.
