カスタムAPI呼び出し

このピースでできること

  • 楽楽販売のAPIの任意のエンドポイントにカスタムのAPIリクエストを実行します。
  • 認証ヘッダー(X-HD-apitoken)は接続情報から自動的に注入されます。
  • 明細行を含むレコード登録など、標準アクションでは対応できない操作も実行できます。

楽楽販売 の接続方法

workrun と楽楽販売を接続するには、楽楽販売の APIトークン および ドメイン・アカウント情報 が必要です。

ステップ 1:接続に必要な情報を準備する

  1. 楽楽販売で 「API連携オプション」 を契約します。
  1. 楽楽販売の管理者設定で、workrun のサーバーIPアドレスをIPアクセス制限に登録します。
      • 「管理者設定 > セキュリティ設定タブ > IPアクセス制限に関する設定」を開きます。
  1. APIトークンを発行します。
      • 「管理者設定 > ユーザ設定タブ > ユーザ管理 > 設定」でユーザー設定画面を開きます。
      • APIトークン欄の 「生成」 をクリックし、続けて 「確定」 ボタンをクリックします。
      • ⚠️「生成」しただけで「確定」を押していないトークンは無効です。必ず「確定」まで行ってください。
  1. 楽楽販売のURLからドメインとアカウントを確認します。
      • 例: の場合
        • ドメイン:
        • アカウント:

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

  1. workrun で楽楽販売のアクションをフローに追加します。
  1. 「接続を選択」の横にある 「+ 新しい接続」 をクリックします。
  1. 以下の3項目を入力します:
      • 「ドメイン」: ステップ 1 で確認したドメイン(例:
      • 「アカウント」: ステップ 1 で確認したアカウント(例:
      • 「APIトークン」: ステップ 1 で発行したAPIトークン
  1. 「保存」 をクリックします。入力した情報で楽楽販売への接続テストが自動で実行され、成功すると接続が完了します。

ピースの設定項目

1. URL(必須)

  • リクエスト先のURLを入力します。完全なURLまたはベースURL(https://{domain}/{account})からの相対パスのどちらでも指定できます。

2. メソッド(必須)

  • HTTPメソッドを選びます(GET / POST / PUT / DELETE / PATCH)。

3. ヘッダー(任意)

  • 追加のHTTPヘッダーをJSON形式で入力します。認証ヘッダー(X-HD-apitoken)は接続情報から自動注入されるため、入力不要です。

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

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

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

  • リクエストボディの形式を選びます(なし / JSON / Raw / フォームデータ)。

6. ボディ(任意)

  • リクエストボディを入力します。ボディタイプの選択に応じてJSONまたはテキスト形式で入力します。

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

  • PDFや画像などのファイルを受け取る場合はオンにします。

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

  • オンにするとHTTPエラー時にもフローを継続するフェイルセーフモードになります。

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

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

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

  • オンにするとリダイレクトを自動的にフォローします。