外部 API の利用を開始する

このページでは、UiPath への最初の認証済み API 呼び出しを行う方法について説明します。機密の外部アプリケーションに対するクライアント資格情報フローを使用します。これは、運用スクリプト、管理オートメーション、連携作業の開始点として推奨されます。

注:

適切なツールの選択

UiPath Swagger のドキュメントを使用すると、利用可能な API エンドポイントを調べて、要求と応答の形式をブラウザーで対話的に把握できます。Swagger は、検出と手動テストにのみ使用します。運用環境のオートメーション、スクリプト、および連携の場合は、Postman、cURL、またはアプリケーション コードを使用します。これらは、UiPath API への要求を認可するために必要な OAuth 2.0 ベアラー トークン フローを完全にサポートしています。

前提条件

• UiPath の組織管理者が、 機密 の外部アプリケーションを クライアント資格情報 の付与の種類に登録し、必要なスコープを割り当てています。
• 登録済みアプリケーションの アプリ ID と アプリ シークレット が必要です。

外部アプリケーションの登録と適切な許可の種類の選択については、「 外部アプリケーション (OAuth)」をご覧ください。

手順 1: ベアラー トークンを取得する

Identity Server のトークン エンドポイントに POST 要求を送信して、ベアラー トークンを受け取ります。

curl -X POST "https://cloud.uipath.com/{organizationName}/identity_/connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials&client_id={app_id}&client_secret={app_secret}&scope={scopes}"

次のプレースホルダーを置き換えます。

プレースホルダー	値 (Value)
{organizationName}	Automation Cloud の URL に表示される組織名
{app_id}	外部アプリケーション登録のアプリ ID
{app_secret}	外部アプリケーション登録からのアプリ シークレット
{scopes}	アプリケーションに付与されるスコープをスペースで区切ったリストです。以下に例を示します。 OR.Users.View PM.Users

応答はベアラー トークンを返します。

{
    "access_token": "{access_token}",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "{scopes}"
}

access_token値をコピーします。トークンの有効期限は 1 時間です。

注:

Postman や同様のツールを使用している場合は、リクエストのコンテンツの種類を application/x-www-form-urlencodedに設定します。

手順 2: API エンドポイントを呼び出す

ベアラー トークンを API 要求の Authorization ヘッダーに含めます。

次の例では、Orchestrator からマシンのリストを取得します。

curl -X GET "https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/odata/Machines" \
  -H "Authorization: Bearer {access_token}" \
  -H "accept: application/json"

{tenantName} を Orchestrator テナントの名前に、{access_token} を手順 1 のトークンに置き換えます。

結果

要求が成功すると、HTTP 200 が、要求されたデータと JSON 形式で返されます。

要求が失敗した場合は、以下を確認します。

• トークンの有効期限が切れていません。トークンは1時間後に期限切れになります — ステップ1を繰り返して、新しいトークンを要求します。
• Authorizationヘッダーの値は、Bearer {access_token}とまったく同じ形式になります。
• 外部アプリケーションに付与されたスコープは、要求されたエンドポイントをカバーします。特定のエンドポイントのスコープの値を見つけるには、このガイド内のそのエンドポイントのドキュメント ページ、特に 「プラットフォーム管理 API 」の章をご覧ください。

次のステップ

• OAuth のすべての付与の種類とフロー (認可コードやユーザー委任アクセスの PKCE を含む) については、「 外部アプリケーション (OAuth)」をご覧ください。
• 認証に使用するすべての Identity Server エンドポイントについては、「 UiPath Identity Server エンドポイント」をご覧ください。
• API エンドポイント URL の構造を理解するには、「 API エンドポイント URL の構造」をご覧ください。