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

パブリック 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/v1/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/v1/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 エンドポイント ページを参照してください。

に最終更新