Axe Developer Hub API's
Een overzicht van de beschikbare REST API's voor Axe Developer Hub
Not for use with personal data
Axe Developer Hub stelt een reeks REST API's beschikbaar die je kunt aanroepen met je bestaande Axe Account API-sleutel: er zijn geen aparte inloggegevens nodig voor een van deze. Gebruik ze om CI/CD-pijplijnen op toegankelijkheidsstatus te baseren, toegankelijkheidsresultaten programmeermatig op te halen en je projecten te creëren, beheren en bekijken.
Welke API Heb Ik Nodig?
| Ik wil... | Gebruik... |
|---|---|
| Authenticatie instellen, een project-ID vinden en een eerste oproep doen | Aan de slag met de Axe Developer Hub API's |
| Projecten en hun leden beheren en creëren, je projecten opsommen of een project-ID op naam opzoeken | Projecten API Referentie |
| Projectcreatie en lidmaatschapsbeheer stap voor stap automatiseren | Aan de slag met Project Management Automatisering |
| Een pull request of commit afkeuren wanneer toegankelijkheidsfouten worden gevonden, vanuit een niet-GitHub CI/CD-pijplijn (GitLab, BitBucket en vergelijkbare) | Commit Status API Referentie |
| Hetzelfde doen vanuit een GitHub-pijplijn | Gebruik de GitHub Actie in plaats van de REST API rechtstreeks aan te roepen |
| Volledige toegankelijkheidsresultaten voor een sessie ophalen, of de sessies van een project opsommen | Sessies en Resultaten API Referentie |
| Een samenvattend rapport downloaden zoals oudere integraties doen | Resultaten Programmatically Ophalen (Verouderd): stap over naar de Sessies en Resultaten API |
Authenticatie, in één oogopslag
Elke API op deze lijst authenticeert op dezelfde manier, met je Axe Account API-sleutel in een X-API-Key-header. Zie Aan de slag met de Axe Developer Hub API's om een sleutel te krijgen, je project-ID te vinden en je eerste oproep te doen.
