Automation Anywhere Control Room APIでSwagger UIからAPIコール時に結果が「TypeError: Failed to fetch」となる

他のアプリケーションからAutomation AnywhereをREST API経由で制御できる仕組み「Automation Anywhere Control Room API」は、Control Room上にSwagger UIが実装されており、仕様を見たり実際にAPIコールを行ってみることができます。

* [Automation Anywhere A2019 Control Room API に関する情報](https://qiita.com/RPAbot/items/cf834cec5085ba4aab02)

Swagger UIではAPIコールの際のパラメータをWeb上で設定することができるため、コードを書かなくても気軽にREST APIを呼べるのが特徴です。

* [Swaggerの概要をまとめてみた。](https://qiita.com/gcyata/items/342073fa7607fd4082bd) by @gcyata さん

# Swagger UI の使い方
フリートライアルとCommunity Editionでは、以下のURLでAPIの実装を閲覧できます。

* フリートライアル: https://trial.cloud.automationanywhere.digital/swagger/
* Community Edition: https://community.cloud.automationanywhere.digital/swagger/

Swagger UIで以下のように一覧が表示されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/479715/0b420151-2512-306e-4d7f-8675b6a4c75e.png)

「Authentication API」をクリックすると、詳細がHTMLページとして表示されます。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/479715/dfdb01fb-f9a0-5d4f-e5fa-c6ef042b4982.png)

### 使いたいHTTPメソッドを選択してTry It out!

HTMLで記載されたページには、利用できるHTTPメソッド(get, post, put, delete等)一覧が表示されます。利用したいものをクリックして展開します。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/479715/69723916-7d88-d544-808b-df43f6418d72.png)

HTMLメソッドには「Parameters」セクションと「Responses」セクションがあります。Parametersでは、HTMLメソッドに引き渡すパラメータをJSON形式で指定します。それに対してどのような返り値になるかをエラーコード毎に記載しているのがResponsesです。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/479715/e6371e31-5776-7206-7cd0-e2421268599f.png)

Parametersセクションの「Try It Out」ボタンを押すと、パラメータの編集ができるようになります。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/479715/bedbfcc0-b623-1b53-104c-d5d158686a92.png)

### パラメータを編集してExecuteする

パラメータ編集後、「Execute」ボタンを押すと、実際にREST APIコールを実行できます。結果はResponsesセクションに表示されます。

本来はプログラミングコードの中からREST APIコールをしないといけないのですが、このように、WebブラウザベースのUI操作だけでコールができてしまうのはとても簡単で、APIのテストをするのにはとても適しています。


# 課題: Responseが「TypeError: Failed to fetch」となる...
さて、ここまでは前置きで、ここからが本題です。
たとえば、Authentication APIで、最初にユーザー認証を行う「/authentication」をコールしてみるとします。
"username"と"password"のペアを指定してコールすることができますので、「Try It Out」ボタンを押し、bodyのテキストボックスでapiKeyは消してusernameとpasswordに適切な文字列を指定して「Execute」ボタンを押してみると...Server responseに表示されるのは、**Code=「Undocumented」、Details=「TypeError: Failed to fetch」(取得に失敗) というエラー**でした。
![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/479715/e992804f-099a-6387-3d14-b6034e8a5841.png)

これは、つまり想定していないエラーということになります。

### curlでAPIコールしてみると...
これだけだと手掛かりがないので、curlという、コマンドラインからREST APIを呼ぶことができるツールを使って呼んでみましょう。Swagger UIでは、Executeすると、ResponsesのセクションにAPIコールと同等のcurlコマンドを表示してくれます。これをコピペしてそのまま実行すればよいわけです。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/479715/ef0333b1-4131-20bf-8992-0d96728344f7.png)

ちなみに、curlコマンドは元々Linuxのコマンドですが、Windows 10でもApril 2018 Updateから標準コマンドとなっており、特に追加インストールなく実行できます。もしこの要件を満たしていないOSの場合は、ダウンロードしてインストールしてください。

* [Windows 環境における curl コマンド利用のまとめ (平成最終版)](https://qiita.com/yamachan360/items/8c928738289cd518eec8) by @yamachan360 さん

さて、コマンドプロンプトを開いて、Swagger UIに表示されていたcurlコマンドをそのままコピペして実行してみます。

```
C:\Users\Public>curl -X POST "http://trial.cloud.automationanywhere.digital/v1/authentication" -H "accept: application/json" -H "Content-Type: application/json" -d "{ \"username\": \"(User Name)\", \"password\": \"(Password)\"}"
```

すると、以下が表示されます。

```HTML:
<html>
<head><title>301 Moved Permanently</title></head>
<body bgcolor="white">
<center><h1>301 Moved Permanently</h1></center>
</body>
</html>
```

HTMLページとして出力されていますが、つまり**301 Moved Permanently**というHTTPエラーコードが返ってきていることがわかりました。Swagger UIの中では301は未定義でしたので、Undocumentedとなったのですね。

# 原因は...
このエラーコード301ですが、リダイレクト済みであることを表すエラーなのですが、いろいろネットを検索して調べていると、URLのSSL対応のためにHTTPをHTTPSにリダイレクトしていると起こるであろうことが想像できました。そうです。つまり、**HTTPSでなくHTTPでAPIコールを行っていたのが原因だったのです。**

よく見ると、Swagger UIの冒頭の方に、Schemeを選ぶドロップダウンがあり、HTTPかHTTPS化を選ぶようになっていました。これをHTTPSに直して実行すると、正しく実行できました。また、curlコマンドもよく見ると、やはり引数のURLがHTTPになっていたので、HTTPSに直すと正常に実行できました。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/479715/167b5c37-b38e-d9af-9d05-b04bc0bc0075.png)

これは、トライアルでもCommunity Editionでもそうですが、インターネット上にホストされるクラウド版では、軒並みいまはHTTPSでホストされているために、HTTPSでAPIコールをしないとこのエラーが発生します。

...ということで、原因がわかってしまえば何のことはないのですが、このエラーでしばらく原因がわからずハマってしまったので、メモしておきます。