カスタムAPI呼び出し
このピースでできることfreee人事労務 の接続方法ステップ 1：workrun のリダイレクト URL を確認するステップ 2：freee でアプリケーションを登録するステップ 3：workrun に接続を追加するピースの設定項目1. URL（必須）2. メソッド（必須）3. ヘッダー（任意）4. クエリパラメータ（任意）5. ボディ（任意）6. 失敗時にエラーにしない（任意）7. タイムアウト（秒）（任意）
このピースでできること
- freee人事労務のAPIのうち、他のピースとして用意されていない機能を、直接呼び出して実行します。
- 接続の認証情報は自動で付与されるため、認証用のヘッダーを自分で入力する必要はありません。
freee人事労務APIの多くのエンドポイントは ヘッダーを必要とします。他のピースでは自動で付与されますが、このピースでは「ヘッダー」に手動で追加してください。
「従業員を更新する」では退職日を削除（クリア）できません。退職日を削除したい場合はこのピースを使用してください。
freee人事労務 の接続方法
workrun と freee人事労務 を接続するには、freee の OAuth クライアント（クライアントID・クライアントシークレット） が必要です。
ステップ 1：workrun のリダイレクト URL を確認する
- workrun で freee人事労務 のアクション／トリガーをフローに追加します。
- 「接続を選択」の横にある 「＋ 新しい接続」 をクリックします。
- 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。
ステップ 2：freee でアプリケーションを登録する
- freeeアプリストア でアプリケーションを登録します。
- コールバックURL に、ステップ 1 でコピーしたリダイレクト URL をそのまま登録します。
- 権限設定 で、以下の項目にチェックを入れます。
- ［人事労務］従業員: 参照・更新
- 「カスタムAPI呼び出し」アクションを利用する場合は、そのエンドポイントに対応する権限も追加してください
- 発行された クライアントID と クライアントシークレット をコピーしておきます。
スコープ一覧
| スコープ名 | 説明 |
|---|---|
| read | freee人事労務のデータの参照を許可します。 |
| write | freee人事労務のデータの作成・更新を許可します。 |
ステップ 3：workrun に接続を追加する
- ステップ 1 の接続画面に戻り、クライアントID と クライアントシークレット をそれぞれ貼り付けます。
- 「接続」 をクリックすると、freee の認証画面が開きます。
- freee にログインし、連携する事業所を選択します。
- workrun に対するアクセスを 「許可」 します。
- 画面が自動で閉じ、接続が完了します。
ピースの設定項目
1. URL（必須）
- 呼び出したいAPIのURLを入力します。
- 完全なURLでも、ベースURLからの相対パスでも指定できます。
- 完全なURLの例：
- 相対パスの例：
[設定例]
2. メソッド（必須）
- APIを呼び出すときのHTTPメソッドを選びます（GET / POST / PUT / DELETE / PATCH）。
- 情報を取得する場合はGET、新規作成する場合はPOST、更新する場合はPUTを選ぶのが一般的です。
[設定例]
3. ヘッダー（任意）
- APIへ送る追加のヘッダーを指定します。
- 認証用のヘッダーは接続から自動で付与されますが、freee人事労務APIでは の指定が必要なエンドポイントが多いため、ここに追加してください。
[設定例]
4. クエリパラメータ（任意）
- URLの末尾に付け加える条件を指定します。
[設定例]
5. ボディ（任意）
- POSTやPUTなどで送るデータをJSON形式で指定します。
- GETの場合は通常入力不要です。
[設定例]
6. 失敗時にエラーにしない（任意）
- オンにすると、APIがエラーを返してもフローを止めずに次のステップへ進みます。
[設定例]
7. タイムアウト（秒）（任意）
- APIからの応答を待つ最大秒数を指定します。
[設定例]