Web Accessibility API

Die Web Accessibility API, die für das Skalieren entwickelt wurde.

Um mit der A11yWatch API zu beginnen, fügen Sie Ihrem Autorisierungs-Header das JWT-Format Bearer TOKEN hinzu. Weitere Informationen finden Sie in der OpenAPI, GraphQL oder gRPC dokumentation. Sie benötigen ein kostenpflichtiges Abonnement, um auf die API zugreifen zu können.

Authentifizierung & Benutzer
- https://api.a11ywatch.com/api/user
  GET
  curl --location --request GET 'https://api.a11ywatch.com/api/user' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/login
  POST
  email stringDie E-Mail-Adresse, mit der Sie sich anmelden möchten.Erforderlichpassword stringDas Kennwort der E-Mail-Adresse, mit der Sie sich anmelden möchten.Erforderlich
  curl --location --request POST 'https://api.a11ywatch.com/api/login' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "email": "example@email.com", "password": "somethingsafe" }'
Berichtsaktionen
- https://api.a11ywatch.com/api/scan
  POST
  url stringDie zu crawlenden URL und Berichte.Erforderlich
  curl --location --request POST 'https://api.a11ywatch.com/api/scan' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/crawl
  POST
  url stringDie zu crawlenden URL und Berichte.Erforderlichsubdomains booleanUnterverzeichnisse, die zur Domain gehören, einschließen.sitemap numberSitemap-Links einbeziehen - 0 deaktiviert, 1 nur Sitemap durchsuchen und 2 Crawling mit Sitemap erweitern.tld booleanAlle TLD-Erweiterungen einbeziehen, die zur Domain passen.csv Header [Accept: text/csv]Daten als CSV behandeln anstelle von JSON.
  curl --location --request POST 'https://api.a11ywatch.com/api/crawl' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/websites-sync
  POST
  curl --location --request POST 'https://api.a11ywatch.com/api/websites-sync' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json'
Website-Management
- https://api.a11ywatch.com/api/website
  POST
  url stringDie Website-URL.ErforderlichcustomHeaders string[{key: string, value: string}]Ein Array von Objekten mit einem Schlüssel-Wert-Paar für Header-Konfigurationen.mobile booleanWird der Test im mobilen Viewport durchgeführt?standard stringDer WCAG2.1-Standard, den Sie verwenden möchten, z. B. WCAG2A, WCAG2AA und WCAG2AAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "websiteUrl": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website?domain=https://mywebsite.com
  GET
  url stringDie Website-URL.Erforderlich
  curl --location --request GET 'https://api.a11ywatch.com/api/website?domain=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website
  PUT
  url stringDie Website-URL.ErforderlichcustomHeaders string[{key: string, value: string}]Ein Array von Objekten mit einem Schlüssel-Wert-Paar für Header-Konfigurationen.mobile booleanWird der Test im mobilen Viewport durchgeführt?standard stringDer WCAG2.1-Standard, den Sie verwenden möchten, z. B. WCAG2A, WCAG2AA und WCAG2AAA.
  curl --location --request PUT 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website
  DELETE
  url Die Website-URL.domain stringDer Name der Website.deleteMany booleanLösche alle Websites und zugehörigen Daten.
  curl --location --request DELETE 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "domain": "a11ywatch.com" }'
- https://api.a11ywatch.com/api/report?url=https://mywebsite.com
  GET
  url Die zu crawlenden URL und Berichte.Erforderlichdownload booleanLade den Bericht als Excel-Datei herunter.csv booleanDaten als CSV behandeln anstelle von JSON.
  curl --location --request GET 'https://api.a11ywatch.com/api/report?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com
  GET
  url Die Website-URL.Erforderlich
  curl --location --request GET 'https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com
  GET
  url Die zu crawlenden URL und Berichte.Erforderlich
  curl --location --request GET 'https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
Listen Ergebnisse
- https://api.a11ywatch.com/api/list/website?offset=0
  GET
  offset numberDie Seitenposition, um die nächste paginierte Menge zu erhalten.search stringSuche nach einer Seite nach Problemen.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/website?offset=0' --header 'Authorization: $A11YWATCH_TOKEN' undefined
- https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com
  GET
  offset numberDie Seitenposition, um die nächste paginierte Menge zu erhalten.domain stringDer Name der Website.search stringSuche nach einer Seite nach Problemen.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/pages?offset=0
  GET
  offset numberDie Seitenposition, um die nächste paginierte Menge zu erhalten.domain stringDer Name der Website.search stringSuche nach einer Seite nach Problemen.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/pages?offset=0' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com
  GET
  offset numberDie Seitenposition, um die nächste paginierte Menge zu erhalten.domain stringDer Name der Website.pageUrl stringDie Website-URL.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'

Standardmäßig demonstrieren die A11yWatch-API-Dokumente die Verwendung von Curl, um über HTTP mit der API zu interagieren. Die meisten Routen erlauben Parameter, die von der URL oder dem Body gesendet werden können. Es ist am besten, sich beim Senden von HTTP-PUT- und POST-Anforderungen auf die Verwendung des Body zu beschränken, da einige Parameter als Arrays und andere als Nicht-String-Formen festgelegt sind. Ersetzen Sie im Beispiel a11ywatch.com durch die Website, die Sie ansprechen möchten. Die Verwendung von A11yWatch auf einem CI kann die Entwicklungskosten dramatisch senken, indem sie vor der Produktionsbereitstellung auf Bewusstsein aufmerksam macht.

Bleiben Sie inklusiv mit Vertrauen

Beginnen Sie jetzt mit A11yWatch, um schnelles und erschwingliches automatisches Web-Accessibility-Testen und -Überwachen zu erhalten.

Loslegen

Web Accessibility API

Die Web Accessibility API, die für das Skalieren entwickelt wurde.

Authentifizierung & Benutzer

Berichtsaktionen

Website-Management

Listen Ergebnisse

Bleiben Sie inklusiv mit Vertrauen