wcagc
Opprett konto
Produksjons-API

Kjør tilgjengelighetssjekker fra din egen arbeidsflyt

Bruk en organisasjons-API-nøkkel med begrenset omfang for å starte skanninger av enkeltsider eller hele nettsteder og lese stabile, strukturerte resultater.

Opprett en API-nøkkelInteraktiv API-referanse

Kom i gang

Utvikler-API-et bruker nøkler med begrenset omfang, ikke innloggingsendepunktet for nettleseren.

  1. Logg inn på wcagc og opprett en nøkkel under Innstillinger → Utvikler-API.
  2. Kopier hele nøkkelen når den vises. Den vises bare én gang. Lagre den i hemmelighetsbehandleren din.
  3. Gi bare de omfangene klienten din trenger. Velg Authorize i Swagger og lim inn nøkkelen uten å legge til ordet Bearer.
  4. Send nøkkelen til https://api.wcagc.com som en Authorization: Bearer-header.
curl https://api.wcagc.com/api/v1/sites \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $WCAGC_API_KEY"

Autentisering

Nøkler begynner med wcagc_ og vises i sin helhet bare én gang. Lagre dem som hemmeligheter, gi bare de omfangene du trenger, og tilbakekall dem umiddelbart hvis de blir eksponert.

Du vil ikke se /api/auth/login i den offentlige spesifikasjonen: det oppretter en cookie-økt for nettappen og er bevisst ikke autentiseringsmetoden for skript.

Forespørselsgrense

Hver nøkkel tillater 120 forespørsler i minuttet som standard. Et 429-svar inneholder Retry-After, slik at klienter kan vente trygt.

Omfang

De fleste REST-rutene krever abonnementsfunksjonen Utvikler-API. CI bruker et eget ci:check-omfang og en egen abonnementskvote. Assistent- og nettleserutvidelsesopplysninger har sin egen dokumentasjon.

sites:read
List opp registrerte nettsteder i nøkkelens organisasjon.
scans:write
Start skanninger av enkeltsider og hele nettsteder.
scans:read
Les skanningsstatus, antall, fremdrift og funn.
ci:check
Start og les avgrensede CI-sjekker av flere URL-er innenfor organisasjonens CI-kvote.

Velg API-oppgaven du trenger

Referansen er organisert rundt stabile oppgaver, ikke de interne endepunktene i nettappen. Hver ressurs er avgrenset til organisasjonen som eier påloggingsopplysningen.

Finn nettsteder

Hent ID-ene til registrerte nettsteder før du starter en kjøring av hele nettstedet, leser en trend eller velger en lagret brukerreise. Krever sites:read.

GET /api/v1/sites

Sjekk én side

Legg en side på et registrert nettsted i kø, sjekk skanningen jevnlig og les deretter de stabile funnpostene. Krever scans:write og scans:read.

POST /api/v1/scans GET /api/v1/scans/{id} GET /api/v1/scans/{id}/violations

Gjennomsøk et registrert nettsted

Legg en kjøring av hele nettstedet i kø, og les fremdrift, funn og deterministiske grupper etter rotårsak. Krever scans:write og scans:read.

POST /api/v1/scan-runs GET /api/v1/scan-runs/{id} GET /api/v1/scan-runs/{id}/violations GET /api/v1/scan-runs/{id}/root-causes

Kjør lagrede brukerreiser og verifiser utbedringer

Bruk trinn og påloggingsopplysninger som er lagret på serveren. API-forespørsler inneholder aldri innloggingshemmeligheter. Trender for nettsteder og målrettede nye sjekker bruker de vanlige lese- og skriveomfangene.

GET /api/v1/sites/{id}/journeys POST /api/v1/journeys/{id}/runs GET /api/v1/sites/{id}/trend POST /api/v1/remediation-items/{id}/verifications

Kvalitetsport i CI

Sjekk så mange URL-er som abonnementet tillater på ett verifisert nettsted, les avgjørelsen og hent funn som tar hensyn til baseline. Krever ci:check.

POST /api/v1/ci/checks GET /api/v1/ci/checks/{id} GET /api/v1/ci/checks/{id}/violations

Opprett, sjekk status, les funn

Oppretting av skanning, kjøring, CI, brukerreise og verifisering av utbedringer skjer asynkront. En vellykket POST returnerer 202 Accepted, en ressurs-ID og en Location-header.

Sjekk Location-ressursen jevnlig med begrenset backoff til den når en sluttstatus. Les funn først etter at den er fullført, og behandle ikke et svar om at noe står i kø eller kjører som et resultat.

curl -X POST https://api.wcagc.com/api/v1/scans \
  -H "Authorization: Bearer $WCAGC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/checkout"}'
curl https://api.wcagc.com/api/v1/scans/{id} \
  -H "Authorization: Bearer $WCAGC_API_KEY"

curl https://api.wcagc.com/api/v1/scans/{id}/violations \
  -H "Authorization: Bearer $WCAGC_API_KEY"

Håndter stabile feilkoder

Feil bruker application/problem+json. Styr logikken din etter code, ta vare på traceId til support, og behandle detail som lesbar kontekst som kan endre seg.

  • 401 API_KEY_INVALID
  • 403 API_KEY_SCOPE_MISSING / FEATURE_NOT_IN_PLAN
  • 404 *_NOT_FOUND
  • 409 *_ALREADY_RUNNING
  • 422 VALIDATION_FAILED / INVALID_URL
  • 429 RATE_LIMITED + Retry-After
{
  "type": "https://wcagc.com/problems/api-key-scope-missing",
  "title": "API key scope missing",
  "status": 403,
  "detail": "The API key does not grant the required scope.",
  "instance": "/api/v1/sites",
  "code": "API_KEY_SCOPE_MISSING",
  "traceId": "019c…",
  "timestamp": "2026-08-19T20:57:19Z"
}

Interaktiv og maskinlesbar referanse

Swagger lister opp alle støttede operasjoner i Utvikler-API v1, nødvendig omfang, forespørselsskjema, svarstatus og eksempel. Den rå OpenAPI 3.1-JSON-en kan importeres i API-klienter og kodegeneratorer.

Åpne Swagger UILast ned OpenAPI JSON

Signerte utgående webhooks

Koble et HTTPS-endepunkt til hendelser for avsluttede skanninger, regresjoner og utbedring. Hver JSON-levering inneholder en tidsstemplet HMAC-SHA256-signatur, en stabil leverings-ID og automatiske nye forsøk.

Sett opp webhooks

Verifiser X-Wcagc-Signature mot timestamp + '.' + den uendrede, rå body-en i forespørselen. Avvis gamle tidsstempler for å redusere risikoen for gjentakelsesangrep.

X-Wcagc-Event: scan_run.completed
X-Wcagc-Delivery: 019f…
X-Wcagc-Timestamp: 178406…
X-Wcagc-Signature: v1=<hmac-sha256>