プロジェクト管理自動化の始め方

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アカウントAPIキーを使用してプロジェクトとメンバーシップ管理を自動化

Not for use with personal data

組織が多くのAxe Developer Hubプロジェクトを管理したり、寄稿者のオンボーディングやオフボーディングを頻繁に行ったりする場合、Axe Developer HubのUIをクリックする代わりにプロジェクトAPIを使ってその作業を自動化できます。

note

新しい資格情報は必要ありません。管理自動化には、Axe Developer Hubの他のREST APIで既に使用しているAxeアカウントAPIキーを使用します。これにはセッションと結果APIとコミットステータスAPIが含まれます。すでにAxe Developer Hubにテスト結果を送ることができるなら、必要なものはすでに揃っています。

自動化できること

APIキーを使用して、自動化で以下のことができます：

プロジェクトの作成、更新、削除。
組織内のすべてのプロジェクト（組織の管理者として）または所属するすべてのプロジェクトをリストアップ。
プロジェクトのメンバーをリストし、役割を持たせてメンバーを追加し、メンバーの役割を変更し、メンバーを削除。

プロジェクトAPIリファレンスを参照して、各操作のリクエストとレスポンスの詳細を確認してください。

始める前に

プロジェクトの作成には、そのプロジェクトタイプの有効なサブスクリプション（ライセンス）が必要です。プロジェクトを作成した人は自動的にそのプロジェクトの管理者になります。
プロジェクトの役割には管理者とメンバーがあります。プロジェクト管理者はプロジェクトを更新または削除し、メンバーシップを管理できます。プロジェクトメンバーはプロジェクトにアクセスできますが、プロジェクトやそのメンバーシップを管理することはできません。
組織管理者は、自分のプロジェクトメンバーシップに関係なく、組織のライセンスがあるすべてのプロジェクトを表示および管理できます。既存のプロジェクトを表示、更新、削除、または管理するために個人のライセンスは必要ありません。プロジェクトの作成は唯一の例外です：呼び出し元が組織管理者であっても、常に有効なライセンスが必要です。
プロジェクトにメンバーを追加するために、そのメンバーがライセンスを持っている必要はありません。APIは彼らを即座にプロジェクトメンバーとして記録しますが、ライセンスを取得するまでプロジェクトにアクセスすることはできません。対象のユーザーはすでに組織に所属している必要があります。組織メンバーでない人を追加することはできません。
プロジェクトを削除すると最終的になります。 削除されたプロジェクトを自己修復する方法はありません。

各プロジェクトタイプは、test_languageとtest_platformの特定の値のみを受け付け、プロジェクトタイプ設定値にリストされています。注意してタイプを選んでください：プロジェクトが作成された後にそのタイプを変更することはできません。

APIキーを取得する

Axeアカウントポータルにサインイン。
ウェブまたはCI/CDプロジェクト用のAxe Developer Hub APIキー、またはモバイルプロジェクト用のAxe DevTools Mobile APIキーをコピーします。このキーのX-API-Keyヘッダー値をプロジェクトAPIへのすべてのリクエストに使用します。

最初のプロジェクトを自動で作成する

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "name": "webapp-ci",
    "selected_project_type": "axe-devtools-watcher",
    "test_language": "typescript",
    "test_platform": "Playwright"
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects"

レスポンスには新しいproject_idが含まれています。それを保存してください：このプロジェクトに関連する後続のすべての呼び出し、テスト結果の送信を含め、必要になります。

プロジェクトにチームメイトを追加する

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-API-Key: $API_KEY" \
  -d '{
    "user_email_role_pairs": [
      { "user_email": "sam@example.com", "role": "member" }
    ]
  }' \
  "https://axe.deque.com/api-pub/v1/results/projects/$PROJECT_ID/memberships"

各ユーザーをAxeアカウントのメールアドレスで識別します。対象のユーザーはすでに組織に所属している必要があります。彼らを追加するためにライセンスを持っている必要はありませんが、持っていないとプロジェクトにアクセスできません。

次のステップ

プロジェクトAPIリファレンスで、フルエンドポイントリファレンスを確認し、プロジェクトの取得、更新、削除、およびバッチ操作によるスケールでのメンバーシップ管理を行います。
セッションと結果APIリファレンスで、自動化されたプロジェクトがアクセシビリティ結果を生成し始めた際に、結果を取得します。