クラウドBOT DocsAPI連携 / REST APIにリクエストする
ホーム > ユーザガイド > BOT > BOTエディタの使い方 > 拡張機能 > API連携 > REST APIにリクエストする
アプリ概要
任意のREST APIにリクエストを送信し、レスポンスを取得します。また、LAN内からのリクエストも仮想ブラウザを経由することで可能です。
| 拡張機能URL | cbot-extension://cloud-bot:api:request-to-rest:2 |
| 提供元 | Cloud BOT official |
| 外部通信 | あり |
| バージョン | 2 |
画面説明
入力画面について
リクエストオプション
メソッド
リクエストメソッドを選択します。
（GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH）
エンドポイント
リクエストエンドポイントを指定します。
クエリパラメータ
URLクエリパラメータ（Key, Value）を指定します。必要に応じて追加、削除ができます。
ヘッダー
リクエストヘッダー （Key, Value）を指定します。必要に応じて追加、削除ができます。
ボディの指定方法
ボディの指定方法を選択します。
（テキスト, ファイル, multipart/form-data）
* ボディの指定方法についてはこちらをご覧ください。
ボディ
リクエストボディを指定します。
* ボディの指定方法で選択した内容によって入力項目が変わります。
出力項目
結果画面に出力する項目を選択します。
- レスポンスのボディ(テキスト)：レスポンスボディをテキストで表示します。
- レスポンスのボディ(ダウンロード)：レスポンスボディのファイルをダウンロードするボタンを表示します。
- リクエストのボディ：リクエストしたボディの内容を表示します。
通信経路
通信経路を選択します。
* REST API機能の通信経路についてはこちらをご覧ください。
結果画面について
レスポンス
レスポンス結果が表示されます。
ステータスコード
レスポンスのステータスコードが表示されます。
ステータステキスト
レスポンスのステータステキストが表示されます。
ヘッダー
レスポンスヘッダーが表示されます。
レスポンスのボディ(テキスト)
レスポンスボディがテキストで表示されます。
レスポンスのボディ(ダウンロード)
レスポンスボディのファイルをダウンロードします。
リクエストのボディ
リクエストしたボディの内容が表示されます。
ボディの指定方法についての補足説明
ボディをテキスト入力する
リクエストボディをテキストで入力します。
ボディをファイルから参照する
リクエストボディをファイル参照します。
multipart/form-dataを作る
multipart/form-dataのリクエストボディを作ります。
パート数は必要に応じて追加、削除ができます。
ボディ(テキスト)
Valueをテキスト入力する場合に使用します。
ボディ(ファイル)
Valueをファイル参照する場合に使用します。
- Key：パート名です。
- Value：パートのボディ部です。
- Content-Type（オプション）：パートのMIMEタイプです。
- Filename（オプション）：パートのファイル名です。
パート構造
multipart/form-dataによるボディのパート構造は以下になります。
--Boundary
Content-Disposition: form-data; name="[Key]" filename="[Filename]"
Content-Type: [Content-Type]
[Value]
通信経路についての補足説明
クラウドBOTサービスからリクエスト
クラウドBOTサービスからリクエストします。
仮想ブラウザの通信経路を利用してリクエスト
仮想ブラウザの仮想コネクタを経由してリクエストします。LAN内へのリクエストが可能になります。
* 仮想ブラウザに仮想コネクタを使用している必要があります。仮想コネクタについてはこちらをご覧ください。