カスタムAPI呼び出し

このピースでできること

  • SmartHR APIの任意のエンドポイントに対して、指定したHTTPメソッドでリクエストを送信します。
  • 標準のアクションで対応していないAPIを、SmartHRに対して直接呼び出したい場合に利用します。
 

SmartHR の接続方法

以下の2つを入力して接続します。

サブドメイン

SmartHR の URL のサブドメインを入力します。
例: URL が の場合、サブドメインは example です。

アクセストークン

  1. SmartHR 管理画面にログインします
  1. 「設定」→「外部システム連携」→「アクセストークン」 を開きます
  1. 「トークンを発行する」 をクリックします
  1. 利用する機能に応じてアクセス権限を設定します
      • 従業員の取得・登録・更新を使用する場合は、従業員の参照・更新部署・役職・雇用形態・事業所・給与支給形態の参照 を許可してください
  1. 発行されたアクセストークンをコピーし、接続画面の 「アクセストークン」 欄に貼り付けます

サンドボックス環境(任意)

テスト・検証用のサンドボックス環境を使用する場合はチェックを入れてください。本番環境では不要です。
 

ピースの設定項目

1. URL(必須)

  • 呼び出したいAPIのURLを指定します。
  • 以下のどちらでも指定できます。
    • ベースURLからの相対パス(例:
    • 完全なURL(例:
[設定例]

2. Method(必須)

  • HTTPメソッドを選択します(GET / POST / PUT / PATCH / DELETE)。
[設定例]

3. Headers(任意)

  • 追加したいリクエストヘッダーを指定します。
  • 認証ヘッダーは接続情報から自動で付与されるため、通常は追加不要です。
[設定例]

4. Query Parameters(任意)

  • クエリパラメータを指定します(キーと値のペア)。
[設定例]

5. Body(任意)

  • リクエストボディをJSON形式で指定します。
  • GETの場合は通常空欄で問題ありません。
[設定例]

6. 失敗時にエラーにしない(任意)

  • 失敗してもフロー全体をエラーにしたくない場合にチェックします。
  • チェックすると、APIが失敗してもステップは成功扱いになります(取得結果の扱いはフロー設計に合わせてください)。
[設定例]