Dossier

URL base: https://webvyze.com/api/v1 · haz clic en una ruta para ver alcance, parámetros, ejemplo y respuestas.

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.

Alcance
api:read
Parámetros de ruta
{site} integer
Respuestas
200401402403422429
curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/accessibility-report
Enlace a esta ruta
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.

Alcance
api:write
Parámetros de ruta
{site} integer{criterion} integer
Respuestas
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}
Enlace a esta ruta
GET/sites/{site}/compareCompare two audits

Needs access to the site, when there is one.

Alcance
api:read
Parámetros de ruta
{site} integer
Respuestas
200401402403422429
curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/compare
Enlace a esta ruta
GET/sites/{site}/dossiersCompliance dossiers of a site

Needs access to the site, when there is one.

Alcance
api:read
Parámetros de ruta
{site} integer
Respuestas
200401402403422429
curl -H "Authorization: Bearer $WEBVYZE_KEY" \
  https://webvyze.com/api/v1/sites/{site}/dossiers
Enlace a esta ruta
POST/sites/{site}/dossiersGenerate a dossier

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

Alcance
api:write
Parámetros de ruta
{site} integer
Respuestas
200401402403422429
curl -X POST -H "Authorization: Bearer $WEBVYZE_KEY" \
  -H "Content-Type: application/json" -d '{}' \
  https://webvyze.com/api/v1/sites/{site}/dossiers
Enlace a esta ruta