Web 可存取性 API
針對可擴展性進行最佳化的 Web 可存取性 API。
欲使用 A11yWatch API，請在授權標頭中加入 JWT 格式的 Bearer TOKEN。有關更多資訊，請參閱 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 或主體中發送參數。 HTTP PUT 和 POST 請求最好使用主體，因為必須將某些參數設定為陣列，而其它參數也可能使用不同的格式。在這個範例中，請將 a11ywatch.com 替換成您想掃描的網站。透過在 CI 中使用 A11yWatch，您可以在正式發布之前增加認知度，從而大幅削減開發成本。
以自信保持包容性
現在就開始使用 A11yWatch，體驗自動化、高效和可訪問的網絡可訪問性工具。