API コネクタの入力値を指定します

  • リリースバージョン: Yokohama
  • 更新日 2026年01月12日
  • 所要時間：2分

    • 有効な API 呼び出しを行い、接続をテストし、サンプル応答を受信するための入力パラメーターを指定します。

    始める前に

    すべてのテンプレートで、情報アイコン ( 詳細については小文字の i) を選択すると、各パラメーターの詳細を確認できます。各テンプレートに付属の API サンプルを使用できます。入力パラメーターを定義したら、接続をテストする必要があります。

    必要なロール：

    • sn_sec_spc_core.developer
    • sn_spc_cxf.admin:詳細スクリプティングに必要

    手順

    1. フィールドに入力します。
      注:
      接続のテスト後に入力パラメーターを変更した場合は、 API 応答を SPC 属性にマッピングを続行する前に接続を再度テストする必要があります。
      フィールド 説明 例
      オブジェクトリストパス 応答ペイロード内の資産のリストへのパス。 例: $.list
      API エンドポイントの相対パス これは、ホスト URL を含まない API へのパスです。 例: /r2
      API クエリパラメーター フィルタリングのために API URL に追加されるキーと値のペア。値には、文字列、スクリプト、または認証情報テーブルのフィールドへの参照を指定できます。

      例:

      Name [クエリパラメーターの名前]

      値のタイプ [静的値]

      値 [文字列]
      ページネーションパラメーター API データの後続のページを取得するために使用される動的パラメーター。パラメーター名、要求内の場所 (クエリ、ヘッダー、または本文)、API 応答から次の値を抽出するパス、およびオプションのデフォルト値を指定します。

      ページネーションタイプのオフセットの例:

      オフセット

      パラメーター名 [start]

      API 要求内の場所 [クエリパラメーター]

      デフォルト値:[0]

      補償限度額

      パラメーター名 [count]

      API 要求内の場所 [クエリパラメーター]

      デフォルト値:[5]
      (オプション)パラメータを追加 カスタムパラメーターを追加 [ パラメーターを追加] を選択して、独自のパラメーターを定義します。

      たとえば、API 応答に含まれる追加のデータページがあるかどうかを判断できます。

      パラメーター名 [hasMore]

      API 応答のパス [$.hasMore]

      API 要求内の場所 [ヘッダーパラメーター]

      デフォルト値:[1]
    2. API 入力に問題がなければ、[ サンプル応答の取得] を選択します。
      しばらくすると、接続に成功した場合はメッセージが表示されます。

      このステップのパラメーターを手動で入力した場合、サンプル応答でレンダリングされている接続テストからインポートされたデータは本物であり、次のステップでパラメーターをマッピングするために使用できます。

    3. [ 保存して続行] を選択して編集内容を保存します。
      続行するには、変更内容を保存する必要があります。