wcagc
Luo tili
Tuotanto-API

Aja saavutettavuustarkistuksia omasta työnkulustasi

Käytä rajattua organisaation API-avainta yksittäisten sivujen tai koko sivuston skannausten käynnistämiseen ja vakaiden, jäsenneltyjen tulosten lukemiseen.

Luo API-avainInteraktiivinen API-viite

Pikaopas

Developer API käyttää rajattuja avaimia, ei selaimen kirjautumispäätepistettä.

  1. Kirjaudu wcagc:hen ja luo avain kohdassa Asetukset → Developer API.
  2. Kopioi koko avain, kun se näytetään kerran, ja tallenna se salaisuuksienhallintaasi.
  3. Myönnä vain ne oikeusalueet, joita asiakasohjelmasi tarvitsee. Valitse Swaggerissa Authorize ja liitä avain ilman sanaa Bearer.
  4. Lähetä avain osoitteeseen https://api.wcagc.com Authorization: Bearer -otsakkeessa.
curl https://api.wcagc.com/api/v1/sites \
  -H "Accept: application/json" \
  -H "Authorization: Bearer $WCAGC_API_KEY"

Tunnistautuminen

Avaimet alkavat tunnuksella wcagc_ ja näytetään kokonaisina vain kerran. Säilytä ne salaisuuksina, myönnä vain tarvitsemasi oikeusalueet ja peruuta avain heti, jos se paljastuu.

Et näe /api/auth/login-päätepistettä julkisessa määrityksessä: se luo verkkosovellukselle evästeistunnon, eikä sitä ole tarkoituksella tehty skriptien tunnistautumiseen.

Pyyntöraja

Kukin avain sallii oletuksena 120 pyyntöä minuutissa. 429-vastaus sisältää Retry-After-otsakkeen, jotta asiakasohjelmat voivat hidastaa turvallisesti.

Oikeusalueet

Useimmat REST-reitit vaativat Developer API -tilausominaisuuden. CI käyttää erillistä ci:check-oikeusaluetta ja tilauksen kiintiötä. Avustajien ja selainlaajennuksen tunnistetiedoilla on oma dokumentaationsa.

sites:read
Listaa avaimen organisaation rekisteröidyt sivustot.
scans:write
Käynnistä yksittäisen sivun ja koko sivuston skannauksia.
scans:read
Lue skannauksen tila, määrät, edistyminen ja havainnot.
ci:check
Käynnistä ja lue rajattuja usean URL-osoitteen CI-tarkistuksia organisaation CI-kiintiön puitteissa.

Valitse tarvitsemasi API-tehtävä

Viite on jäsennelty vakaiden tehtävien ympärille eikä verkkosovelluksen sisäisten päätepisteiden mukaan. Jokainen resurssi rajautuu sille organisaatiolle, joka omistaa tunnistetiedon.

Hae sivustot

Hae rekisteröityjen sivustojen tunnukset ennen koko sivuston ajon käynnistämistä, trendin lukemista tai tallennetun polun valintaa. Vaatii sites:read.

GET /api/v1/sites

Tarkista yksi sivu

Aseta rekisteröidyn sivuston sivu jonoon, kysele skannauksen tilaa ja lue sitten sen vakaat havaintotietueet. Vaatii scans:write ja scans:read.

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

Käy läpi rekisteröity sivusto

Aseta koko sivuston ajo jonoon ja lue edistyminen, havainnot sekä deterministiset perimmäisten syiden ryhmät. Vaatii scans:write ja 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

Aja tallennettuja polkuja ja varmista korjaukset

Käytä palvelimelle tallennettuja vaiheita ja tunnistetietoja. API-pyynnöt eivät koskaan kuljeta kirjautumissalaisuuksia. Sivuston trendit ja kohdennetut uudelleentarkistukset käyttävät tavallisia luku- ja kirjoitusoikeusalueita.

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

Aseta CI-portti

Tarkista yhdeltä vahvistetulta sivustolta enintään tilauksen rajan verran URL-osoitteita, lue lopputulos ja hae perustasoon verrattuja havaintoja. Vaatii ci:check.

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

Luo, kysele, lue sitten havainnot

Skannauksen, ajon, CI:n, polun ja korjauksen varmistuksen luonti on asynkronista. Onnistunut POST palauttaa 202 Accepted -vastauksen, resurssin tunnuksen ja Location-otsakkeen.

Kysele Location-resurssia kasvavalla mutta rajatulla odotusajalla, kunnes se saavuttaa päätetilan. Lue havainnot vasta valmistumisen jälkeen. Älä pidä jonossa tai käynnissä -vastausta tuloksena.

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"

Käsittele vakaat virhekoodit

Virheet käyttävät muotoa application/problem+json. Haaraudu code-kentän mukaan, säilytä traceId tukea varten ja pidä detail-kenttää ihmisluettavana taustatietona, joka voi muuttua.

  • 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"
}

Interaktiivinen ja koneluettava viite

Swagger listaa jokaisen tuetun Developer API v1 -toiminnon, vaaditun oikeusalueen, pyyntöskeeman, vastauksen tilan ja esimerkin. Raaka OpenAPI 3.1 -JSON voidaan tuoda API-asiakasohjelmiin ja koodigeneraattoreihin.

Avaa Swagger UILataa OpenAPI JSON

Allekirjoitetut lähtevät webhookit

Tilaa HTTPS-päätepiste skannauksen päättymis-, regressio- ja korjaustapahtumiin. Jokainen JSON-lähetys sisältää aikaleimatun HMAC-SHA256-allekirjoituksen, vakaan lähetystunnuksen ja automaattiset uudelleenyritykset.

Määritä webhookit

Vahvista X-Wcagc-Signature arvoa vasten: timestamp + '.' + muuttamaton raaka pyynnön runko. Hylkää vanhat aikaleimat toistohyökkäysten riskin pienentämiseksi.

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