Web 可访问性 API
针对可扩展性进行优化的 Web 可访问性 API。
要使用 A11yWatch API，请在授权标题中以JWT格式添加<0>Bearer TOKEN</ 0>。有关更多信息，请参阅OpenAPI, GraphQL或gRPC文档。使用 API 需要付费订阅。
https://api.a11ywatch.com/api/user
GETcurl --location --request GET 'https://api.a11ywatch.com/api/user' --header 'Authorization: $A11YWATCH_TOKEN'https://api.a11ywatch.com/api/login
POSTemail string要登录的帐户的电子邮件地址。必填项目password string要登录的帐户的密码。必填项目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" }'
https://api.a11ywatch.com/api/scan
POSTurl string要分析和探索的 URL。必填项目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
POSTurl string要分析和探索的 URL。必填项目subdomains boolean包括与域匹配的子域。sitemap number包括站点地图链接- 0 为关闭、1 仅扫描站点地图，2 通过站点地图扩展探索。tld boolean包括与域匹配的所有 TLD 扩展。csv Header [Accept: text/csv]将数据处理为 CSV 而不是 JSON。standard string网络无障碍标准。WCAGA、WCAGAA 或 WCAGAAA 之一。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
POSTcurl --location --request POST 'https://api.a11ywatch.com/api/websites-sync' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json'
https://api.a11ywatch.com/api/website
POSTurl string网站的 URL。必填项目customHeaders string[{key: string, value: string}]一个包含键值对配置的对象数组。mobile boolean在移动视图中执行分析？standard string要使用的 WCAG2.1 标准，例如WCAG2A、WCAG2AA或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
GETurl string网站的 URL。必填项目curl --location --request GET 'https://api.a11ywatch.com/api/website?domain=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'https://api.a11ywatch.com/api/website
PUTurl string网站的 URL。必填项目customHeaders string[{key: string, value: string}]一个包含键值对配置的对象数组。mobile boolean在移动视图中执行分析？standard string要使用的 WCAG2.1 标准，例如WCAG2A、WCAG2AA或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
DELETEurl 网站的 URL。domain string网站名称。deleteMany boolean删除所有网站和相关数据。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
GETurl 要分析和探索的 URL。必填项目download boolean下载报告到Excel文件。csv boolean将数据处理为 CSV 而不是 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
GETurl 网站的 URL。必填项目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
GETurl 要分析和探索的 URL。必填项目curl --location --request GET 'https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
https://api.a11ywatch.com/api/list/website?offset=0
GEToffset number获取下一个分页集的页面位置。search string搜索页面上的问题。curl --location --request GET 'https://api.a11ywatch.com/api/list/website?offset=0' --header 'Authorization: $A11YWATCH_TOKEN' undefinedhttps://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com
GEToffset number获取下一个分页集的页面位置。domain string网站名称。search string搜索页面上的问题。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
GEToffset number获取下一个分页集的页面位置。domain string网站名称。search string搜索页面上的问题。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
GEToffset number获取下一个分页集的页面位置。domain string网站名称。pageUrl string网站的 URL。curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'
默认情况下，A11yWatch API 文档说明如何使用 cURL 通过 HTTP 与 API 交互。大多数路径可以从 URL 或 body 中发送参数。最好使用Body发送 HTTP PUT 和POST请求，因为一些参数必须将数组设置为表格和其他形式，而另一些参数可能使用不同的格式。在这个示例中，将a11ywatch.com替换为您要扫描的网站。使用 A11yWatch 在 CI 中可以增加认识，从而大大减少开发成本，而不是在正式发布之后发现问题。
以自信保持包容
现在开始使用A11yWatch，了解自动化、高效和可访问的Web可访问性工具。