axe Monitor API", "context": "frontmatter field: title

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

紹介", "context": "heading level 2

axe Monitor APIは、開発者がaxe Monitorのユーザーインターフェース外でアクセシビリティテストの結果データとやり取りするための簡素化された方法を提供します。RESTfulウェブサービスを使用して、APIは以下へのアクセスを提供します。", "context": "paragraph

  • ユーザーのスキャン", "context": "paragraph
  • スキャンの実行履歴", "context": "paragraph
  • スキャン実行のページ詳細", "context": "paragraph
  • スキャン実行の問題詳細", "context": "paragraph
  • ページの問題詳細", "context": "paragraph

ライセンスを持つaxe Monitorユーザーは、サブスクリプションライセンス契約に従えば、外部のアプリケーションでAPIを使用できます。", "context": "paragraph

はじめに", "context": "heading level 2

  1. axeアカウントを通じてAPIキーを作成します。", "context": "paragraph

    以下の地域別の指示を参照してください。", "context": "paragraph

    APIキーを生成するには、以下の手順を行います。", "context": "paragraph

    • axeアカウントのAPIキーのページで、「新しいAPIキーを追加」ボタンを選択します。", "context": "paragraph
      「新しいAPIキーを追加」のダイアログが表示されます。", "context": "paragraph

    • 製品のドロップダウンからaxe Monitorを選択し、APIキーに名前を付け、「保存」ボタンを選択します。", "context": "paragraph

    • 操作列の下にAPIキーをクリップボードにコピーします。", "context": "paragraph

  2. APIのベースURLを入力:", "context": "strong text お好みのAPIプラットフォーム、例えばPostmanやSwaggerUI、または勤務ディレクトリを使用し、axe Monitor APIにアクセスします。「yourcompany」をaxe Monitorインスタンスのサブドメインと置き換えてください。", "context": "paragraph

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

ヘッダーを追加:", "context": "strong text

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

X-API-Key: <your_api_key>

オプションのヘッダー・パラメータ", "context": "heading level 3

名前", "context": "table cell タイプ", "context": "table cell 説明", "context": "table cell
X-Pagination-Per-Page", "context": "table cell 整数", "context": "table cell 1ページに返されるアイテムの最大数。デフォルト値: 10", "context": "table cell
X-Pagination-Page", "context": "table cell 整数", "context": "table cell 要求されたページ番号。デフォルト値: 1", "context": "table cell

CURLリクエストの例", "context": "heading level 3

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>'

エンドポイント", "context": "heading level 2

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

エンドポイント", "context": "table cell 目的
/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 String ソートする列を指定します（タイトル、URL）。デフォルト値はタイトルです。
order String ソート方向を指定します（昇順または降順）。デフォルト値は降順です。

応答例

{
  "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 String スキャンの一意の識別子。
runNumber Integer スキャンの特定の実行番号。
pageId String ページの一意の識別子。

オプションパラメータ

名前 タイプ 説明
status string ステータスで問題をフィルターします（オープン、修正済み、または無視された）。
sortBy String ソートする列を指定します（testPageTitle、testUrl、selector、createdAt、またはstatus）。デフォルト値はtestPageTitleです。
order String ソート方向を指定します（昇順または降順）。デフォルト値は降順です。

応答例

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "string",
      "description": "string",
      "help": "string",
      "helpUrl": "string",
      "impact": "string",
      "issuegroup”: “string"
      "needsReview": true,
      "isExperimental": true,
      "isManual": true,
      "summary": "string",
      "selector": [
        "string"
      ],
      "source": "string",
      "tags": [
        "string"
      ],
      "igt": "string",
      "testName": "string",
      "createdAt": "2024-12-02T14:59:24.232Z",
      "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 String はい スキャンの一意の識別子。
runNumber 整数 はい スキャンの特定の実行番号。

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

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

レスポンスの例

{
  "issues": [
    {
      "issueId": 0,
      "ruleId": "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": "2025-08-07T10:54:30.268Z",
      "testUrl": "string",
      "testPageTitle": "string",
      "status": "string"
    }
  ]
}

エラー

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

Is this page helpful?

Help us improve this page

Still need help?