> For the complete documentation index, see [llms.txt](https://help.aximo.autify.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.aximo.autify.com/features-ja/test-execution-and-plans/api-cicd-integration.md).

# APIトリガーでの実行

Aximo の API トリガーを使うと、CI/CD パイプラインや任意のスクリプトからケースやプランを実行できます。

API のエンドポイント、リクエストボディ、レスポンス、ステータス値の詳細は、Aximo Docs の [API Reference](https://aximo.autify.com/docs/api) を参照してください。既存のケースを API から削除する場合も、同じ API Reference のケース関連エンドポイントを参照してください。

## 前提条件

* API キーを発行している（[APIキーの管理](/features-ja/settings/api-key-management.md) 参照）
* 実行対象のケースまたはプランで **APIアクセス** を有効にしている

{% hint style="warning" %}
APIアクセスを有効にしていないケース・プランは API から実行できません。
{% endhint %}

## APIアクセスを有効にする

ケースとプランの **APIトリガー** ダイアログで、APIアクセスのオン・オフを切り替えます。APIエンドポイント、ステータス確認用のサンプル `curl` コマンドも同じダイアログから確認できます。

ケースとプランで操作の起点が異なるだけで、ダイアログ内の手順は共通です。

### ケースのAPIアクセスを有効にする

1. ワークスペースで **ケース** タブを開き、対象ケースを開きます。
2. ケース詳細の右上で **APIトリガー** をクリックします。
3. **APIアクセス** をオンにします。

<figure><img src="/files/cro4YBUKOoiofa9BIYy2" alt="ケースのAPIトリガーダイアログのスクリーンショット"><figcaption><p>ケースのAPIトリガーダイアログ</p></figcaption></figure>

4. 表示された **APIエンドポイント** と、**使い方** および **ステータス確認** のサンプル `curl` コマンドを控えます。
5. （モバイル ケースのみ）**モバイル設定** で、API 経由実行に使うデバイスとアプリを保存します。
6. APIキーがない場合は、**APIキーを管理** から APIキーを作成します（[APIキーの管理](/features-ja/settings/api-key-management.md) 参照）。

### プランのAPIアクセスを有効にする

1. ワークスペースで **プラン** タブを開き、対象プランを開きます。
2. プラン詳細の右上で **APIトリガー** をクリックします。
3. **APIアクセス** をオンにします。

<figure><img src="/files/RgjJVNks2ZBrjUMJtGMp" alt="プランのAPIトリガーダイアログのスクリーンショット"><figcaption><p>プランのAPIトリガーダイアログ</p></figcaption></figure>

4. 表示された **APIエンドポイント** と、**使い方** および **ステータス確認** のサンプル `curl` コマンドを控えます。
5. （モバイル ケースを含むプランのみ）プラン側の **アプリ & デバイス** で、実行に使うデバイスとアプリを設定します（[モバイル設定を管理する](https://help.aximo.autify.com/features-ja/test-execution-and-plans/pages/JPWMpmTB8Gj8rd2L4xNX#モバイル設定を管理する) 参照）。
6. APIキーがない場合は、**APIキーを管理** から APIキーを作成します（[APIキーの管理](/features-ja/settings/api-key-management.md) 参照）。

{% hint style="info" %}
モバイル ケースを API から実行するときに使うデバイス・アプリは、ケースまたはプランに保存しておくと、API リクエストごとの指定を省略できます。
{% endhint %}

## CI/CD パイプラインに組み込む

API キーは秘匿情報のため、CI/CD のシークレット ストアに登録して環境変数として渡します。ケース ID やプラン ID も、必要に応じて CI/CD 側の変数として管理します。

CI/CD では、次の流れで Aximo の実行を組み込みます。

1. API キーをシークレットとして登録します。
2. ケースまたはプランの API エンドポイントを Aximo の **APIトリガー** ダイアログで確認します。
3. CI/CD のステップから API エンドポイントを呼び出します。
4. レスポンスに含まれる ID を使ってステータスエンドポイントを定期的に呼び出します。
5. 実行結果に応じて CI/CD のジョブを成功または失敗として扱います。

{% hint style="info" %}
API の呼び出し形式やステータス判定の実装例は、[API Reference](https://aximo.autify.com/docs/api) の「Triggering Existing Test Cases」「Triggering Test Plans」「Polling & Terminal Statuses」を参照してください。
{% endhint %}

## トラブルシューティング

### `401 Unauthorized` が返る

**原因**: `x-api-key` ヘッダーが未指定、または API キーが無効です。

**対処**: APIキー管理画面でキーが有効か確認します。シークレット ストアに登録した値を再確認し、必要に応じて新しいキーを発行します。

### `403 API access is not enabled for this case` / `for this plan` が返る

**原因**: 対象ケース・プランで API アクセスが無効になっています。

**対処**: 対象のケース詳細またはプラン詳細で **APIトリガー** を開き、**APIアクセス** をオンにします。

## 参考情報

* [API Reference](https://aximo.autify.com/docs/api)
* [APIキーの管理](/features-ja/settings/api-key-management.md)
* [プランの管理](/features-ja/test-execution-and-plans/test-plan-specifications.md)
* [ケースの作成](/features-ja/test-case-creation/create-test-case.md)