Axe Developer Hub API
This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard
Axe Developer Hubで利用可能なREST APIの概要
Not for use with personal data
Axe Developer Hubは、既存のAxeアカウントAPIキーで呼び出せる一連のREST APIを公開しています。これらのAPIには別個の認証情報は必要ありません。それらを使用して、CI/CDパイプラインのアクセシビリティステータスを制御したり、プログラムでアクセシビリティ結果を取得したり、プロジェクトを作成、管理、参照したりすることができます。
どのAPIを使用すればいいのか？
| やりたいこと... | 使用するもの... |
|---|---|
| 認証の設定、プロジェクトIDの確認、初回の呼び出し | Axe Developer Hub APIの開始 |
| プロジェクトとそのメンバーを作成および管理し、プロジェクトを一覧表示する、または名前からプロジェクトIDを検索する | プロジェクトAPIリファレンス |
| ステップバイステップでプロジェクト作成とメンバー管理を自動化する | プロジェクト管理の自動化を始める |
| アクセシビリティのエラーが見つかった場合に、GitHub以外のCI/CDパイプライン（GitLab、BitBucketなど）でプルリクエストやコミットを失敗させる | コミットステータスAPIリファレンス |
| GitHubパイプラインでも同じことを行う | REST APIを直接呼び出す代わりにGitHubアクションを使用するを使用する |
| セッションの完全なアクセシビリティ結果を取得する、またはプロジェクトのセッション一覧を表示する | セッションと結果APIリファレンス |
| 古いインテグレーションのようにサマリーレポートをダウンロードする | 代わりにセッションと結果APIに移行プログラムで結果を取得する（非推奨）してください |
認証の概要
このリストにあるすべてのAPIは、AxeアカウントAPIキーをX-API-Keyヘッダーに含めて同じ方法で認証します。キーの取得やプロジェクトIDの確認、最初の呼び出しについてはAxe Developer Hub APIの開始を参照してください。