Dossier

Base URL: https://webvyze.com/api/v1 · click an endpoint for its scope, parameters, example and responses.

GET/sites/{site}/accessibility-reportAccessibility conformance report: WCAG A/AA criteria with status (VPAT/ACR basis)

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/accessibility-report

Link to this endpoint

PUT/sites/{site}/accessibility-report/{criterion}Record the manual review of a WCAG criterion: result supports, partially_supports, does_not_support, not_applicable or null to clear; notes

Needs a token with api:write. Needs the issues.manage permission in the account.

Scope: api:write
Path parameters: {site} integer{criterion} integer
Responses: 200401402403422429

curl -X PUT -H "Authorization: Bearer $WEBVYZE_KEY" \
  -H "Content-Type: application/json" -d '{}' \
  https://webvyze.com/api/v1/sites/{site}/accessibility-report/{criterion}

Link to this endpoint

GET/sites/{site}/compareCompare two audits

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/compare

Link to this endpoint

GET/sites/{site}/dossiersCompliance dossiers of a site

Needs access to the site, when there is one.

Scope: api:read
Path parameters: {site} integer
Responses: 200401402403422429

curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/dossiers

Link to this endpoint

POST/sites/{site}/dossiersGenerate a dossier

Needs a token with api:write. Needs the reports.export permission in the account.

Scope: api:write
Path parameters: {site} integer
Responses: 200401402403422429

curl -X POST -H "Authorization: Bearer $WEBVYZE_KEY" \
  -H "Content-Type: application/json" -d '{}' \
  https://webvyze.com/api/v1/sites/{site}/dossiers

Link to this endpoint