カスタムAPI呼び出し

このピースでできること

  • BASE のAPIのうち、他のピースとして用意されていない機能(注文情報の取得など)を、直接呼び出して実行します。
  • 接続の認証情報は自動で付与されるため、認証用のヘッダーを自分で入力する必要はありません。
⚠️
BASE のAPIは JSON 形式のボディを受け付けません。POST リクエストを送る場合は、以下の3点が必要です。
  1. 「ボディタイプ」を「Raw」に設定する
  1. 「ボディ」を のような形式で記述する
  1. 「ヘッダー」に を追加する

BASE の接続方法

workrun と BASE を接続するには、BASE の OAuth クライアント(クライアントID・クライアントシークレット) が必要です。

ステップ 1:workrun のリダイレクト URL を確認する

  1. workrun で BASE のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。

ステップ 2:BASE でアプリケーションを登録する

  1. BASE Developers ()にアクセスし、アプリケーションを登録します。
  1. コールバック URL に、ステップ 1 でコピーしたリダイレクト URL をそのまま入力します。
  1. 登録後に表示される client_id(クライアントID)client_secret(クライアントシークレット) をコピーしておきます。
スコープ一覧
スコープ名説明
read_usersショップオーナーの情報の参照を許可します。
read_users_mailショップオーナーのメールアドレスの参照を許可します。
read_items商品情報の参照を許可します。
read_orders注文情報の参照を許可します。
read_savings引き出し情報の参照を許可します。
write_items商品の登録・更新を許可します。
write_orders注文の更新を許可します。

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

  1. ステップ 1 の接続画面に戻り、クライアントIDクライアントシークレット をそれぞれ貼り付けます。
  1. 「接続」 をクリックすると、BASE の認証画面が開きます。
  1. BASE にログインし、workrun に対するアクセスを 「許可」 します。
  1. 画面が自動で閉じ、接続が完了します。

ピースの設定項目

1. URL(必須)

  • 呼び出したいAPIのURLを入力します。
  • 完全なURLでも、ベースURLからの相対パスでも指定できます。
    • 完全なURLの例:
    • 相対パスの例:
[設定例]

2. メソッド(必須)

  • APIを呼び出すときのHTTPメソッドを選びます(GET / POST / PUT / DELETE / PATCH)。
  • 情報を取得する場合はGET、新規作成する場合はPOSTを選ぶのが一般的です。
[設定例]

3. ヘッダー(任意)

  • APIへ送る追加のヘッダーを指定します。
  • 認証用のヘッダーは接続から自動で付与されます。
  • POST を送る場合は をここに追加してください。
[設定例]

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

  • URLの末尾に付け加える条件を指定します。
[設定例]

5. ボディ(任意)

  • POST などで送るデータを指定します。
  • 上の注意書きのとおり、JSON ではなく の形式で記述します。
  • GETの場合は通常入力不要です。
[設定例]

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

  • オンにすると、APIがエラーを返してもフローを止めずに次のステップへ進みます。
[設定例]

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

  • APIからの応答を待つ最大秒数を指定します。
[設定例]