カスタムAPI呼び出し

このピースでできること

  • Sansan APIに対して、URLとHTTPメソッドを指定して任意のAPI呼び出しを実行します。
  • 標準ピースで用意されていないAPIの呼び出しに使用できます。
 

Sansan の接続方法

Sansan の管理画面から発行した API キーを入力して接続します。

API キーの取得手順

  1. Sansan に管理者としてログインします
  1. 右上のメニューから 管理者設定 を開きます
  1. API キー のメニューを開きます
  1. 「API キーを発行する」 をクリックします
  1. 発行された API キーをコピーし、接続画面の 「API キー」 欄に貼り付けます

ピースの設定項目

1. URL(必須)

  • 呼び出したいAPIエンドポイントのパスを入力します。
  • 完全なURL、またはベースURL()からの相対パスを指定します。

2. Method(必須)

  • HTTPメソッドを選択します。

3. Headers(任意)

  • 追加で送信したいリクエストヘッダーを設定します。
  • JSONのオブジェクト形式で入力します。
  • 認証ヘッダー()は自動で付与されるため、通常は設定不要です。

4. Query Params(任意)

  • クエリパラメータを設定します。
  • JSONのオブジェクト形式で入力します。

5. Body(任意)

  • リクエストボディを設定します(主にPOST/PUTなどで使用します)。
  • , , , から選びます。

6. Body(任意)

  • リクエストボディを指定します。
  • の場合は、JSONとして入力します。