プロジェクト API リファレンス

Projects APIを使用すると、Axe Developer Hubプロジェクトとそのメンバーシップをプログラムで管理できます。Axe Developer Hubの他のREST APIで使用するのと同じAxeアカウントAPIキーを利用します。プロジェクト管理には別の認証情報は必要ありません。ステップバイステップの説明はプロジェクト管理の自動化を始めようを参照してください。

プロジェクトの ID をその名前から見つけて セッションと結果 API を呼び出したい場合は、以下の プロジェクト一覧 を参照してください。すでにプロジェクト ID を知っている場合は、Axe Developer Hub で見つけて、Sessions と Results API を直接呼び出すことができます。

認証

すべてのリクエストには API キーが必要です。X-API-Key ヘッダーを使用して提供してください:

X-API-Key: <DEQUE_API_KEY>

APIキーはAxe アカウントポータルで確認できます。WebまたはCI/CDプロジェクトにはAxe Developer Hub APIキーを選びます。モバイルプロジェクトにはAxe DevTools Mobile APIキーを選びます。

APIキーは秘密として扱ってください: リクエストにハードコーディングするのではなく、環境変数やCI/CDプラットフォームのシークレットストアに保存してください。

アクセス制御と権限

• プロジェクトの作成には、そのプロジェクトタイプのアクティブなサブスクリプション（ライセンス）が必要です。プロジェクトを作成した人は自動的にそのプロジェクトの管理者になります。
• プロジェクトの役割には、管理者とメンバーがあります。プロジェクト管理者はプロジェクトを更新または削除したり、そのメンバーシップを管理したりできます。プロジェクトメンバーはプロジェクトへのアクセスはできますが、管理やメンバーシップの管理はできません。
• 組織管理者は、組織のライセンスがあるすべてのプロジェクトを、自己のプロジェクトメンバーシップに関係なく表示および管理できます。既存プロジェクトの閲覧、更新、削除、またはメンバーの管理には個人ライセンスは必要ありません。プロジェクト作成は唯一の例外です: 呼び出し者が組織管理者であるかどうかに関係なく、常にアクティブなライセンスが必要です。
• プロジェクトにメンバーを追加するには、そのメンバーがライセンスを持っている必要はありません。APIはそのメンバーを即座にプロジェクトメンバーとして記録しますが、ライセンスを保有するまでプロジェクトにアクセスすることはできません。対象ユーザーは既に組織に所属している必要があります。組織メンバーでない人を追加することはできません。
• プロジェクトを削除すると最終的なものです。 削除されたプロジェクトのセルフサービスによる復元はありません。
• すべての場合において、応答はAPIキーのプロダクトにスコープされます。Axe Developer Hub APIキーはAxe Developer Hub（Web）プロジェクトのみを返し、管理します。Axe DevTools Mobile APIキーはAxe DevTools Mobileプロジェクトのみを返し、管理します。

非アクティブなサブスクリプション が401 Unauthorizedを返します。

プロジェクトタイプ設定値

すべてのプロジェクトにはselected_project_typeがあり、各タイプは固有の固定されたtest_language / test_platform値のみを受け入れます:

プロジェクトのselected_project_typeは、プロジェクトの作成時に固定されます。別のタイプを使用するには、新しいプロジェクトを作成してください。

プロジェクト一覧

認証された API キーでアクセス可能なプロジェクトのリストを返します。

リクエスト

• エンドポイント: GET https://axe.deque.com/api-pub/v1/results/projects
• ヘッダー（必須）:
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

クエリパラメータ

すべてのクエリパラメータは任意です。

レスポンスボディ

成功したレスポンスは、プロジェクトオブジェクトの JSON 配列を返します。各プロジェクトオブジェクトには、以下のフィールドが含まれます。

応答にはここに記載されていない追加フィールドが含まれることがあり、新しいフィールドが時間と共に追加される場合があります。認識できないフィールドは無視し、非公開フィールドに依存しないでください。

例の応答ボディ

[
  {
    "project_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "test_language": "typescript",
    "test_platform": "Playwright",
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-06-01T14:23:00.000Z",
    "updated_at": "2026-06-10T16:45:00.000Z",
    "run_by": "Jane Developer",
    "last_session_created_at": "2026-06-14T09:12:00.000Z",
    "has_git_information": true,
    "git_url": "https://github.com/example/webapp",
    "latest_session": {
      "id": "0d4a85a2-9e6f-44ef-b814-fee8412abeb0",
      "created_at": "2026-06-14T09:12:00.000Z",
      "git_branch": "main"
    }
  },
  {
    "project_id": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
    "name": "design-system",
    "selected_project_type": "axe-devtools-html",
    "test_language": null,
    "test_platform": null,
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-05-20T08:00:00.000Z",
    "updated_at": null,
    "run_by": null,
    "last_session_created_at": null,
    "has_git_information": false,
    "git_url": null,
    "latest_session": null
  },
  {
    "project_id": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f",
    "name": "ios-app-ci",
    "selected_project_type": "axe-devtools-mobile",
    "test_language": null,
    "test_platform": "XCUITest",
    "role": "admin",
    "user_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "enterprise_id": "3f2b8e1a-6c4d-4f7e-9a0b-1d2c3e4f5a6b",
    "is_enterprise_project": true,
    "created_at": "2026-06-03T10:15:00.000Z",
    "updated_at": null,
    "run_by": "Jane Developer",
    "last_session_created_at": "2026-06-15T11:05:00.000Z",
    "has_git_information": false,
    "git_url": null,
    "latest_session": {
      "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
      "created_at": "2026-06-15T11:05:00.000Z",
      "git_branch": null
    }
  }
]

例を短くするために、各latest_sessionオブジェクトはそのフィールドのうちの3つだけを表示しています。APIはそれ以上を返します。

カーソルページネーション

ページネーションはオプトインです。page_sizeやafterを送らずに、応答はカーソルヘッダーなしで完全なプロジェクトリストを単一のレスポンスで返します。

結果をページングするには、Projects APIはセッションエンドポイントと同じカーソルベースのページネーションを使用します。現在のページの先にさらなる結果がある場合、応答はx-pagination-cursorヘッダーに不透明なカーソル値を返します。次のリクエストでこの値をafterクエリパラメータとして渡し、次のページを取得してください。

応答にx-pagination-cursor ヘッダーがない場合、最終ページにいます。

プロジェクトIDを名前で検索する

この例では、curlとjqを使用してプロジェクトのIDを名前から見つけます。

curl -s \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  "https://axe.deque.com/api-pub/v1/results/projects" \
  | jq -r '.[] | select(.name == "webapp-ci") | .project_id'

そのプロジェクトのセッションを一覧表示するために、返されたIDをセッションエンドポイントに渡します。

プロジェクト一覧エラーレスポンス

プロジェクトの取得

単一のプロジェクトをIDによって返します。同じ形式でプロジェクト一覧 が含まれます。

リクエスト

• エンドポイント: GET https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• ヘッダー（必須）:
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

プロジェクト取得エラーレスポンス

プロジェクトの作成

リクエスト

• エンドポイント: POST https://axe.deque.com/api-pub/v1/results/projects
• ヘッダー（必須）:
  • X-API-Key: <DEQUE_API_KEY>
  • Content-Type: application/json
  • Accept: application/json

リクエストボディ

リクエストボディの例

{
  "name": "webapp-ci",
  "selected_project_type": "axe-devtools-watcher",
  "test_language": "typescript",
  "test_platform": "Playwright"
}

レスポンスボディ

作成されたプロジェクトを返し、プロジェクト一覧 と同じ形式です。プロジェクトを作成した人は自動的にプロジェクト管理者になるため、別途メンバーシップの呼び出しは不要です。作成が成功すると201 Created が返されます。

プロジェクト作成エラーレスポンス

プロジェクトの更新

リクエスト

• エンドポイント: PATCH https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• ヘッダー（必須）:
  • X-API-Key: <DEQUE_API_KEY>
  • Content-Type: application/json
  • Accept: application/json

リクエストボディ

リクエストボディの例

{
  "name": "webapp-ci-renamed"
}

レスポンスボディ

更新されたプロジェクトを返し、プロジェクト一覧 と同じ形式です。更新が成功すると200 OK が返されます。

プロジェクト更新エラーレスポンス

プロジェクトの削除

リクエスト

• エンドポイント: DELETE https://axe.deque.com/api-pub/v1/results/projects/{project_id}
• ヘッダー（必須）:
  • X-API-Key: <DEQUE_API_KEY>
  • Accept: application/json

レスポンスボディ

{ "deleted": true }

プロジェクト削除エラーレスポンス

プロジェクトメンバーシップ

プロジェクトのメンバーシップはプロジェクトのサブリソースです。プロジェクト管理者はプロジェクトとそのメンバーシップを管理できます。プロジェクトメンバー（以下のメンバーシップ操作でのmember ロール）は、プロジェクトにアクセスできますが、管理することはできません。メンバーシップ操作ではメールアドレスでユーザーを識別します。メンバーを追加する際、そのメンバーがライセンスを保有する必要はありません。APIはすぐにそれを記録しますが、ライセンスを保有するまでプロジェクトにアクセスできません。対象ユーザーはすでにあなたの組織に所属している必要があります。 組織メンバーでない人物を追加することはできません。

可能な限り以下のバッチ操作を使用してください。 すべての書き込み操作は1回の呼び出しで複数のユーザーを受け付けます。これにより必要なリクエスト数が減ります。大規模な組織のメンバーシップを管理する場合、429 レスポンスを受け取ったらバックオフとリトライを適用してください。一般的なパターンについては429 Too Many Requests を参照してください。

プロジェクトメンバーの一覧

• エンドポイント: GET https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• ヘッダー（必須）: X-API-Key: <DEQUE_API_KEY>、Accept: application/json

レスポンスボディ

{
  "members": [
    {
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "role": "admin",
      "email": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "active_license": true,
      "created_at": "2026-06-01T14:23:00.000Z"
    }
  ]
}

プロジェクトメンバーの追加

• エンドポイント: POST https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• ヘッダー（必須）: X-API-Key: <DEQUE_API_KEY>, Content-Type: application/json, Accept: application/json

リクエストボディ

{
  "user_email_role_pairs": [
    { "user_email": "sam@example.com", "role": "member" },
    { "user_email": "alex@example.com", "role": "admin" }
  ]
}

user_emailはユーザーのAxeアカウントのメールアドレスです。一致は大文字小文字と周囲のスペースを無視します。roleはadminまたはmemberを受け入れます（contributorはmemberの同義語としても受け入れられます）。各ユーザーはリクエストで一度だけ表示されます。既にプロジェクトメンバーであるユーザーを追加しても、そのエントリに対しては何も行われません：既存の役割は変更されません。これは一括操作です。無効なエントリはリクエスト全体を拒絶し、APIは何も書き込みません。エラーメッセージは失敗したすべてのエントリをリストするので、一回の操作でバッチを修正できます。

成功したリクエストは、実際に新しいメンバーシップが追加されたかどうかにかかわらず、201 Createdと{ "created": true }を返します。

メンバーの役割変更

• エンドポイント: PATCH https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships
• ヘッダー（必須）: X-API-Key: <DEQUE_API_KEY>, Content-Type: application/json, Accept: application/json
• リクエストボディ: user_email_role_pairsの形状はプロジェクトメンバーの追加と同じ

各user_emailは、プロジェクトの現在のメンバーでなければなりません。プロジェクトは常に少なくとも1人のadminを保持する必要があります。プロジェクトに管理者がいなくなるリクエストはAPIが拒絶します。唯一の残りのメンバーであるプロジェクトの唯一の管理者は、自分自身の役割を変えることはできません。これは一括操作です。無効なエントリはリクエスト全体を拒絶し、APIは何も書き込みません。

成功したリクエストは、200 OKと{ "ok": true }を返します。

プロジェクトメンバーの削除

• エンドポイント: DELETE https://axe.deque.com/api-pub/v1/results/projects/{project_id}/memberships?user_emails={comma-separated,url-encoded,emails}
• ヘッダー（必須）: X-API-Key: <DEQUE_API_KEY>、Accept: application/json

削除するユーザーのメールアドレスをカンマで区切ったリストとして単一のuser_emailsクエリパラメータで渡し、値をURLエンコードします。例えば、エンコードされていないアドレス内のリテラル+はスペースとして到着し、不正な形式として拒絶されます。リクエストボディはありません。メンバーでないユーザーを削除しても成功し、何も削除されないため、再試行されたリクエストはエラーではありません。プロジェクトは常に少なくとも1人のadminを保持する必要があります。プロジェクトの最後の管理者を削除するリクエストをAPIは拒絶します。唯一の残りのメンバーであるプロジェクトの唯一の管理者は、自分自身を削除することはできません。

成功したリクエストは、削除されたアドレスとメンバーと一致しなかったアドレスを200 OKと共に返し、入力ミスと完了した削除を区別できます：

{
  "deleted": true,
  "removed": ["sam@example.com"],
  "unmatched": ["alx@example.com"]
}

プロジェクトメンバーシップエラー応答