カスタムAPI呼び出し
このピースでできることfreeeサイン の接続方法ステップ 1:workrun のリダイレクト URL を確認するステップ 2:freeeサイン で OAuth クライアントを作成するステップ 3:workrun に接続を追加するピースの設定項目1. URL(必須)2. メソッド(必須)3. ヘッダー(任意)4. クエリパラメータ(任意)5. ボディ(任意)6. 失敗時にエラーにしない(任意)7. タイムアウト(秒)(任意)
このピースでできること
- freeeサインのAPIのうち、他のピースとして用意されていない機能を、直接呼び出して実行します。
- 接続の認証情報は自動で付与されるため、認証用のヘッダーを自分で入力する必要はありません。
このピースの前後にfreeeサインのトリガーやアクションがある場合は、Delay(待機)などで 1 秒以上の待ち時間を挿むことを推奨します。リクエスト制限によりエラーになることがあります。
freeeサイン の接続方法
workrun と freeeサイン を接続するには、freeeサイン の OAuth クライアント(クライアントID・クライアントシークレット) が必要です。
ステップ 1:workrun のリダイレクト URL を確認する
- workrun で freeeサイン のアクション/トリガーをフローに追加します。
- 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
- 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。
ステップ 2:freeeサイン で OAuth クライアントを作成する
- freeeサインの管理画面にログインします。
- 画面右上の設定(歯車アイコン)を開きます。
- 「インテグレーション」セクションの「OAuth2.0 API クライアント」を開きます。
- クライアントを追加し、クライアント名とリダイレクトURIを入力します。
- リダイレクトURIには、ステップ 1 でコピーしたリダイレクト URL をそのまま貼り付けてください。
- 発行された client_id(クライアントID) と client_secret(クライアントシークレット) をコピーしておきます。
スコープ一覧
| スコープ名 | 説明 |
|---|---|
| all | freeeサインAPIの全エンドポイントへのアクセスを許可します。 |
ステップ 3:workrun に接続を追加する
- ステップ 1 の接続画面に戻り、クライアントID と クライアントシークレット をそれぞれ貼り付けます。
- 「接続」 をクリックすると、freeeサイン の認証画面が開きます。
- freeeサイン にログインし、workrun に対するアクセスを 「許可」 します。
- 画面が自動で閉じ、接続が完了します。
ピースの設定項目
1. URL(必須)
- 呼び出したいAPIのURLを入力します。
- 完全なURLでも、ベースURLからの相対パスでも指定できます。
- 完全なURLの例:
- 相対パスの例:
[設定例]
2. メソッド(必須)
- APIを呼び出すときのHTTPメソッドを選びます(GET / POST / PUT / DELETE / PATCH)。
- 情報を取得する場合はGET、新規作成する場合はPOSTを選ぶのが一般的です。
[設定例]
3. ヘッダー(任意)
- APIへ送る追加のヘッダーを指定します。
- 認証用のヘッダーは接続から自動で付与されるため、通常は入力不要です。
[設定例]
4. クエリパラメータ(任意)
- URLの末尾に付け加える条件を指定します。
[設定例]
5. ボディ(任意)
- POSTやPUTなどで送るデータをJSON形式で指定します。
- GETの場合は通常入力不要です。
[設定例]
6. 失敗時にエラーにしない(任意)
- オンにすると、APIがエラーを返してもフローを止めずに次のステップへ進みます。
[設定例]
7. タイムアウト(秒)(任意)
- APIからの応答を待つ最大秒数を指定します。
[設定例]