Swagger での API 呼び出しを認可する

Swagger にアクセスする

Orchestrator API Swagger にアクセスするには、Orchestrator URL に /swagger/index.html を追加します。例: https://cloud.uipath.com/{organizationName}/{tenantName}/orchestrator_/swagger/index.html

Swagger で表示される API は、使用する Orchestrator インスタンスによって異なります。Swagger で直接簡単に要求を行うには、別のタブで Orchestrator にログインします。

注:

The Swagger authentication expires according to the parameters set in your Orchestrator instance. By default, it is set to 30 minutes.

アクセス トークンを取得する

Orchestrator サービスで Swagger UI を介して API 呼び出しを認可するには、次の手順を実行します。

1. Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックが開いている場合は、認可されていません。

   図 1. [Authorize] ボタン
   

   

   
   

2. [Authorize] を選択します。[Available authorizations] ウィンドウが表示されます。

   注: 現在サポートされているのは、OAuth2 という認可スキーム 1 つです。
   図 2. Available authorizations
   

   

   
   
3. Orchestrator API のすべてのエンドポイントを試すことができるように、すべてのスコープが事前に選択されています。特定の API へのアクセスを制限する場合は、該当するスコープをクリアしてください。
4. [Authorize] を選択します。認可されたことを確認する新しいウィンドウが表示されます。
5. 完了したら、[Close] または [X] を選択して [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに閉じたロックが表示され、認可されていることを示します。

要求を送信する

認可されている間に、以下の方法で Orchestrator API リソースに要求を送信できます。

1. 操作の実行に使用する Orchestrator API リソースを展開します。閉じたロックは、認可されていることを意味します。
   図 3. 認可されていない API リソース
   

   

   
   
2. 展開したメソッド ウィンドウで、[Try it out] を選択します。
3. 必要に応じてパラメーター値を指定します。
4. [Execute] を選択します。要求が実行されます。ベアラー認可ヘッダーが自動的に要求に使用されます。
   図 4. ベアラー認可ヘッダー
   

   

   
   

新しいアクセス トークンを生成する

アクセス トークンの期限が切れた場合、「401: You are not authenticated!」という応答を受信します。ベアラー認可ヘッダーは要求に対してまだ存在していますが、アクセス トークンは期限切れになっています。この場合、期限切れのトークンを無効にして、新しいアクセス トークンを生成する必要があります。

1. Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックは閉じているはずです。
   図 5. [Authorize] ボタン
   

   

   
   
2. [Authorize] を選択し、表示される [Available authorizations] ページで [Logout] を選択して、期限切れのトークンを取り消します。
   図 6. Available authorizations
   

   

   
   
3. [Close] または [X] を選択して [Available authorizations] ウィンドウを閉じ、「アクセス トークンを取得する」セクションの説明に従ってアクセス トークンを取得します。

アクセスを取り消す

Swagger UI の操作が完了したら、使用したアクセス トークンを無効にする必要があります。

1. Orchestrator API ページの右上隅にある [Authorize] ボタンを探します。ロックは閉じているはずです。つまり、承認されています。
2. [Authorize] をクリックし、表示される [Available authorizations] ページで [Logout] をクリックします。
3. [Close] または [X] をクリックして [Available authorizations] ウィンドウを閉じます。[Authorize] ボタンに開いているロックが表示され、認可されていないことを示します。