网站可访问性审计 API

API ID 13983

审核网页或整个网站是否符合WCAG 2.2、EN 301 549(欧洲无障碍法案)和508节的标准在真实浏览器中生成JSON、CSV或HTML报告

API 文档

端点

请求
加载 `url`(或渲染 `html`)到 Chromium,等待客户端渲染,然后使用 `standard` 的规则运行 axe-core
Endpoint ID: 33863
POST https://zylalabs.com/api/13983/website+accessibility+audit+api/33863/audit+one+web+page+or+html+document+for+wcag+accessibility
输入参数

审计一个网页或HTML文档的WCAG可访问性 — 端点功能

对象 描述
请求体 必需 Json

剩余免费测试请求:3 / 3。


输入参数

API 示例响应
JSON
{
    "standard": "wcag22aa",
    "viewport": "desktop",
    "axe_version": "4.13.0",
    "url": "https://example.com/",
    "status": 200,
    "title": "Example Domain",
    "lang": "en",
    "score": 100,
    "counts": {
        "violations": 0,
        "violation_nodes": 0,
        "critical": 0,
        "serious": 0,
        "moderate": 0,
        "minor": 0,
        "incomplete": 1,
        "passes": 10,
        "inapplicable": 52
    },
    "violations": [],
    "incomplete": [
        {
            "id": "bypass",
            "impact": "serious",
            "level": "A",
            "wcag": [
                "2.4.1"
            ],
            "help": "Page must have means to bypass repeated blocks",
            "description": "Ensure each page has at least one mechanism for a user to bypass navigation and jump straight to the content",
            "help_url": "https://dequeuniversity.com/rules/axe/4.13/bypass?application=axeAPI",
            "tags": [
                "cat.keyboard",
                "wcag2a",
                "wcag241",
                "section508",
                "section508.22.o",
                "TTv5",
                "TT9.a",
                "EN-301-549",
                "EN-9.2.4.1",
                "RGAAv4",
                "RGAA-12.7.1"
            ],
            "node_count": 1,
            "nodes": [
                {
                    "target": "html",
                    "html": "<html lang=\"en\">",
                    "failure_summary": "Fix any of the following:\n  No valid skip link found\n  Page does not have a heading\n  Page does not have a landmark region"
                }
            ]
        }
    ],
    "duration_ms": 1838
}
审计一个网页或HTML文档的WCAG可访问性 — 代码片段

curl --location --request POST 'https://zylalabs.com/api/13983/website+accessibility+audit+api/33863/audit+one+web+page+or+html+document+for+wcag+accessibility' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
  "url": "https://example.com"
}'

    
请求
使用`url`从该页面开始抓取站点(内部链接和sitemap.xml,在`max_depth`范围内),然后审核找到的前`max_pages`个HTML页面,同时进行多个审核。使用`urls`来审核该列表。返回站点整体摘要(每个失败规则及相关的页面和元素数量)以及每个页面的报告
Endpoint ID: 33864
POST https://zylalabs.com/api/13983/website+accessibility+audit+api/33864/audit+a+whole+website+or+a+list+of+urls+for+accessibility
输入参数

审计整个网站或一系列 URL 的可访问性 — 端点功能

对象 描述
请求体 必需 Json

剩余免费测试请求:3 / 3。


输入参数

API 示例响应
JSON
{
    "url": "https://example.com/",
    "scope": [
        "example.com"
    ],
    "standard": "wcag22aa",
    "viewport": "desktop",
    "axe_version": "4.13.0",
    "pages_audited": 1,
    "pages_failed": 0,
    "not_audited": 0,
    "truncated": false,
    "duration_ms": 3045,
    "discovery": {
        "html_pages": 1,
        "other_pages": 0,
        "not_visited": 0,
        "sitemap_urls": 0
    },
    "summary": {
        "score": 100,
        "worst_score": 100,
        "counts": {
            "violations": 0,
            "violation_nodes": 0,
            "critical": 0,
            "serious": 0,
            "moderate": 0,
            "minor": 0,
            "incomplete": 1,
            "passes": 10,
            "inapplicable": 52
        },
        "rules": []
    },
    "pages": [
        {
            "url": "https://example.com/",
            "status": 200,
            "title": "Example Domain",
            "lang": "en",
            "score": 100,
            "counts": {
                "violations": 0,
                "violation_nodes": 0,
                "critical": 0,
                "serious": 0,
                "moderate": 0,
                "minor": 0,
                "incomplete": 1,
                "passes": 10,
                "inapplicable": 52
            },
            "violations": [],
            "duration_ms": 1777
        }
    ]
}
审计整个网站或一系列 URL 的可访问性 — 代码片段

curl --location --request POST 'https://zylalabs.com/api/13983/website+accessibility+audit+api/33864/audit+a+whole+website+or+a+list+of+urls+for+accessibility' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
  "url": "https://example.com"
}'

    

API 访问密钥和身份验证

注册后,每个开发者都会被分配一个个人 API 访问密钥,这是一个唯一的字母和数字组合,用于访问我们的 API 端点。要使用 网站可访问性审计 API 进行身份验证,只需在 Authorization 标头中包含您的 bearer token。

标头
标头 描述
授权 必需 应为 Bearer access_key. 订阅后,请查看上方的"您的 API 访问密钥"。

无长期承诺。随时升级、降级或取消。 免费试用包括最多 50 个请求。

起价
$10,000/年


  • 自定义数量
  • 自定义速率限制
  • 专业客户支持
  • 实时 API 监控

概览

在真实浏览器中审核网页或整个网站以符合WCAG 2.2、EN 301 549(欧洲无障碍法案)和第508节。生成JSON、CSV或HTML报告

网站可访问性审计 API FAQs

WCAG 2.0、2.1 和 2.2(级别 A、AA、AAA)、EN 301 549(欧洲无障碍法)、第 508 条(美国)和 RGAA,以及可选的最佳实践 检查由在真实的 Chromium 浏览器中运行的 axe-core 提供支持

是的 提供一个域名 API 会抓取它(内部链接和sitemap.xml)并对每次调用最多10个页面进行审核 同时审核多个页面 您将获得每个失败规则的全站摘要和每个页面的详细报告 您还可以发送自己的网站链接列表

为您的代码生成JSON 为电子表格和工单工具生成每个违规元素一行的CSV 以及准备发送给客户的自包含HTML报告

不 自动化测试发现了很大一部分可访问性问题但并不是全部 仍然需要手动审核以声称完全符合 页面在内存中进行审计且没有任何存储

是的 在发货之前发送一个带有base_url的HTML模板进行审计 跳过您已经处理过的规则并禁用规则 如果得分或者关键问题失败您的构建

一般常见问题

Zyla API Hub 就像一个大型 API 商店,您可以在一个地方找到数千个 API。我们还为所有 API 提供专门支持和实时监控。注册后,您可以选择要使用的 API。请记住,每个 API 都需要自己的订阅。但如果您订阅多个 API,您将为所有这些 API 使用相同的密钥,使事情变得更简单。
价格以 USD(美元)、EUR(欧元)、CAD(加元)、AUD(澳元)和 GBP(英镑)列出。我们接受所有主要的借记卡和信用卡。我们的支付系统使用最新的安全技术,由 Stripe 提供支持,Stripe 是世界上最可靠的支付公司之一。如果您在使用卡片付款时遇到任何问题,请通过 [email protected]

此外,如果您已经以这些货币中的任何一种(USD、EUR、CAD、AUD、GBP)拥有有效订阅,该货币将保留用于后续订阅。只要您没有任何有效订阅,您可以随时更改货币。
定价页面上显示的本地货币基于您 IP 地址的国家/地区,仅供参考。实际价格以 USD(美元)为单位。当您付款时,即使您在我们的网站上看到以本地货币显示的等值金额,您的卡片对账单上也会以美元显示费用。这意味着您不能直接使用本地货币付款。
有时,银行可能会因其欺诈保护设置而拒绝收费。我们建议您首先联系您的银行,检查他们是否阻止了我们的收费。此外,您可以访问账单门户并更改关联的卡片以进行付款。如果这些方法不起作用并且您需要进一步帮助,请通过 [email protected]
价格由月度或年度订阅决定,具体取决于所选计划。
API 调用根据成功请求从您的计划中扣除。每个计划都包含您每月可以进行的特定数量的调用。只有成功的调用(由状态 200 响应指示)才会计入您的总数。这确保失败或不完整的请求不会影响您的月度配额。
Zyla API Hub 采用月度订阅系统。您的计费周期将从您购买付费计划的那一天开始,并在下个月的同一日期续订。因此,如果您想避免未来的费用,请提前取消订阅。
要升级您当前的订阅计划,只需转到 API 的定价页面并选择您要升级到的计划。升级将立即生效,让您立即享受新计划的功能。请注意,您之前计划中的任何剩余调用都不会转移到新计划,因此在升级时请注意这一点。您将被收取新计划的全部金额。
要检查您本月剩余多少 API 调用,请参考响应标头中的 "X-Zyla-API-Calls-Monthly-Remaining" 字段。例如,如果您的计划允许每月 1,000 个请求,而您已使用 100 个,则响应标头中的此字段将显示 900 个剩余调用。
要查看您的计划允许的最大 API 请求数,请检查 "X-Zyla-RateLimit-Limit" 响应标头。例如,如果您的计划包括每月 1,000 个请求,此标头将显示 1,000。
"X-Zyla-RateLimit-Reset" 标头显示您的速率限制重置之前的秒数。这告诉您何时您的请求计数将重新开始。例如,如果它显示 3,600,则意味着还有 3,600 秒直到限制重置。
是的,您可以随时通过访问您的账户并在账单页面上选择取消选项来取消您的计划。请注意,升级、降级和取消会立即生效。此外,取消后,您将不再有权访问该服务,即使您的配额中还有剩余调用。
为了让您有机会在没有任何承诺的情况下体验我们的 API,我们提供 7 天免费试用,允许您免费进行最多 50 次 API 调用。此试用只能使用一次,因此我们建议将其应用于您最感兴趣的 API。虽然我们的大多数 API 都提供免费试用,但有些可能不提供。试用在 7 天后或您进行了 50 次请求后结束,以先发生者为准。如果您在试用期间达到 50 次请求限制,您需要"开始您的付费计划"以继续发出请求。您可以在个人资料中的订阅 -> 选择您订阅的 API -> 定价标签下找到"开始您的付费计划"按钮。或者,如果您在第 7 天之前不取消订阅,您的免费试用将结束,您的计划将自动计费,授予您访问计划中指定的所有 API 调用的权限。请记住这一点以避免不必要的费用。
7 天后,您将被收取试用期间订阅的计划的全额费用。因此,在试用期结束前取消很重要。因忘记及时取消而提出的退款请求不被接受。
当您订阅 API 免费试用时,您可以进行最多 50 次 API 调用。如果您希望超出此限制进行额外的 API 调用,API 将提示您执行"开始您的付费计划"。您可以在个人资料中的订阅 -> 选择您订阅的 API -> 定价标签下找到"开始您的付费计划"按钮。
付款订单在每月 20 日至 30 日之间处理。如果您在 20 日之前提交请求,您的付款将在此时间范围内处理。
您可以通过我们的聊天渠道联系我们以获得即时帮助。我们始终在线,时间为上午 8 点至下午 5 点(EST)。如果您在该时间之后联系我们,我们将尽快回复您。此外,您可以通过 [email protected]