HTTPリクエスト 任意のREST APIを実行(アクション)
説明
クラウドサービスなどのAPIを参照して、HTTPリクエストを送信できます。
レスポンスを出力データとして受け取り、変数として利用することができます。
項目ごとの説明
コネクタ名
対象コネクタの名称を記載
アクション
「HTTPリクエスト」を指定
Method
対象メソッドを指定
※指定可能Method
・GET（デフォルト）
・POST
・PUT
・PATCH
・DELETE
・HEAD
・OPTIONS
Endpoint
対象APIのエンドポイントを指定
Authorization
対象APIの認証情報を設定
※指定可能認証タイプ
・None
・Bearer Token
・Basic Auth
・API Key
・HTTPリクエスト専用認証（Google、Box、Microsoft認証利用時に指定）
Header
対象APIのヘッダ情報を指定
Body
対象APIのBody情報を指定
※指定可能Bodyタイプ
・JSON
・x-www-form-urlencoded
・form-data
・binary（HTTPリクエストアクションでは利用不可）
Params
対象APIのParams情報を指定
テスト送信ボタン
指定したAPIの情報が間違ってないか確認するため、一度リクエストするボタン
ステータスコード
テスト送信によるリクエストのステータスコードが表示
response
テスト送信によるリクエストのレスポンスが表示
変数名を指定
後続コネクタで利用する変数を指定
注意事項
- 本コネクタは上級者向けの機能となります。普段からcurlコマンドやPostmanの操作などに慣れ親しんでいる方を対象としています。
- ご利用されるAPIについて、仕様と制限事項をご理解してお使いください。
- ご利用されるAPIからのレスポンス結果やエラー内容について、弊社はサポートいたしません。
- ご利用されるサービスのプランやAPI利用料金について、その有無や金額をご確認ください。テスト実行や自動実行の繰り返しなどで、思わぬ請求に繋がる可能性があります。
- 本コネクタの機能を用いて、外部のサーバーやアプリケーションの対して継続的な負荷をかけるなどの行為を行わないようご注意ください。
- 該当の行為がお客様および外部のサーバーやアプリケーションに対して損害をもたらした場合、弊社はいかなる責任も取りかねます。
変数設定の例
ChatworkのAPIを利用した例になります。利用者のChatworkの情報を取得する場合の例になります。
以下の情報で設定を行います。
Method
Headers
key:x-chatworktoken value: API keyをChatworkより取得してください。
key:accept value : application/json
※その他は空欄で大丈夫です。
テスト送信をクリックするとレスポンスが表示されます。
レスポンスを変数として利用したい場合は、以下のようにすると変数を設定できます。
レスポンス内にあるkeyを利用してください。ない場合は保存ができません。
Bodyで変数を利用する場合、テスト送信時に変数部分がJENKAの内部情報に変換されます。
この内部情報はテスト送信を行う前に、実際にテストを行いたい値に変更してください。
この内部情報はテスト送信を行う前に、実際にテストを行いたい値に変更してください。
変数の説明
| 変数名 | データタイプ | 説明 |
| 実行日時 | TEXT | コネクタが実行された日時 |
| 実行ステータス | BOOL | コネクタの実行結果 |
ステータスコード | TEXT | リクエストのステータスコード |
レスポンス | TEXT | リクエストのレスポンス |
| 指定した変数名 | TEXT・LIST | 指定した変数の値 |