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

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

次のステップ

Axe Developer Hub API を始めようは認証、エラーハンドリング、同じAPIキーで自動化できる他の作業について。
プロジェクトAPIリファレンスには、プロジェクトの取得、更新、削除、メンバーシップをバッチ操作で大規模に管理するための完全なエンドポイントリファレンスが含まれています。
セッションと結果APIリファレンスは、あなたの自動化されたプロジェクトがアクセシビリティ結果を生産し始めた際に、それらを取得するための方法について。