API連携
  • 07 Sep 2022
  • 1 分で読めます
  • 投稿者
  • ダーク
    ライト

API連携

  • ダーク
    ライト

Autify API

CI/CD 連携については、Autify の公式連携のご利用を強くお勧めします。Autify でCI/CD をご覧下さい。

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

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

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

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

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

Autify APIの活用

Autify CLI を使って

Autify Command Line Interface (CLI) は各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 readmeautify web api コマンド群をご覧下さい。

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

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

もしSDK や公式サポートが必要でしたら、GitHub 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

API の仕様は、Autify のOpenAPI 定義 (英語のみ)をご覧下さい。


First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.