APIを利用することで、Airレジのデータを本部システムに連携させることができます。
連携方法と利用時の注意点についてご説明します。
本部システムとAirレジとの連携について
連携可能なデータ
Airレジの下記のデータが本部システムへ連携されます。
- ご利用方法により、連携されるデータには注意点があります。詳しくは、データ連携利用時の注意事項をご確認ください。
- 取引情報
-
- 会計
- 領収書印刷
- 伝票削除（未会計、会計済）
- 会計修正
- 返品・返金
- 返品取消
- 入出金情報
- 精算情報
連携可能な本部システム
Airレジと連携可能な本部システムについては、下記のページをご確認ください。
本部システムとの連携方法
Airレジ バックオフィスの「データ連携API」画面から、APIの利用設定を行います。
- Airレジ バックオフィス
-
- トップページ
- 設定
- 他システム連携［データ連携API］
- データ連携API
-
「データ連携API」画面で、「API利用」を「オン」にます。
-
「API利用規約の確認」が表示されます。
利用規約に同意し、「API利用を開始する」ボタンをクリックします。 -
API利用を開始すると、「APIキー」と「APIトークン」が表示されます。
表示された「APIキー」をコピーします。
-
「APIトークン」の「＋APIトークンを発行する」ボタンをクリックします。
-
表示された「APIトークン」をコピーします。
- 表示された「APIトークン」を削除した場合、操作のやり直しはできません。
APIトークンは外部へ漏洩しないよう取り扱いにご注意ください
APIトークンが漏洩した場合、セキュリティ上のリスクが発生する可能性があります。
漏洩した可能性がある場合は、一度APIトークンを削除し、再度「＋APIトークンを発行する」ボタンをクリックしてAPIトークンを再発行してください。 -
コピーした「APIキー」と「APIトークン」を、利用する本部システムへ設定すると、Airレジのデータを連携できるようになります。
- 本部システムへの設定方法は、ご利用のシステムにより異なります。詳細は各システム側へご確認ください。
システムIDの確認方法
本部システム側にマスタ登録機能がある場合は、登録作業用に支払い方法、割引・割増、サービス料のシステムIDを確認できます。
-
「データ連携API」画面で、「システムIDを確認する」ボタンをクリックします。
-
店舗で登録している支払い方法、割引・割増、サービス料が表示され、名称とシステムIDをコピーできます。
- 「支払い方法」には、利用していない支払い方法も一部表示されます。
- 「まとめ買い割引」はデータ連携には対応していないため、「割引・割増」には表示されません。
支払い方法、割引・割増、サービス料の登録方法については、下記のページをご確認ください。
データ連携利用時の注意事項
複数店舗を管理している場合
-
「データ連携API」画面でのAPI利用設定は、店舗ごとに行います。複数店舗を管理している場合は、データ連携するすべての店舗でAPI利用設定が必要です。
-
複数店舗の売上を横断で確認する場合、同一の商品に共通の商品コードを設定することで、横断での集計が可能となる場合があります※1。
- 商品コードは、「商品詳細」画面から設定できます。詳しくは下記のページをご確認ください。
-
本部システム側のマスタ管理によって横断で集計できる場合※1は、システムIDの値をご利用ください。
- システムIDの確認方法は、システムIDの確認方法をご確認ください。
- 集計方法やマスタ管理については、ご利用の本部システムにより異なります。詳細はご利用の本部システム側にご確認ください。
精算情報を連携する場合
-
「点検・精算」画面の「点検・精算」ボタンから精算を行ったデータが対象となります。「点検のみ」を行った場合は、精算データは連携されません。
- 精算は店舗の営業後、営業日の変更時刻の前に必ず行ってください。
- 営業日の変更時刻を過ぎてから精算を行うと、別の営業日として集計されます。
- ランチやディナーなど1日に複数回精算を行う場合や、店舗で複数のAirレジ アプリを利用している場合は、それぞれの端末ごとに精算データが本部システムに連携されます。
- 連携された精算データの取り扱いや集計方法は、本部システムごとに異なります。詳細はご利用の本部システム側にご確認ください。
過去のデータを連携する場合
- 連携開始時点から、過去2ヶ月前までのデータは連携が可能です。
本部システム側での過去データの取得方法については、本部システム側にご確認ください。
お困りごとは解決しましたか？
もしかすると他のキーワードで、お探しのページが見つかるかもしれません。