カスタムAPI呼び出し

このピースでできること

  • CPaaS NOW(SMS)のAPIに対して、任意のHTTPリクエストを実行します。
  • 標準アクションでは対応していないエンドポイントへのアクセスや、細かいパラメータ制御が必要な場合に使用できます。
  • 認証ヘッダー(APIToken)は接続設定から自動で付与されます。

CPaaS NOW(SMS) の接続方法

workrun と CPaaS NOW(SMS) を接続するには、CPaaS NOW の APIトークン接続先環境 の情報が必要です。

ステップ 1:APIトークンを取得する

  1. CPaaS NOW の管理画面にログインします。
  1. 設定画面からAPIトークンを発行し、コピーします。

ステップ 2:workrun に接続を追加する

  1. workrun で CPaaS NOW(SMS) のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「APIトークン」 フィールドに、ステップ 1 でコピーしたAPIトークンを貼り付けます。
  1. 「環境」 プルダウンで、利用する環境を選択します。
      • sandbox(開発環境): テスト・開発用の環境です。
      • production(本番環境): 実際のSMS配信に使用する本番環境です。
  1. 「保存」 をクリックして接続を完了します。

ピースの設定項目

1. URL(必須)

  • リクエスト先のURLを入力します。完全なURLまたはベースURLからの相対パスを指定できます。

2. メソッド(必須)

  • HTTPメソッドを選択します(GET・ POST・PUT・DELETE など)。

3. ヘッダー(任意)

  • 追加のHTTPヘッダーを配列形式で入力します。認証ヘッダーは自動付与されるため不要です。

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

  • URLに付加するクエリパラメータを配列形式で入力します。

5. ボディタイプ(任意)

  • リクエストボディの形式を選択します(json・ form・ none)。

6. ボディ(任意)

  • POST/PUTの場合にリクエストボディをJSON形式で入力します。

7. 応答はバイナリですか?(任意)

  • PDF・画像などバイナリデータを受け取る場合は「true」にしてください。

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

  • HTTPエラーが発生してもフローを継続する場合は「true」にしてください。

9. タイムアウト(秒)(任意)

  • リクエストのタイムアウト秒数を入力します。

10. リダイレクトをフォローする(任意)

  • リダイレクトを自動でフォローする場合は「true」にしてください。