Web Accessibility API
スケーリングに最適化されたWeb Accessibility 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]JSONの代わりにデータをCSVとして扱います。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 stringWebサイトの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 stringWebサイトの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 stringWebサイトの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 Webサイトの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 booleanExcel形式でレポートをダウンロードします。csv booleanJSONの代わりにデータをCSVとして扱います。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 Webサイトの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 stringWebサイトのURL。curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'
デフォルトでは、A11yWatch APIドキュメントには、APIとのHTTPでの相互作用にcURLを使用する方法が示されています。ほとんどのルートでは、URLまたは本文からパラメータを送信できます。一部のパラメーターは配列で設定され、その他の形式もあります。HTTP PUTおよびPOSTリクエストを送信する場合は、本文の使用に限定することをお勧めします。この例では、a11ywatch.comをスキャンしたいWebサイトに置き換えてください。A11yWatchをCIで使用することで、本番リリース前に意識を高めることで、開発コストを大幅に削減できます。
自信を持って包括的でいましょう
手頃で高速な自動化されたWebアクセシビリティツールに関する詳細は、A11yWatchで今すぐ始めてください。