Documentation complète de l'API REST. Tous les points d'accès renvoient du JSON. Les API du tableau de bord utilisent les cookies de session ; l'API CI/CD utilise des clés d'API.
Business inclut les clés d'API, la CLI, les outils MCP authentifiés et l'intégration CI/CD. Les propriétaires et administrateurs de l'organisation peuvent créer des clés. Free n'inclut pas les clés d'API ; l'outil MCP public scan_url reste disponible sans clé.
Authentification
API du tableau de bord (/api/*)
Authentification automatique par le cookie de session Supabase, dans le navigateur.
API CI/CD (/api/v1/*)
Transmettez votre clé d'API dans un en-tête :
x-api-key: ap_live_abc123...
Ou, de façon équivalente, au moyen d'un jeton Bearer :
Authorization: Bearer ap_live_abc123...
Analyse CI/CD
POST /api/v1/scan
Déclencher une analyse d'accessibilité depuis votre chaîne d'intégration continue.
Paramètre
Type
Obligatoire
Description
url
chaîne
Oui
URL du site (doit correspondre à un site enregistré)
threshold
nombre
Non
Score minimal pour réussir (0-100)
wait
booléen
Non
Bloquer jusqu'à l'achèvement (5 min maximum)
max_pages
nombre
Non
Remplacer la limite de pages
GET /api/v1/scan?id={scanId}
Interroger l'état et les résultats d'une analyse.
Clés d'API
Méthode
Point d'accès
Description
GET
/api/api-keys
Lister les clés (empreintes masquées)
POST
/api/api-keys
Créer une clé (clé complète affichée une seule fois)
DELETE
/api/api-keys?id={id}
Révoquer une clé
Sites
Méthode
Point d'accès
Description
GET
/api/sites
Lister tous les sites
POST
/api/sites
Ajouter un site
GET
/api/sites/{id}
Obtenir la fiche d'un site
PATCH
/api/sites/{id}
Mettre à jour un site
DELETE
/api/sites/{id}
Supprimer un site
POST
/api/sites/{id}/verify
Vérifier la propriété
Analyses
Méthode
Point d'accès
Description
GET
/api/scans
Lister les tâches d'analyse
POST
/api/scans
Déclencher une analyse manuelle
GET
/api/scans/{id}
Détails d'une analyse
GET
/api/scans/{id}/pages
Résultats page par page
Non-conformités
Méthode
Point d'accès
Description
GET
/api/violations
Lister les non-conformités (filtrables)
GET
/api/violations/{id}
Détails d'une non-conformité (captures d'écran, état du flux de travail)
PATCH
/api/violations/{id}
Mettre à jour le statut (open, in progress, resolved, suppressed, accepted exception), définir une personne responsable, ou joindre un motif de masquage ou d'exception
POST
/api/violations/{id}/fix
Générer une suggestion de correction par IA
GET
/api/violations/{id}/comments
Lister les commentaires d'une non-conformité
POST
/api/violations/{id}/comments
Ajouter un commentaire
GET
/api/violations/{id}/events
Obtenir l'historique des événements du flux de travail
GET
/api/export/ai-instructions
Télécharger les instructions de correction par IA (Markdown)
Rapports
Méthode
Point d'accès
Description
GET
/api/vpats
Lister les projets de documents fondés sur le format VPAT
POST
/api/vpats
Générer un projet de document fondé sur le format VPAT
GET
/api/vpats/{id}
Détails d'un projet de document
GET
/api/vpats/{id}/pdf
Télécharger le projet de document au format PDF
POST
/api/statements
Publier une déclaration d'accessibilité
GET
/api/certificates?site_id={id}
Générer un récapitulatif des éléments issus de l'analyse automatisée (nom de point d'accès hérité)
Partage
Méthode
Point d'accès
Description
POST
/api/shared-reports
Créer un lien de rapport partageable (expiration à 30 jours)
GET
/api/shared-reports
Lister les liens partagés actifs d'un site
DELETE
/api/shared-reports?id={id}
Révoquer un lien partagé
Organisations
Méthode
Point d'accès
Description
GET
/api/organizations
Lister vos organisations
POST
/api/organizations
Créer une organisation
POST
/api/organizations/switch
Changer d'organisation active
POST
/api/organizations/leave
Quitter une organisation
POST
/api/organizations/transfer
Transférer la propriété
POST
/api/organizations/delete
Supprimer une organisation (propriétaire, adresse vérifiée)
Équipe et réglages
Méthode
Point d'accès
Description
GET
/api/team
Lister les membres
POST
/api/team
Inviter un membre
DELETE
/api/team?id={id}
Retirer un membre
GET
/api/audit-log
Consulter le journal d'audit (administrateur ou propriétaire)
GET
/api/settings
Obtenir les réglages de l'organisation
PATCH
/api/settings
Mettre à jour les réglages de l'organisation
Webhooks
Chaque organisation dispose d'une URL de webhook sortant unique et d'un secret de signature. Configurez les deux avec PATCH /api/settings (champs webhook_url et webhook_secret) ; obtenez la configuration en cours avec GET /api/settings. Pour désactiver l'envoi, définissez l'URL ou le secret sur une chaîne vide. Voir Webhooks pour la forme des charges utiles, les événements pris en charge et la vérification de la signature.