カスタムAPI呼び出し

このピースでできること

  • freee請求書の任意のAPIエンドポイントへカスタムAPIコールを実行します。
  • 標準アクションでは対応していない操作や機能を利用する際に使用できます。
 

freee請求書 の接続方法

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

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

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

ステップ 2:freee請求書 で OAuth クライアントを作成する

  1. freeeアプリストア でアプリケーションを登録します。
  1. コールバック URL に、ステップ 1 でコピーしたリダイレクト URL を追加して保存します。
  1. 権限設定 で、以下の項目にチェックを入れてください。
      • [freee請求書] 見積書・請求書・納品書・領収書: 参照・更新
      • [会計] 事業所: 参照(事業所の選択肢取得に使用)
      • [会計] 取引先: 参照(取引先の選択肢取得に使用)
      • 「カスタムAPI呼び出し」アクションを利用する場合は、そのエンドポイントに対応する権限も追加してください。
  1. 登録完了後、クライアントIDクライアントシークレット をコピーしておきます。

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

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

ピースの設定項目

1. URL(必須)

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

2. メソッド(必須)

  • HTTPメソッドを選択します。GET / POST / PUT / DELETE / PATCHから選べます。

3. ヘッダー(任意)

  • リクエストに追加するヘッダーを設定します。認証ヘッダーは接続情報から自動的に注入されます。

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

  • URLに付与するクエリパラメータをkey-value形式で設定します。

5. ボディ(任意)

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

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

  • 有効にするとAPIエラー時でもフローを継続します。