---
title: "Autify API連携ガイド | Autify Guide"
slug: "integrate-with-api"
description: "Autifyを他のシステムとAPIを利用して連携し、効率的な自動化テストを開始しましょう！"
updated: 2024-05-10T09:06:07Z
published: 2024-05-10T09:06:07Z
canonical: "help.autify.com/integrate-with-api"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.autify.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API連携

## Autify API

          
          

**API の仕様は、[Autify のOpenAPI 定義](https://autifyhq.github.io/autify-api/#/) (英語のみ)をご覧下さい。** **なお、CI/CD 連携については、Autify の公式連携のご利用を強くお勧めします。[Autify でCI/CD](https://help.autify.com/docs/ja/cicd-with-autify) をご覧下さい。**

Autify は API を提供しています。

API をご利用いただくことで CircleCI や Jenkins といった CI/CD ツールと連携することができ、ソースコードがマージされたタイミングで自動的に特定のテストプランを実行する、といったように、開発フローに組み込むことができます。

## パーソナルアクセストークンの発行

API を実行するためには、パーソナルアクセストークンが必要となりますので、これを予め発行してください。 アクセストークンはユーザー単位での生成となるため、共用にしたい場合は、API専用のユーザーを作成することをおすすめします！

パーソナルアクセストークンは、サイドメニューの「設定」から「個人設定」を開き、その中の「新しいパーソナルアクセストークンを生成」から生成することができます。

![](https://cdn.document360.io/a099d8a2-cfd2-42ca-9906-68b4a337f4a5/Images/Documentation/zndsk-Screen_Shot_2021-09-14_at_17.13.01.png?sv=2026-02-06&spr=https&st=2026-11-02T20%3A27%3A45Z&se=2026-11-02T21%3A27%3A45Z&sr=c&sp=r&sig=mSb%2FRwJ07IP4WcmZytxrVsPpl03wHqyV2jUp%2BfQbERs%3D)

## Autify APIの活用

### Autify CLI を使って

[Autify Command Line Interface (CLI)](https://help.autify.com/docs/ja/autify-command-line-interface) は各Autify API に対してローレベルのコマンドを提供しているので、シェルスクリプト等を使って自由なソリューションを簡単に組み上げることができます。

          
          

Autify CLI は、複雑なユースケースに対して効率的なユーザ体験を提供するために、`autify web test run` の様なハイレベルのコマンドをいくつか持っています。Autify API を直接呼び出してご自身でソリューションを作る前に、**まずはこれらのハイレベルのコマンドが使えないかを検討してみてください。**

Autify CLI を使ったいくつかの例です:

#### シナリオIDと実行環境 (capabilities) を指定して、テストを実行する

```
$ autify web api execute-scenarios --project-id 0 --execute-scenarios-request '{
  "scenarios": [{"id": 111}],
  "capabilities": [{"os": "Linux", "browser": "Chrome"}]
}'

{
  "result_id": 222
}
```

#### テスト結果IDを指定して、テスト結果の詳細を取得する

```
$ autify web api describe-result --project-id 0 --result-id 222
{
  "id": 222,
  "status": "passed",
  "review_needed": false,
  "test_plan_capability_results": [
    {
      "id": 333,
      "capability": {
        "os": "Linux",
        "browser": "Chrome",
        ...
      },
      "test_case_results": [
        {
          "id": 444,
          "status": "passed",
          "project_url": "https://app.autify.com/...",
          "review_needed": 0,
          ...
        }
      ]
    }
  ],
  ...
}
```

詳しくは、[GitHub readme](https://github.com/autifyhq/autify-cli#commands) の`autify web api` コマンド群をご覧下さい。

### ご自身の HTTP クライアントを使って

          
          

もしAutify CLI が利用可能な環境でしたら、上記のAutify CLI バージョンのご利用を強くお勧めします。

もしSDK や公式サポートが必要でしたら、[GitHub Issues](https://github.com/autifyhq/autify-cli/issues) でリクエストをして下さい。

もし、`curl` などご自身のHTTP クライアントからAutify API 連携したい場合には、そのクライアントから以下の様なHTTP リクエストを送れる様に設定して下さい:

#### シナリオIDと実行環境 (capabilities) を指定して、テストを実行する

```
POST /projects/0/execute_scenarios HTTP/1.1
Accept: application/json, text/plain, */*
Content-Type: application/json
Authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN
Content-Length: 77
Host: app.autify.com

{"scenarios":[{"id":111}],"capabilities":[{"os":"Linux","browser":"Chrome"}]}
```

#### テスト結果IDを指定して、テスト結果の詳細を取得する

```
GET /projects/0/results/222 HTTP/1.1
Accept: application/json, text/plain, */*
Authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN
Host: app.autify.com
```