本ページでは、スマレジに接続するための設定(接続情報)について説明します。
転送設定については、転送元 - スマレジを参照ください。
認証方式
スマレジ接続情報では、以下の認証方式をサポートしています。
- OAuth 2.0
OAuth 2.0認証について
スマレジAPIは、OAuth 2.0標準に準拠した認証方式を採用しています。
TROCCOでは、OAuth 2.0のAuthorization Code Flowを使用してユーザー委譲アクセスを行います。
TROCCOで接続情報を設定する前に、スマレジAppMarketで利用申し込みが必要です。
詳しくはスマレジ側で必要な作業を参照ください。
OAuth 2.0認証では、以下のフローで認証を実施します。
- TROCCOからスマレジの認証画面にリダイレクトされます。
- ユーザーがスマレジアカウントでログインし、権限の付与を許可します。
- 認証が成功すると、TROCCOにアクセストークンとリフレッシュトークンが発行されます。
- TROCCOは、このトークンを使用してスマレジAPIにアクセスします。
スマレジのリフレッシュトークンの有効期限は、30日間です。
30日間アクセスがない場合、再度認証が必要になります。
定期的に転送設定を実行することで、自動的にトークンが更新されます。
スマレジ側の事前準備
認証を行う前に、スマレジAppMarketで利用申込が必要です。まずは以下の手順でTROCCOアプリの利用申込を完了してください。
- スマレジAppMarketのTROCCOアプリページ にアクセスし、「ログインして申込」をクリック
- スマレジへログインし、プラン「無料プラン」を選択し、「利用を開始」をクリック
- 権限許可の画面が表示されるので「許可して進む」をクリック
設定項目
スマレジ接続情報の設定項目は以下のとおりです。
| 項目名 | 必須 | デフォルト値 | 内容 |
|---|---|---|---|
| 接続情報名 | Yes | - | 接続情報の識別名を入力します。わかりやすい名前を付けることを推奨します。 |
| 説明 | - | - | 接続情報の説明を入力します。この接続情報の用途などを記載できます。 |
| スマレジアカウント | Yes | - | スマレジアカウントで認証を行います。スマレジアカウント認証ボタンをクリックして、OAuth 2.0認証を実施してください。 |
スマレジアカウント認証の手順
スマレジアカウント認証は、以下の手順で実施します。
- 接続情報の新規作成画面または編集画面で、スマレジアカウント認証ボタンをクリックします。
- スマレジのログイン画面にリダイレクトされます。
- スマレジアカウントの認証情報(メールアドレスとパスワード)を入力してログインします。
- 権限の許可画面が表示されます。TROCCOが要求する権限を確認し、許可をクリックします。
- TROCCOの接続情報画面に戻ります。認証日時が表示されていることを確認してください。
- 接続情報を保存します。
TROCCOは、以下の読み取り専用権限を要求します。
- 商品情報の読み取り
- 顧客情報の読み取り
- 在庫情報の読み取り
- 在庫変動情報の読み取り
- 取引情報の読み取り
- 仕入先情報の読み取り
- 店舗情報の読み取り
- スタッフ情報の読み取り
すべて読み取り専用権限のため、TROCCOがスマレジのデータを変更することはありません。
スマレジ側での権限付与
スマレジからデータを取得する場合、認証に使用するユーザーアカウントに適切なロールが付与されている必要があります。
認証したユーザーアカウントがアクセス可能なデータのみが転送対象となります。
必要なデータにアクセスできない場合は、スマレジの管理者に連絡して、適切なロールを付与してもらってください。
スマレジのOAuth 2.0認証(UserAccessToken)では、ロールとロケーションに基づいたアクセス制御が適用されます。
認証したユーザーが管理画面でアクセスできるデータと同じ範囲のデータのみが、TROCCOで取得可能です。
データが取得できない場合は、スマレジの管理画面で該当ユーザーのロールとロケーション設定を確認してください。