カスタムAPI呼び出し
このピースでできることBASE の接続方法ステップ 1:workrun のリダイレクト URL を確認するステップ 2:BASE でアプリケーションを登録するステップ 3:workrun に接続を追加するピースの設定項目1. URL(必須)2. メソッド(必須)3. ヘッダー(任意)4. クエリパラメータ(任意)5. ボディ(任意)6. 失敗時にエラーにしない(任意)7. タイムアウト(秒)(任意)
このピースでできること
- BASE のAPIのうち、他のピースとして用意されていない機能(注文情報の取得など)を、直接呼び出して実行します。
- 接続の認証情報は自動で付与されるため、認証用のヘッダーを自分で入力する必要はありません。
BASE のAPIは JSON 形式のボディを受け付けません。POST リクエストを送る場合は、以下の3点が必要です。
- 「ボディタイプ」を「Raw」に設定する
- 「ボディ」を のような形式で記述する
- 「ヘッダー」に を追加する
BASE の接続方法
workrun と BASE を接続するには、BASE の OAuth クライアント(クライアントID・クライアントシークレット) が必要です。
ステップ 1:workrun のリダイレクト URL を確認する
- workrun で BASE のアクションをフローに追加します。
- 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
- 接続画面に表示される 「リダイレクト URL」 をコピーしておきます。
ステップ 2:BASE でアプリケーションを登録する
- BASE Developers ()にアクセスし、アプリケーションを登録します。
- コールバック URL に、ステップ 1 でコピーしたリダイレクト URL をそのまま入力します。
- 登録後に表示される client_id(クライアントID) と client_secret(クライアントシークレット) をコピーしておきます。
スコープ一覧
| スコープ名 | 説明 |
|---|---|
| read_users | ショップオーナーの情報の参照を許可します。 |
| read_users_mail | ショップオーナーのメールアドレスの参照を許可します。 |
| read_items | 商品情報の参照を許可します。 |
| read_orders | 注文情報の参照を許可します。 |
| read_savings | 引き出し情報の参照を許可します。 |
| write_items | 商品の登録・更新を許可します。 |
| write_orders | 注文の更新を許可します。 |
ステップ 3:workrun に接続を追加する
- ステップ 1 の接続画面に戻り、クライアントID と クライアントシークレット をそれぞれ貼り付けます。
- 「接続」 をクリックすると、BASE の認証画面が開きます。
- BASE にログインし、workrun に対するアクセスを 「許可」 します。
- 画面が自動で閉じ、接続が完了します。
ピースの設定項目
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からの応答を待つ最大秒数を指定します。
[設定例]