【UiPath】OrchestratorのAPIを使ってみる②～認証からAPI実行まで～

前回のつづき

前回は、UiPath OrchestratorのWebAPIを紹介しました。
認証が必要なんじゃない？というところで止まっていたので、今回はそこから続けます。

ログイン認証方法

UiPath OrchestratorのAPIは、Bearer認証と呼ばれる方式で認証を行います。
Bearer認証の詳細については省略しますが、ざっくり説明すると、

• 認証APIがトークンを返す
• 以降、認証が必要なAPIを叩くときに、返ってきたトークンも渡して叩く

という感じです。

認証APIを叩いてみる

認証APIの仕様を確認

マニュアルのページから、/api​/Account​/Authenticateの仕様を確認します。
マニュアルのURLは以下でしたね。

https://[OrchestratorのURL]/swagger/index.html

パラメーターの部分を見ると、このようになっています。

JSON形式で、テナント名・ユーザー名・パスワードを指定してあげればよさそうです。

叩いてみる

いつものTalend API Testerを使って、認証APIを叩いてみます。

こんな感じで、POSTで叩いてあげましょう。
ユーザー名もパスワードも、Orchestratorにログインするときのユーザーを指定します。
パスワードは平文です。

結果をみてみる

認証できた場合は、HTTPステータス200が返ってきます。

また、JSON形式でBearerトークンが返ってきます。
以下の、resultの部分です。

ちなみに、ユーザー名やパスワードが違う場合は、こんなJSONが返ってきます。

{
  "message": "Invalid credentials, failed to login.",
  "errorCode": 1000,
  "resourceIds": null
}

トークンを渡して他のAPIを叩いてみる

次に、認証が必要なAPIを叩いてみます。
ここでは、[GET] ​/odata​/Usersを叩いてみましょう。

叩いてみる

先ほど取得したBearerトークンを、HTTPヘッダAuthorizationに設定します。
このとき、"Bearer [Bearerトークン]"というように設定する必要があります。

結果をみてみる

このような感じで、JSONで結果が返却されます。

次回

今回は認証の通し方を説明しました。
シンプルなAPIだったので、他のAPIを叩く場合のパラメーターなどはマニュアルを参考にしてください。

次回は、APIを使ったツールを作ってみようと思います。