OAuth2リクエストを送信
このピースでできることHTTP (OAuth2) の接続方法1. 連携先サービスでOAuthアプリを登録する2. workrunで接続を作成する3. 接続情報を入力する4. 認証して保存するピースの設定項目1. 接続(必須)2. URL(必須)3. 方法(Method)(必須)4. ヘッダー(Headers)(任意)5. クエリパラメータ(Query Parameters)(任意)6. ボディタイプ(Body Type)(任意)7. 本文(Body)(任意・動的)8. プロキシを使用(Use Proxy)(任意)9. Return Error as Output(任意)10. Timeout(任意)取得できる情報
このピースでできること
- HTTP (OAuth2) の接続で取得したアクセストークンを使って、任意のURLへHTTPリクエストを送ります。
- 認証ヘッダー(Authorization: Bearer)は、接続情報から自動で付与されます。フローの中でトークンを入力・更新する必要はありません。
- 連携先のアプリがworkrunになく、そのAPIがOAuth 2.0認証を必要とする場合に使います。認証が不要、またはAPIキー・ベーシック認証・Bearerトークンで足りる場合は、「HTTPリクエストを送信」を使います。
HTTP (OAuth2) の接続方法
1. 連携先サービスでOAuthアプリを登録する
- 連携先サービスの開発者向け画面で、OAuthアプリ(クライアント)を作成します。
- 作成したアプリの Client ID と Client Secret を控えておきます。
- 「リダイレクトURL(コールバックURL)」の設定欄がある場合は、workrunの接続画面に表示されるリダイレクトURLを登録します。
- APIで利用したい機能に必要なスコープ(アクセス権限)を確認しておきます。
2. workrunで接続を作成する
- 接続から「接続を作成」をクリックし、HTTP (OAuth2) を選択します。
- 接続名を任意に設定します。接続先のサービス名を入れておくと、フローで選ぶときに区別しやすくなります。
3. 接続情報を入力する
連携先サービスのAPIドキュメントをもとに、次の項目を入力します。
| 項目 | 内容 |
|---|---|
| 認可方式(Grant Type) | 「Authorization Code」または「Client Credentials」を選びます。連携先のアカウントでログインして許可する方式は Authorization Code、ログインせずにアプリの資格情報だけでトークンを発行する方式は Client Credentials です。 |
| Authorize URL | ログインしてアクセスを許可する画面のURLです。 |
| トークンURL(Token URL) | アクセストークンを発行するURLです。 |
| Scopes | 利用するスコープを半角スペース区切りで入力します。 |
| Client ID / Client Secret | 手順1で控えた値を入力します。 |
4. 認証して保存する
- Authorization Code の場合は、連携先サービスのログイン・許可画面が表示されるので、アクセスを許可します。
- 「保存」を押して、接続が一覧に追加されたことを確認します。
ピースの設定項目
1. 接続(必須)
- 事前に作成した HTTP (OAuth2) の接続を選択します。接続の作成方法は、下の「接続方法」をご確認ください。
2. URL(必須)
- リクエスト先の完全なURLを、https:// または http:// から入力します。
3. 方法(Method)(必須)
- GET / POST / PUT / PATCH / DELETE から選択します。初期値は GET です。
4. ヘッダー(Headers)(任意)
- 追加で送るヘッダーを、キーと値の組み合わせで指定します。
- 認証ヘッダーは接続情報から自動で付与されるため、入力する必要はありません。
5. クエリパラメータ(Query Parameters)(任意)
- URLの末尾に ?key=value の形で追加する値を指定します。
6. ボディタイプ(Body Type)(任意)
- 「なし」「JSON」「Form Data」「Raw」から選びます。初期値は「なし」です。
- 方法が GET の場合は選択できません。
7. 本文(Body)(任意・動的)
- JSON:JSON Body にJSONを入力します。
- Raw:Raw Body に送信する文字列をそのまま入力します。
- Form Data:項目名と値をキーと値の組み合わせで入力します(ファイルの送信には対応していません)。
8. プロキシを使用(Use Proxy)(任意)
- HTTPプロキシを経由する場合にオンにします。オンにすると「プロキシ設定」で Proxy Host(必須)、Proxy Port(必須)、Proxy Username、Proxy Password を設定します。
9. Return Error as Output(任意)
- オンにすると、リクエストが失敗した場合にステップを失敗させず、エラー内容を出力して次のステップへ進みます。
10. Timeout(任意)
- 応答を待つ秒数です。空欄の場合は、フローの上限(10分)まで待ちます。
取得できる情報
| 実際のキー | 内容 |
|---|---|
| HTTPステータスコード | |
| レスポンスヘッダー | |
| レスポンス本文 | |
| レスポンスがバイナリ(application/octet-stream)の場合のみ。本文をBase64形式にした文字列です。 |
- 「Return Error as Output」をオンにして失敗した場合は、、、 が出力されます。