APIによるID取得
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のユーザーは、Axe Account内でAPIキーを生成し、ユーザーインターフェースを使用せずに他のAxe Monitor APIエンドポイントで必要となるIDを検索することができます。
始めにについて詳しく学んでください。
エンドポイント
| メソッド | エンドポイント | 目的 |
|---|---|---|
| GET | /lookups/presets |
プリセットをスキャンに適用するためのプリセットIDを取得します。また、スキャンが現在プリセットに割り当てられている場合、編集可能なフィールドを確認します。 |
| GET | /lookups/teams |
チーム名とIDを取得して、API経由でスキャンにアクセスを提供します。 |
| GET | /lookups/scans |
スキャン名とIDを取得して、結果を取得、編集、またはスキャンを実行します。 |
| GET | /scans/[scanId]/runs |
スキャンの全ランを一覧表示し、スキャンの概要情報を提供します。これにより、runIdを取得できます。 |
| GET | /lookups/scan-groups |
スキャンをAPI経由で組織化するために、スキャングループ名とIDを取得します。 |
| GET | /lookups/scripts |
共有スクリプトをAPIを通じてスキャンに割り当てるためのIDを取得します。 |
プリセット
プリセット設定をAPI経由でスキャンに適用できますが、まずプリセットIDと名前が必要です。このエンドポイントを使ってそれらを検索してください。
プリセットIDも、プリセットがすでに適用されている場合に編集可能なスキャン設定を理解するために必要です。
リクエスト例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/presets
X-API-Key: <your_api_key>
Content-Type: application/jsonレスポンス例
ステータス：200 成功
{
"presets": [
{ "id": 3, "name": "Gov Baseline" },
{ "id": 1, "name": "Marketing sites" }
]
}チーム
APIを通じてスキャンを作成または編集する際にチームの権限を割り当てることができます。このエンドポイントを使用して、チーム名とIDを検索してください。
リクエスト例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/teams
X-API-Key: <your_api_key>
Content-Type: application/jsonレスポンス例
ステータス：200 成功
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "Accessibility" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "Web Platform" }
]
}スキャン
スキャンIDと名前は結果の取得、編集、およびスキャンの実行に必要です。このエンドポイントを利用してそれらを検索してください。
リクエスト例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scans
X-API-Key: <your_api_key>
Content-Type: application/jsonレスポンス例
ステータス：200 成功
{
"teams": [
{ "id": "8f14e45f-ceea-467f-a8f5-6f0b1d6c2b7e", "name": "French Marketing Site" },
{ "id": "c9f0f895-fb98-4b91-9c1e-5f2a2d7c3e11", "name": "My Account Platform" }
]
}スキャンラン
スキャンランIDは、このエンドポイントで取得して詳細な結果データを得ることができます。
リクエスト例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/scans/[scanId]/runs
X-API-KEY: <your_api_key>レスポンス例
{
"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
}
]
}
]
}スキャングループ
APIからスキャンを作成または編集する際、スキャングループでスキャンを整理することができます。このエンドポイントを使用してスキャングループIDと名前を検索してください。
リクエスト例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scan-groups
X-API-Key: <your_api_key>
Content-Type: application/jsonレスポンス例
ステータス：200 成功
{
"scanGroups": [
{ "id": 1234, "name": "Marketing" },
{ "id": 1200, "name": "Storefront" }
]
}共有スクリプト
Axe Monitorの管理セクションに保存され、複数のスキャンで使用される共有スクリプトを、APIを通じてスキャンを作成または編集する際に適用できます。このエンドポイントを使用して共有スクリプトIDを検索してください。
リクエスト例
GET
https://yourcompany.dequecloud.com/monitor-public-api/v1/lookups/scripts
X-API-Key: <your_api_key>
Content-Type: application/jsonレスポンス例
ステータス：200 成功
{
"scripts": [
{ "id": 12, "name": "Dismiss cookie banner", "type": "TASK" },
{ "id": 9, "name": "SSO login", "type": "SESSION" }
]
}