開発環境と本番環境の違い
スマレジ・プラットフォームには、アプリの開発・検証に利用する 開発環境(サンドボックス) と、実際のスマレジ利用店舗が使用する 本番環境 の2つの環境があります。
本ページでは、それぞれの環境の役割と違い、開発から公開までの流れにおける環境の使い分けについて解説します。
2つの環境の概要
Section titled “2つの環境の概要”開発環境は、開発者がスマレジとの連携構築や検証を行うための環境です。
スマレジ・デベロッパーズにデベロッパーズアカウントを登録すると、開発環境(テスト用のスマレジ契約データ)が自動的に用意されます。
開発環境では架空の店舗データを自由に操作できるため、実際の店舗の本番データに影響を与えることなく、APIの挙動確認やアプリの動作検証を安全に行うことができます。
本番環境は、実際のスマレジ利用店舗(エンドユーザー)が利用する環境です。
開発・検証が完了したアプリは、本番環境で実際の店舗データを扱って動作します。パブリックアプリであればスマレジ・アプリマーケットを通じて、プライベートアプリであれば自社・特定店舗のスマレジ契約に対して、本番環境で利用を開始します。
環境ごとの違い一覧
Section titled “環境ごとの違い一覧”開発環境と本番環境では、各種URLや認証情報(クライアントID・クライアントシークレット)がすべて異なります。
| 項目 | 開発環境 | 本番環境 |
|---|---|---|
| 用途 | アプリの開発・検証 | 実際のユーザーによる利用 |
| 管理画面ログインURL | https://accounts.smaregi.dev/login |
https://accounts.smaregi.jp/login |
| アクセストークンAPI | https://id.smaregi.dev |
https://id.smaregi.jp |
| プラットフォームAPI | https://api.smaregi.dev |
https://api.smaregi.jp |
| 契約ID | sb_ から始まる(例: sb_xxxxx) |
通常の契約ID |
| クライアントID / クライアントシークレット | 開発環境用の値 | 本番環境用の値 |
| データ | テスト用の架空データ | 実際の店舗データ |
クライアント情報は環境ごとに発行されます
Section titled “クライアント情報は環境ごとに発行されます”スマレジ・デベロッパーズのアプリ「環境設定」ページには、開発環境用と本番環境用それぞれのクライアントIDとクライアントシークレットが表示されます。
利用したい環境に対応したクライアント情報とエンドポイントの組み合わせを使用してください。
開発環境と本番環境でクライアント情報・契約ID・エンドポイントを取り違えると、アクセストークン取得時に 401 Unauthorized(invalid_client)などのエラーが発生します。エラーが発生した場合は、環境の組み合わせが正しいかを確認してください。
その他の環境差異
Section titled “その他の環境差異”- レート制限(スロットリング): 開発環境と本番環境ではリクエスト回数の制限値が異なります。詳細は共通仕様のレート制限をご確認ください。
- Webhookの送信先エンドポイント: 開発環境のみ
http://で始まるURLを設定できます(本番環境との差異を少なくするためhttps://を推奨します)。また、本番環境のWebhook設定は、スマレジ・デベロッパーズでの申請/公開の後に反映されます。
開発から公開までの流れ
Section titled “開発から公開までの流れ”アプリ開発では、次のように環境を使い分けます。
1. 開発環境でアプリを登録する
Section titled “1. 開発環境でアプリを登録する”スマレジ・デベロッパーズのダッシュボードからアプリを新規登録します。この際、パブリックアプリかプライベートアプリかを選択します。
アプリの種類については「API ドキュメント クイックスタートガイド」をご確認ください。
2. 開発を行う
Section titled “2. 開発を行う”開発環境用のクライアント情報とエンドポイント(id.smaregi.dev / api.smaregi.dev)を使用して、アプリを開発します。
アクセストークンの取得方法は「スコープの設定 ~ アクセストークンの取得」をご確認ください。
3. 検証を行う
Section titled “3. 検証を行う”開発環境のテストデータを使って、アプリの動作を検証します。
スマレジのレジアプリ(スマレジ・アプリ)と連携した検証を行う場合は、スマレジ・デベロッパーズの管理画面の「設定 > スマレジアプリ環境切替」から、スマレジ・アプリの接続先を開発環境に切り替えることができます。切り替えの手順は端末(iOS / PC)によって異なるため、管理画面の案内に従ってください。
4. ユーザーへ公開する
Section titled “4. ユーザーへ公開する”- パブリックアプリの場合: スマレジ・デベロッパーズから公開申請を行い、審査に合格するとスマレジ・アプリマーケットに掲載されます。ユーザーはマーケットからアプリをインストールし、本番環境で利用します。
- プライベートアプリの場合: 審査は不要です。本番環境のスマレジ契約に対してアプリを連携(アクティベート)することで利用を開始できます。
公開・リリース時には、アプリで使用するクライアント情報・エンドポイントを本番環境用に切り替えることを忘れないようにしてください。
アプリマーケットでの購入フローのテストは、開発環境では行えず本番環境でのみ可能です。テスト用のスマレジアカウントが必要な場合は、スマレジの新規アカウント登録から取得できます。