注册|登录

万博体育官网网址-波API(版本2。1)详细信息

使用API

API请求是由发送请求到http://wave。webaim。org/api/request?关键={ yourAPIkey }url ={ url }。您可以使用https://的安全,加密连接。。

查询参数

注意:所有参数都是可选的,除非指定。。

参数 意义 笔记
关键 你的API密钥。(必需) API键是你注册后提供给你。它可以通过登录再生。。
url 要分析页面的完整的URL。(必需) 页面必须公开(参见下面的验证选项)来进行分析。万博体育官网网址必须URL编码的URL (e。g。,与符号,空间,等。逃脱)。。
格式 jsonxml
(默认= json)
将返回结果的格式。。
viewportwidth 整数
(默认= 1200)
像素宽度的页面将被评估。这可以用于测试页面在不同反应断点。。
evaldelay 整数
(默认= 250)
等待的毫秒数在最后一页请求之前评估页面。这可以更好地确保严重操纵通过脚本的页面区域完全成形之前评估。这可以为静态页面设置为0或增加动态页面或页面加载缓慢的来源。。
reporttype 1,,2,或3.
(默认= 1)

reporttype = 1(成本1 API信贷)将只返回的波统计页面被分析,错误的数量,警报,的特性,HTML5 /咏叹调元素,结构元素,和对比的问题。。

reporttype = 2学分)(成本2 API将返回上面的统计数据中,以及所有波的清单项(e。g。,类型的错误)。。

reporttype = 3学分)(成本3 API将返回所有上述情况,包括每个元素的XPath的一波项目相关联。这可以让你确定在每一页一个特定的问题发生。。

用户名 服务器身份验证所需的用户名 如果要分析的页面是密码保护,并使用标准的认证,波可以使用用户名和密码进行身份验证之前检查页面。。
密码 服务器身份验证所需的密码 请注意,用户名和密码发送纯文本,通过波系统领域。我们建议使用https或使用波独立API。。

结果参数

返回以下结果参数reporttype = 1

参数 意义
状态:成功|错误 请求的状态
状态:httpstatuscode 从主机服务器返回的HTTP代码。这可以帮助过滤404或其他错误页面。。
状态:错误:代码
状态:错误:描述
(返回只有状态是错误)
万博体育官网网址-波API返回的错误代码和错误的描述(e。g。,”没有API剩余学分”)。。
类别:categoryname 数组中返回的类别错误,,警报,,功能,,结构,,html5,和/或对比
类别:categoryname:描述 简要描述的类别。。
类别:categoryname:数 这一类的项目数量(e。g。,,类别:错误:计数返回错误检测到波)的数量。。
统计:creditsremaining 帐户上的万博体育官网网址-波API学分剩余数量
统计:pageurl 页面的URL进行了分析。请注意,由于重定向,这可能有时是不同的URL请求中发送。。
统计:pagetitle 页面标题页面的分析。。
统计:waveurl 全波的URL编码的报告。。
时间统计: 的秒数波所需下载和分析页面。注意,波不下载图片或嵌入的媒体文件。。
统计:allitemcount 总和所有categoryname:计数,或数量的不同的物品返回的波(必须使用reporttype = 2reporttype = 3把它们单独)。。
统计:totalelements 页面中的元素数量进行了分析。。

除了以上参数,返回以下结果参数reporttype = 2

参数 意义
类别:categoryname:项目 数组项的类别
类别:categoryname项目:id 不同的每个条目id返回的波。(例如:类别:错误:项目:alt_missing表明该项失踪的替代文本。)
类别:categoryname项目:id:数 返回特定项的数量。(例如:类别:错误:项目:alt_missing: 7表明7失踪的替代文本条目被发现。。
类别:categoryname项目:id:id 这个项目的唯一标识符。这可以用于查找项波文档细节。。
类别:categoryname项目:id:描述 一个产品的简短描述。额外的细节(项目意味着什么,为什么它重要的可访问性,要做什么,波算法,第508节和WCAG 2。0映射)可通过查询波的文档使用项id。。

除了以上参数,返回以下结果参数reporttype = 3

参数 意义
类别:categoryname项目:id:xpath 一系列XPath值每一项的类型。。
类别:categoryname项目:id:xpath:xpath XPath值。这些可能是有用的把一个特定的项目和不同的元素在页面(e。g。,确定哪些特定的图像在页面缺少替代文本)。。

例子

基本查询

查询:

http://wave。webaim。org/api/request?关键= { yourAPIkey } url =谷歌。com

结果:

{ "状态”:{"成功”:真的,”httpstatuscode”:200},”统计”:{"pagetitle”:“谷歌”,”pageurl”:“谷歌。com”,”时间”:1。27日,”allitemcount”:20,”totalelements”:178,”waveurl”:“http: \ \ /波。webaim。org \ /报告吗?url = http:\ \ /谷歌。com \ /”},”类别”:{"错误”:{"描述”:“错误”,”数”:4 },”警戒”:{"描述”:“警报”,”数”:5 },”特性”:{"描述”:“功能”,”数”:1},”结构”:{"描述”:“结构元素”,”数”:5 },”html5”:{"描述”:“HTML和咏叹调”,”数”:4 },”对比”:{"描述”:“对比错误”,”数”:2}}}

基本的XML查询

查询:

http://wave。webaim。org/api/request?关键= { yourAPIkey } url =谷歌。com&format = xml

结果:

真正的 200 谷歌 谷歌。com 20. 178 http://wave。webaim。org/report?url = http://google。com 错误 4 警报 5 特性 1 结构元素 5 HTML5和咏叹调 4 对比的错误 2

获取项目信息

查询:

http://wave。webaim。org/api/request?关键= { yourAPIkey } url =谷歌。com&reporttype = 2

结果:

{ "状态”:{"成功”:真的,”httpstatuscode”:200},”统计”:{"pagetitle”:“谷歌”,”pageurl”:“谷歌。com”,”时间”:1。27日,”allitemcount”:31日”totalelements”:178,”waveurl”:“http: \ \ /波。webaim。org \ /报告吗?url = http:\ \ /谷歌。com \ /”},”类别”:{"错误”:{"描述”:“错误”,”数”:4,”项目”:{"language_missing”:{"id”:“language_missing”,”描述”:“文档语言缺失”,”数”:1 },”alt_spacer_missing”:{"id”:“alt_spacer_missing”,”描述”:“间隔形象缺失的替代文本”,”数”:1 },”link_empty”:{"id”:“link_empty”,”描述”:“空链接”,”数”:1 },”label_missing”:{"id”:“label_missing”,”描述”:“失踪的标签”,”数”:1 } } }”警戒”:{"描述”:“错误”,”数”:5”项目”:{"h1_missing”:{"id”:“h1_missing”,”描述”:“第一级标题缺失”,”数”:1 },”title_redundant”:{"id”:“title_redundant”,”描述”:“冗余的标题文本”,”数”:1 },”label_title”:{"id”:“label_title”,”描述”:“无标号表单元素标题为“,”数”:1 },”link_suspicious”:{"id”:“link_suspicious”,”描述”:“可疑的链接文本”,”数”:1 },”heading_skipped”:{"id”:“heading_skipped”,”描述”:“跳过标题级别”,”数”:1 } } }”特性”:{"描述”:“功能”,”数”:1、”项目”:{"alt_link”:{"id”:“alt_link”,”描述”:“有关图像替代文本”,”数”:1 } } }”结构”:{"描述”:“结构元素”,”数”:5”项目”:{"table_layout”:{"id”:“table_layout”,”描述”:“布局表”,”数”:2},”ol”:{"id”:“ol”,”描述”:“有序列表”,”数”:1 },”h2”:{"id”:“h2”,”描述”:“标题级别2”,”数”:1 },”iframe”:{"id”:“iframe”,”描述”:“内联框架”,”数”:1 } } }”html5”:{"描述”:“HTML5和咏叹调”,”数”:4,”项目”:{"咏叹调”:{"id”:“咏叹调”,”描述”:“咏叹调”,”数”:4}}}”对比”:{"描述”:“对比错误”,”数”:2,”项目”:{"对比”:{"id”:“对比”,”描述”:“非常低的对比”,”数”:2 } } } } }

包括所有的统计结果,波的类型也发现,每个项目类型的数。注意,这个API请求类型将花费2学分。。

获取项目细节+ xpath

查询:

http://wave。webaim。org/api/request?关键= { yourAPIkey } url =谷歌。com&reporttype = 3

结果:

{ "状态”:{"成功”:真的,”httpstatuscode”:200},”统计”:{"pagetitle”:“谷歌”,”pageurl”:“谷歌。com”,”时间”:1。27日,”allitemcount”:20,”totalelements”:186,”waveurl”:“http: \ \ /波。webaim。org \ /报告吗?url = http:\ \ /谷歌。com \ /”},”类别”:{"错误”:{"描述”:“错误”,”数”:4,”项目”:{"language_missing”:{"id”:“language_missing”,”描述”:“文档语言缺失”,”数”:1、”xpath”:【“#”)},”alt_spacer_missing”:{"id”:“alt_spacer_missing”,”描述”:“间隔形象缺失的替代文本”,”数”:1、”xpath”:【“\ /身体[1][1]\ \ /中心/跨度[1]\ / DIV [1] \ / DIV[1][1] \ \ /表/ TBODY [1] \ / TR TD [1] [2] \ / \ / IMG [1]”)},”link_empty”:{"id”:“link_empty”,”描述”:“空链接”,”数”:1、”xpath”:【“[1]\ \ /身体/ DIV[1]\ / DIV[1]\ / DIV[1]\ / DIV[2]\ / OL[1]\ /李[3]\[1]”)},”label_missing”:{"id”:“label_missing”,”描述”:“失踪的标签”,”数”:1、”xpath”:【“[1]\ \ /身体/ TEXTAREA[1]”)}}}”警戒”:{"描述”:“警报”,”数”:5”项目”:{"h1_missing”:{"id”:“h1_missing”,”描述”:“第一级标题缺失”,”数”:1、”xpath”:【“#”)},”title_redundant”:{"id”:“title_redundant”,”描述”:“冗余的标题文本”,”数”:1、”xpath”:【“\ /身体[1][1]\ \ /中心/ DIV[1]\[1]\ / IMG[1]”)},”label_title”:{"id”:“label_title”,”描述”:“无标号表单元素标题为“,”数”:1、”xpath”:【“\ /身体[1][1]\ \ /中心/形式[1]\ /表[1]TBODY [1] \ \ / / TR [1] \ / TD DIV[1][2] \ / \ /输入[1]”)},”link_suspicious”:{"id”:“link_suspicious”,”描述”:“可疑的链接文本”,”数”:1、”xpath”:【“[1]\ \ /身体/ DIV [1] \ / DIV [1] \ / DIV [1] \ / DIV [1] \ / OL李[9][1]\ / \ / [1]”)},”heading_skipped”:{"id”:“heading_skipped”,”描述”:“跳过标题级别”,”数”:1、”xpath”:【“[1]\ \ /身体/ DIV [1] \ / DIV [1] \ / DIV [1] \ / DIV [2] \ / H2 [1]”)}}}”特性”:{"描述”:“功能”,”数”:1、”项目”:{"alt_link”:{"id”:“alt_link”,”描述”:“有关图像替代文本”,”数”:1、”xpath”:【“\ /身体[1][1]\ \ /中心/ DIV[1]\[1]\ / IMG[1]”)}}}”结构”:{"描述”:“结构元素”,”数”:6,”项目”:{"table_layout”:{"id”:“table_layout”,”描述”:“布局表”,”数”:3,”xpath”:【“\ /身体[1][1]\ \ /中心/形式[1]\ /表TBODY[1][1]\ / \ / TR[1]\ / TD[1]”,”\ /身体[1][1]\ \ /中心/跨度[1]\ / DIV[1]\ / DIV[1]\ /表TBODY[1][1]\ / \ / TR[1]\ / TD[1]”,”[1]\ \ /身体/表[1]TBODY[1]\ \ / / TR[1]\ / TD[1]”)},”ol”:{"id”:“ol”,”描述”:“有序列表”,”数”:1、”xpath”:【“[1]\ \ /身体/ DIV[1]\ / DIV[1]\ / DIV[1]\ / DIV[1]\ / OL[1]\ /李[1]”)},”h2”:{"id”:“h2”,”描述”:“标题级别2”,”数”:1、”xpath”:【“[1]\ \ /身体/ DIV [1] \ / DIV [1] \ / DIV [1] \ / DIV [2] \ / H2 [1]”)},”iframe”:{"id”:“iframe”,”描述”:“内联框架”,”数”:1、”xpath”:【“[1]\ \ /身体/ IFRAME[1]”)}}}”html5”:{"描述”:“HTML5和咏叹调”,”数”:4,”项目”:{"咏叹调”:{"id”:“咏叹调”,”描述”:“咏叹调”,”数”:4,”xpath”:【“[1]\ \ /身体/ DIV [1] \ / DIV [1] \ / DIV [1] \ / DIV [1] \ / OL李[9][1]\ / \ / [1]”,”[1]\ \ /身体/ DIV[1]\ / DIV[1]\ / DIV[1]\ / DIV[1]\ / OL李[9][1]\ / \ / DIV[1]”,”[1]\ \ /身体/ DIV[1]\ / DIV[1]\ / DIV[1]\ / DIV[2]\ / OL[1]\ /李[3]\[1]”,”[1]\ \ /身体/ DIV [1] \ / DIV [1] \ / DIV [1] \ / DIV [2] \ / OL[1] \ /李[3]\ / DIV [1]”)}}}”对比”:{"描述”:“对比错误”,”数”:2,”项目”:{"对比”:{"id”:“对比”,”描述”:“非常低的对比”,”数”:2,”xpath”:【“[1]\ \ /身体/ DIV[1]\ / DIV[1]\ / DIV[1]\ / DIV[1]\ / OL[1]\ /李[1]\ /[1]”,”[1]\ \ /身体/ DIV[1]\ / DIV[1]\ / DIV[1]\ / DIV[1]\ / OL[1]\ /李[2]\[1]”)} } } } }

查询:

http://wave。webaim。org/api/request?关键= { yourAPIkey } url =谷歌。com&format = xml&reporttype = 3

结果:

1 200 谷歌 谷歌。com 20. 178 http://wave。webaim。org/report?url = http://google。com 错误 4 language_missing 文档语言缺失 1 # alt_spacer_missing 间隔图像丢失的替代文本 1 [1][1]/身体/中心/跨度[1]/ DIV [1] / DIV[1] /表TBODY [1] [1] / / TR [2] / TD [1] / IMG [1] link_empty 空链接 1 [1]/身体/ DIV[1]/ DIV[1]/ DIV[1]/ DIV[2]李/ OL[1]/[3]/[1] label_missing 失踪的标签形式 1 [1]/身体/ TEXTAREA[1] 警报 5 h1_missing 失踪的第一级标题 1 # title_redundant 冗余的标题文本 1 [1][1]/身体/中心/ DIV[1]/[1]/ IMG[1] label_title 标记与标题表单元素 1 [1]/身体/中心[1]/[1]/表形式TBODY [1] [1] / / TR [1] / TD [2] / DIV[1] /输入[1] link_suspicious 可疑的链接文本 1 [1]/身体/ DIV [1] / DIV [1] / DIV [1] / DIV[1]李/ OL [1] / [9] / [1] heading_skipped 跳过标题级别 1 [1]/身体/ DIV [1] / DIV [1] / DIV [1] / DIV [2] / H2 [1] 特性 1 alt_link 有关图像替代文本 1 [1][1]/身体/中心/ DIV[1]/[1]/ IMG[1] 结构元素 5 table_layout 布局表 2 [1]/身体/中心[1]/[1]/表形式TBODY [1] [1] / / TR [1] / TD [1] [1][1]/身体/中心/跨度[1]/ DIV[1]/ DIV[1]/表TBODY[1][1]/ / TR[1]/ TD[1]
    ol 有序列表 1 [1]/身体/ DIV [1] / DIV [1] / DIV [1] / DIV[1]李/ OL [1] / [1]

h2 标题级别2 1 [1]/身体/ DIV [1] / DIV [1] / DIV [1] / DIV [2] / H2 [1]

HTML5和咏叹调 4 咏叹调 咏叹调 4 [1]/身体/ DIV [1] / DIV [1] / DIV [1] / DIV[1]李/ OL [1] / [9] / [1] [1]/身体/ DIV[1]/ DIV[1]/ DIV[1]/ DIV[1]李/ OL[1]/[9]/ DIV[1] [1]/身体/ DIV[1]/ DIV[1]/ DIV[1]/ DIV[2]李/ OL[1]/[3]/[1] [1]/身体/ DIV[1]/ DIV[1]/ DIV[1]/ DIV[2]李/ OL[1]/[3]/ DIV[1] 对比的错误 2 对比 非常低的对比 2 [1][1]/身体/中心/跨度[1]/ DIV [1] / DIV[1] /表TBODY [1] [1] / / TR [1] / TD [1] / DIV [1] [1][1]/身体/中心/跨度[1]/ DIV [1] / DIV[1] /表TBODY [1] [1] / / TR [3] / TD [1] / DIV [1]

从以上结果包括所有数据,每个波包括XPath数据项。注意,这个请求API将花费3学分。。

让波文档

一个单独的API允许您查询任何波项的详细信息id(e。g。,”alt”,”alt_link_missing”,”h3”,等。)。文档API返回:

JSON文档

查询:

http://wave。webaim。org/api/docs?id = alt

结果:

{ "名称”:“alt”,”标题”:“替代文本”,”类型”:“特性”,”总结”:“图像替代文本。”,”目的”:“替代文本提供了一个图像的内容或功能屏幕阅读器用户或在其他情况下,图片无法看到或不可用。”,”行动”:“确保替代文本传达的内容和功能准确、简洁的形象。alt属性应该是等价的,准确的,和简洁。”,”细节”:“一个非空alt属性出现在一个图像。”,”指导方针”:[{”名称”:“第508条(a)”,”链接”:“http: \ / \ / webaim。org \ / 508 \ \ /标准/清单# standarda”},{ "名称”:“1.1.1非文本内容(水平)”,”链接”:“http: \ / \ / webaim。org \ / \ / wcag \ /检查表#那么标准。1.1”}]}

XML文档

查询:

http://wave。webaim。org/api/docs?id = alt&format = xml

结果:

alt 替代文本 功能 图像替代文本。。 替代文本提供了一个图像的内容或功能屏幕阅读器用户或在其他情况下,图片无法看到或不可用。。 确保替代文本传达的内容和功能准确、简洁的形象。alt属性应该是等价的,准确的,和简洁。。
一个非空alt属性出现在一个图像。。
第508条(a) http://webaim。org/standards/508/checklist # standarda 1.1.1非文本内容(水平) http://webaim。org/standards/wcag/checklist #那么。1.1