axe Monitor 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

Not for use with personal data

はじめに

axe Monitor APIは、開発者がaxe Monitorユーザーインターフェース外でアクセシビリティテスト結果データを操作するための効率的な方法を提供します。RESTfulなウェブサービスを利用して、APIは以下にアクセスを提供します：

ユーザー用スキャン
スキャンのスキャン実行
スキャン実行のページ詳細
スキャン実行の詳細情報
ページの詳細情報

ライセンスを持つaxe Monitorのユーザーは、サブスクリプションライセンス契約に準拠する限り、外部アプリケーションとAPIを使用できます。

はじめに

APIキーをaxeアカウントで作成してください。

以下の地域別の指示に従ってください：
- US地域のaxeアカウント: axe.deque.com - APIキーを作成するには、このリンクをクリックしてください: APIキーを作成.
- EU地域のaxeアカウント: axe-eu.deque.com - APIキーを作成するには、このリンクをクリックしてください: APIキーを作成.
- AUS地域のaxeアカウント: axe-au.deque.com - APIキーを作成するには、このリンクをクリックしてください: APIキーを作成.
APIキーを生成するために、以下の手順を行ってください：
- axeアカウントのAPIキーのページで、「新しいAPIキーを追加」ボタンを選択します。
  「新しいAPIキーを追加」のダイアログが表示されます。
- 製品のドロップダウンからaxe Monitorを選択し、APIキーに名前を付けた後、保存ボタンを選択します。
- アクション列の下でAPIキーをクリップボードにコピーします。
APIベースURLを入力： お好みのAPIプラットフォーム（PostmanやSwaggerUIなど）または作業ディレクトリを使用して、axe Monitor APIにアクセスします。「yourcompany」をaxe Monitorインスタンスのサブドメインに置き換えてください。

https://yourcompany.dequecloud.com/monitor-public-api/v1/{endpoint}

ヘッダーを追加：

APIにアクセスするには、axeアカウントからのAPIキーを使用して認証する必要があります。

X-API-Key: <your_api_key>

オプションヘッダーパラメータ

名前	型	説明
X-Pagination-Per-Page	整数	1ページで返される最大アイテム数。デフォルト値: 10
X-Pagination-Page	整数	要求されたページ番号。デフォルト値: 1

CURLリクエスト例

curl -X 'GET' \
  'https://{base_url}/monitor-public-api/v1/scans/1/runs/1/issues?sortBy=testPageTitle&sortDir=desc' \
  -H 'accept: application/json' \
  -H 'X-API-Key: <your_api_key>'

エンドポイント

すべてのエンドポイントは、GETリクエストで情報を取得できます。

エンドポイント	目的
`/scans`	ユーザーがアクセスできるすべてのスキャンを一覧表示します。`scanId.`を取得することができます
`/scans/[scanId]/runs`	スキャンのすべての実行を、スキャンの概覧情報と共に一覧表示します。`runId.`を取得することができます
`/scans/[scanId]/runs/[runId]/pages`	スキャン実行の詳細なページ情報
`/scans/[scanId]/runs/[runId]/pages/[pageId]/issues`	ページの詳細なアクセシビリティの問題
`/scans/[scanId]/runs/[runId]/issues`	スキャン実行の詳細なアクセシビリティの問題

ユーザーのスキャン一覧

例: リクエスト

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans
X-API-Key: <your_api_key>

応答例

{
  "scans": [
    "id": 1,
    "name": "Test Scan",
    "groups": [
        "id": 1,
        "name": "Group A"
    ]
  ]
}

エラー応答例

スキャンのスキャン実行

例: リクエスト

GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>

必須パラメータ

名前	型	説明
scanId	文字列	スキャンのユニークな識別子です。

オプションのパラメータ

名前	型	説明
needsReview	文字列	「true」または「false」は、「レビューが必要」な問題がレスポンスにカウントされるかどうかを制御します。

応答例


{
  "scanRuns": [
    {
      "runNumber": 1,
      "status": "Completed",
      "queuedAt": "2025-08-21T06:50:27Z",
      "startedAt": "2025-08-21T06:50:37Z",
      "completedAt": "2025-08-21T06:51:52Z",
      "axeVersion": "4.10.3",
      "standard": "WCAG 2.1 AA",
      "score": 0,
      "issues": {
        "total": 392,
        "critical": 77,
        "serious": 315,
        "moderate": 0,
        "minor": 0
      },
      "pages": {
        "total": 18,
        "completed": 17,
        "critical": 17
      },
      "violationGroups": [
        {
          "name": "color",
          "pageCount": 17
        },
        {
          "name": "forms",
          "pageCount": 17
        },
        {
          "name": "name-role-value",
          "pageCount": 10
        },
        {
          "name": "parsing",
          "pageCount": 1
        },
        {
          "name": "text-alternatives",
          "pageCount": 13
        }
      ]
    }
  ]
}

注: スキャンに「テキスト検索」設定で1つ以上のフレーズが入力されている場合、API応答にはfindText配列が含まれます。

各エントリには以下が含まれます：

入力されたフレーズ。
フレーズが特定されたページ数。

スキャン実行のページ詳細

例: リクエスト

GET https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages
 X-API-KEY: <your_api_key>

必須パスパラメータ

名前	型	説明
scanId	文字列	スキャンのユニークな識別子です。
runNumber	整数	スキャンの特定のラン番号。

オプションのリクエストパラメーター

名前	型	説明
status	文字列	ステータス（完了、失敗）によってページをフィルターします。
sortBy	文字列	ソートする列を指定します（タイトル、URL）。デフォルト値はタイトルです。
order	文字列	並べ替えの方向を指定します（asc または desc）。デフォルト値は desc です。

応答例

{
  "pages": [
    {
      "id": 0,
      "url": "string",
      "title": "string",
      "reasonForFailure": "string",
      "totalCriticalIssues": 0,
      "totalSeriousIssues": 0,
      "totalModerateIssues": 0,
      "totalMinorIssues": 0,
      "totalNeedsReview": 0,
      "totalFixedIssues": 0,
      "totalOpenIssues": 0,
      "health": "string",
      "status": "string",
      "scriptName": "string",
      "scriptStep": 0,
      "template": true,
      "date": "2024-12-02T15:03:40.211Z",
      "domainUrl": "string"
      "findtext"
[     "Accessibility Statement",
      "WCAG"

    }
  ]
}

注: スキャンの「テキスト検索」設定が有効な場合、そのページで識別されたすべてのフレーズを配列に含めます。

ページの詳細情報

例: リクエスト

GET 
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs/[runNumber]/pages/[pageId]/issues
X-API-KEY: <your_api_key>

必須パラメータ

名前	型	説明
scanId	文字列	スキャンのユニークな識別子です。
runNumber	整数	スキャンの特定のラン番号。
pageId	文字列	ページのユニークな識別子です。

オプションのパラメータ

名前	型	説明
status	文字列	ステータス（open、fixed、または ignored）で問題をフィルタします。
sortBy	文字列	並べ替える列を指定します（testPageTitle、testUrl、selector、createdAt、または status）。デフォルト値は testPageTitle です。
order	文字列	並べ替えの方向を指定します（asc または desc）。デフォルト値は desc です。

応答例

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "axeRuleId": "string",
      "description": "string",
      "help": "string",
      "helpUrl": "string",
      "impact": "string",
      "issueGrouping": "string",
      "needsReview": true,
      "isExperimental": true,
      "isManual": true,
      "summary": "string",
      "selector": [
        "string"
      ],
      "source": "string",
      "tags": [
        "string"
      ],
      "igt": "string",
      "testName": "string",
      "createdAt": "2026-07-10T06:17:38.854Z",
      "testUrl": "string",
      "testPageTitle": "string",
      "status": "string"
    }
  ]
}

スキャン実行の詳細情報

例: リクエスト


GET 
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/{scanId}/runs/{runNumber}/issues
X-API-KEY: <your_api_key>

必須パラメータ

名前	型	必須	説明
scanId	文字列	はい	スキャンのユニークな識別子です。
runNumber	整数	はい	スキャンの特定のラン番号。

オプションのリクエストパラメーター

名前	型	必須	説明
status	文字列	いいえ	ステータス（open、fixed、または ignored）で問題をフィルタします。
sortBy	文字列	いいえ	並べ替える列を指定します（testPageTitle、testUrl、selector、createdAt、または status）。デフォルト値は testPageTitle です。
order	文字列	いいえ	並べ替えの方向を指定します（asc または desc）。デフォルト値は desc です。

応答例

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "axeRuleId": "string",
      "description": "string",
      "help": "string",
      "helpUrl": "string",
      "impact": "string",
      "issueGrouping": "string",
      "needsReview": true,
      "isExperimental": true,
      "isManual": true,
      "summary": "string",
      "selector": [
        "string"
      ],
      "source": "string",
      "tags": [
        "string"
      ],
      "igt": "string",
      "testName": "string",
      "createdAt": "2026-07-10T06:17:38.854Z",
      "testUrl": "string",
      "testPageTitle": "string",
      "status": "string"
    }
  ]
}

エラー

HTTPステータスコード	エラータイプ	説明
401	認証されていない	ユーザーは認証されていないか、アクセス権がありません。
400	無効なリクエスト	リクエストには無効なパラメーターが含まれています。
500	内部サーバーエラー	リクエストの処理中にエラーが発生しました。

axe Monitor API

はじめに

はじめに

ヘッダーを追加：

オプションヘッダーパラメータ

CURLリクエスト例

エンドポイント

ユーザーのスキャン一覧

例: リクエスト

応答例

スキャンのスキャン実行

例: リクエスト

必須パラメータ

オプションのパラメータ

応答例

スキャン実行のページ詳細

例: リクエスト

必須パスパラメータ

オプションのリクエストパラメーター

応答例

ページの詳細情報

例: リクエスト

必須パラメータ

オプションのパラメータ

応答例

スキャン実行の詳細情報

例: リクエスト

必須パラメータ

オプションのリクエストパラメーター

応答例

エラー

Is this page helpful?

Help us improve this page

Still need help?