メインコンテンツまでスキップ
バージョン: DAI 25.2

パブリック API の概要

Eggplant DAI パブリック API ドキュメントへようこそ。このガイドは、パブリック REST API エンドポイントの使用を開始し、Eggplant DAI のサービスとやり取りできるようにするのに役立ちます。パブリック REST API を通じて、アクセス トークンの取得、テスト結果の一覧表示と取得、個々のテストのログへのアクセスなど、Eggplant DAI が提供するさまざまなリソースと機能にプログラムでアクセスできます。

API クライアント認証情報を生成する​

パブリック API を使用するには、認証してアクセス トークンを取得する必要があります。このトークンは、後続のすべての API リクエストのヘッダーに含める必要があります。

管理ユーザーは、追加の API クライアントを作成することを除いて、管理ユーザーと同等の権限を持つ API クライアントを作成できます。

API クライアントを作成するには:

  1. Eggplant DAI UI にアクセスし、管理者の資格情報でログインします。
  2. System > API Accessに移動します。
  3. New API Access をクリックします。
  4. 資格情報の名前と説明を追加します。
  5. Createをクリックします。
  6. プロンプトが表示されたら、 Downloadをクリックし、資格情報 .csv ファイルを安全な場所に保存します。

これで、資格情報ファイルの client_id 変数と client_secret 変数を使用して acquire an access token できるようになりました。

セキュリティに関する注意事項

これらの認証情報はパスワードと同様に扱ってください。安全に保管し、共有しないでください。API認証情報を紛失、漏洩、または忘れてしまった場合は、APIアクセスインターフェースから取り消しまたは再生成できます。

アクセス トークンを取得して認証する​

前の手順の資格情報を使用して、API からアクセス トークンを取得し、認証します。

リクエストの例​

curl -X POST "https://YOUR_DAI_BASE_URL/api/v2/auth" \
     -H "Content-Type: application/json" \
     -d '{"client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET"}'

レスポンスの例​

{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJ2U1FaeW9W...",
  "expires_in": 600
}

保護された API リソース エンドポイントにアクセスする​

認証されると、有効なアクセス トークンを使用して保護された API リソース エンドポイントにアクセスできます。トークンは 10 分後に期限切れになるため、定期的に資格情報を再送信して新しいアクセス トークンを取得する必要があります。

リクエストの例​

curl -X GET "https://YOUR_DAI_BASE_URL/api/v2/test_results" \
     -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

レスポンスの例​

[
  {
    "id": "test-result-id",
    "status": "completed",
    "start_time": "2023-06-23T14:55:00Z",
    "end_time": "2023-06-23T15:15:00Z"
  },
  ...
]

利用可能なすべてのパラメータや追加の例など、各エンドポイントの詳細情報については、API V2 エンドポイント ページを参照してください。

注記

パブリック API バージョン 2.0 では、GET テスト結果ログ エンドポイント (GET api/v2/test_results/{test_result_id}/logs) を除き、パブリック API バージョン 1.0 の既存のエンドポイントの動作はすべて同じままです。パブリック API バージョン 2.0 の GET テスト結果ログ エンドポイントでは、これまで message フィールドに保存されていたすべての情報が、message_type、image_name、message、image_id の各列に分割されました。

さらに、パブリック API バージョン 2.0 では、テスト構成結果の取得に関連する新しいエンドポイントも導入されています。

パブリック API の廃止​

廃止予定DAI バージョンでは非推奨です...Notes
パブリック API バージョン 1.0DAI バージョン 7.5パブリック API バージョン 1.0 は、パブリック API バージョン 2.0 のリリースに伴い廃止されます。DAI 7.5 では現在もサポートされていますが、将来のリリースでは削除される予定です。この変更に備えて、パブリック API エンドポイントの利用状況をパブリック API バージョン 2.0 に更新することをお勧めします。
に最終更新