はじめに
CData スマレジ ドライバーを使用してスマレジのプラットフォームAPI と連携する方法について解説します。スマレジではWeb API として「スマレジAPI」と「プラットフォームAPI」の2種類が提供されており、それぞれに特徴があります。CData スマレジドライバーはバージョンV25 でプラットフォームAPI への接続に対応しました。
本記事では、このプラットフォームAPI を活用してスマレジのデータにアクセスする手順を詳しくご紹介します。
プラットフォームAPI の特長
スマレジAPI と比較したときのプラットフォームAPI の特長は、よりセキュアなOAuth 2.0 認証に対応していることに加え、より多くのデータにアクセスできることです。プラットフォームAPI でアクセス可能になったデータを以下の表に示します。
テーブル／ビュー | 対象データ |
Adjustments | 精算 |
AppPaymentMethods | 個別アプリ専用支払方法 |
BudgetStaffs | スタッフ別予算 |
Bundles | バンドル |
ConsumptionTaxRates | 消費税率 |
Coupons | クーポン |
CustomerGroups | 客層 |
CustomerRequiredColumnSettings | 会員必須項目設定取得 |
DailyBudget | 日別予算 |
DiscountDivisions | 値引／割引区分 |
MonthlyBudget | 月別予算 |
PaymentMethods | 支払方法 |
ReduceTaxRates | 軽減税率 |
Roles | 役割・役職 |
TemporaryTransactions | 仮販売 |
Terminals | 端末 |
スマレジAPI からプラットフォームAPI への移行について
スマレジでは現在、従来のスマレジAPI から新しいプラットフォームAPI への移行が進められています。プラットフォームAPI は、より安定した接続とセキュリティを提供し、将来的にはメインのAPIとなる予定です。移行に関する詳細はスマレジの公式ドキュメントをご確認ください。
スマレジでのプラットフォームAPI利用設定
本章ではスマレジでプラットフォームAPI を利用するための設定方法を説明します。なお、この設定には管理者アカウントが必要です。
ステップ1: スマレジ管理画面にログイン
はじめにスマレジ管理画面にログインし、メニューの[設定]から[プラットフォームAPI設定]を選択します。
ステップ2: 基本情報の設定
プラットフォームAPI 設定画面が表示されたら、基本情報タブで以下の設定を行います：
[プラットフォームAPI 設定利用] を「利用する」に切り替え
[クライアント名] に適当な名前を入力
[リダイレクトURI] にドライバーのデフォルトリダイレクトURL「https://localhost:33333」を入力
[クライアントID] と[クライアントシークレット] の値をそれぞれコピーしてメモ帳などに保存
以上の設定を行ったら設定の画面下の[更新]ボタンを押下して設定を保存します。
ステップ3: スコープの設定
次に、プラットフォームAPI 設定画面の[スコープ] タブを開き、スマレジPOSサービスのすべてのスコープを利用するために「すべて」をチェックします。なお、一部のスコープのみを有効にした場合、それに合わせて接続可能なテーブルも限定されますのでご注意ください。スコープの設定が完了したら画面下の「更新」ボタンを押下して設定を保存します。
ドライバーからの接続設定
CData スマレジ Driverを使用してプラットフォームAPIに接続するには、少なくとも以下の接続プロパティを設定します。
プロパティ | 設定値 |
ContractId | スマレジの契約ID |
Schema | 「PlatformAPI」 |
AuthScheme | 「OAuthClient」 |
InitiateOAuth | 「GETANDREFRESH」 |
OAuthClientId | スマレジプラットフォームAPI設定画面のクライアントID |
OAuthClientSecret | スマレジプラットフォームAPI設定画面のクライアントシークレット |
JDBCドライバーでの接続設定例
以下にCData Smaregi JDBC ドライバーで接続する際の接続文字列の例を示します。
jdbc:smaregi:ContractId=abc123d4;Schema=PlatformAPI;AuthScheme=OAuthClient;InitiateOAuth=GETANDREFRESH;OAuthClientId=123456789;OAuthClientSecret=abcdedfg;
ODBCドライバーでの接続設定例
以下にCData Smaregi ODBC ドライバーで接続する際のDSN の設定例を示します。
Excel Add-Insでのデータ取得実例
最後にCData Smaregi Excel Add-Ins を使ってExcel から商品データを取得してみます。接続時のプロパティは前章「ODBC ドライバーからの接続」を参考にしてください。
1.テーブルの一覧から商品データにアクセスするProducts テーブルを選択します。
2.取得するカラムを選択します。
3.以下のようにプラットフォームAPI を通して商品データが取得できました。
おわりに
CData スマレジドライバーとプラットフォームAPI を組み合わせることで、スマレジのデータを様々なアプリケーションで活用できるようになります。JDBC、ODBC、Excel Add-Ins、Power BI、Tableau など、多様な接続方法・ツールに対応しているため、既存のシステムやワークフローに容易に統合できます。プラットフォームAPI の活用により、より安定したデータ連携が可能になり、ビジネスの効率化と意思決定の迅速化を実現できます。CData スマレジドライバーは30 日間無料で試用いただけますので、スマレジとの連携をご検討の方はぜひお試しください。
