AIに聞くお問い合わせ
AIに聞くお問い合わせ
workrun ヘルプサイト/カスタムAPI呼び出し

カスタムAPI呼び出し

このピースでできること

  • スマレジ・プラットフォーム APIの任意のエンドポイントにHTTPリクエストを送信します。
  • 「取引の取得」「取引の登録」アクションでカバーされていないAPIも自由に呼び出せます。
  • 認証（Bearerトークン）は自動で付与されるため、設定不要です。

スマレジ の接続方法

workrun と スマレジ を接続するには、スマレジ の OAuth クライアント（クライアントID・クライアントシークレット） および 契約ID が必要です。

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

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

ステップ 2：スマレジ・デベロップスで OAuth クライアントを作成する

  1. デベロッパーズアカウント を作成します。
  1. スマレジ・デベロップス にログインし、アプリを新規登録します。
      • リダイレクトURI: ステップ 1 でコピーした URL を登録してください。
      • スコープ: 以下をすべて有効化してください。
        • pos.transactions:read
        • pos.transactions:write
        • pos.stores:read
        • pos.staffs:read
        • pos.customers:read
        • pos.products:read
        • 「カスタムAPI呼び出し」アクションを利用する場合は、そのエンドポイントに応じたスコープも追加してください。
  1. 本番環境のスマレジで利用する場合、スマレジ管理画面の「利用状況」から契約IDを入力し、登録したアプリをアクティベートしてください。
      • 契約IDはスマレジ管理画面の左上に表示されています。
  1. アプリの環境設定ページから クライアントID と クライアントシークレット をコピーします。
      • 本番環境で利用する場合は、開発環境ではなく本番環境の値を使用してください。

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

  1. ステップ 1 の接続画面に戻り、以下の項目を入力します。
      • 環境: 本番の場合は「本番」、サンドボックスの場合は「サンドボックス」を選択します。
      • 契約ID: スマレジ管理画面の左上に表示されている契約IDを入力します。サンドボックスの場合は 形式です。
      • スコープ: 利用するAPIのスコープをスペース区切りで入力します。初期値は標準スコープが設定されています。
      • クライアントID と クライアントシークレット: ステップ 2 でコピーした値を入力します。
  1. 「接続」 をクリックするとスマレジの認証画面が開きます。
  1. スマレジにログインし、workrun に対するアクセスを 「許可」 します。
  1. 画面が自動で閉じ、接続が完了します。

ピースの設定項目

1. URL（必須）

  • 呼び出すAPIのURLを入力します。完全なURLまたはベースURLからの相対パスを指定できます。スマレジ・プラットフォーム API（）のみ対応しており、認証エンドポイント（）は対象外です。

2. HTTPメソッド（必須）

  • リクエストのHTTPメソッドをドロップダウンから選択します。データ取得は「GET」、データ登録は「POST」、更新は「PUT」/「PATCH」、削除は「DELETE」を使用します。

3. ヘッダー（任意）

  • リクエストヘッダーをキーと値のペアで指定します。通常は不要です（認証ヘッダーは自動付与されます）。

4. クエリパラメータ（任意）

  • URLに付加するクエリパラメータをキーと値のペアで指定します。GETリクエストの絞り込み条件などに使います。

5. リクエストボディ（任意）

  • POSTやPUTリクエストで送信するJSONデータを入力します。GETリクエストでは不要です。