カスタムAPI呼び出し

このピースでできること

  • Carbone APIの任意のエンドポイントに対してHTTPリクエストを送信します。
  • 標準ピースでカバーされていないAPIエンドポイントを直接呼び出せます。認証ヘッダーは自動的に付与されます。

Carbone の接続方法

workrun と Carbone を接続するには、Carbone の API キー が必要です。

ステップ 1:API キーを取得する

  1. Carbone アカウント にログインします。
  1. 画面右上のアカウントメニューから 「API keys」 を選択します。
  1. 表示された API キーをコピーするか、新しい API キーを作成してコピーします。
      • API キーは他者に共有しないように注意してください。
      • キーを紛失した場合は、Carbone の管理画面から新しいキーを発行できます。

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

  1. workrun で Carbone のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 「API Key」 フィールドに、ステップ 1 でコピーした API キーを貼り付けます。
  1. 「保存」 をクリックして接続を完了します。

ピースの設定項目

1. HTTPメソッド(必須)

  • リクエストのHTTPメソッドを選択します(GET、POST、PATCH、PUT、DELETE、HEAD)。

2. URL(必須)

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

3. ヘッダー(任意)

  • 追加のリクエストヘッダーをJSON形式で入力します。認証ヘッダーは接続情報から自動的に付与されます。

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

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

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

  • リクエストボディの形式を選択します(None、JSON、Form Data、Raw)。

6. ボディ(任意)

  • リクエストボディを指定します。ボディタイプに合わせた形式で入力します。

7. バイナリレスポンス(任意)

  • PDFや画像などバイナリファイルを受け取る場合にONにします。

8. エラー時も続行(任意)

  • ONにするとエラーレスポンス時に例外をスローせず処理を続けます。

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

  • リクエストのタイムアウト時間を秒単位で指定します。

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

  • HTTPリダイレクトを自動的にフォローするかどうかを指定します。