カスタムAPI呼び出し

このピースでできること

  • クラウドサイン APIに対して、任意のエンドポイントを指定してリクエストを送信します。
  • 標準のピースで対応していないAPIでも、URLやメソッドを指定して実行できます。
 

クラウドサイン の接続方法

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

環境

接続先の環境を選択します。
  • プロダクション — 本番環境(通常はこちらを選択)
  • サンドボックス — テスト・検証用環境

クライアントID

クラウドサインの管理画面から発行したクライアントIDを入力します。
  1. クラウドサイン管理画面にログインします
  1. 「外部連携」 または 「API 連携」 メニューを開きます
  1. クライアントIDを発行し、コピーします
  1. 接続画面の 「クライアントID」 欄に貼り付けます
サンドボックス環境でテストする場合は、サンドボックス用のクライアントIDを別途取得してください。
 

ピースの設定項目

1. URL(必須)

  • 呼び出したいAPIのURLを指定します。
  • の完全なURL、または のような相対パスを指定できます。

2. メソッド(必須)

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

3. ヘッダー(任意)

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

4. クエリパラメータ(任意)

  • URLに付与するクエリパラメータを指定します。

5. ボディ(任意)

  • リクエストボディを指定します。
  • POST/PUTなどで送るJSONを入力する場合に利用します。