スマレジAPIとスマレジ・プラットフォームAPIの違い
スマレジでは現在「スマレジAPI」と「スマレジ・プラットフォームAPI」の2種類のAPIを提供しています。
ここでは、それぞれの概要やエンドポイント・認証方式の違い、適した利用シナリオ、そして開発時によくある混乱とその対処法について、解説します。
それぞれのAPIの概要
Section titled “それぞれのAPIの概要”スマレジAPIとは
Section titled “スマレジAPIとは”『スマレジAPI』は従来より提供しているAPIで、スマレジ管理画面にて設定やアクセストークンの発行を行ないます。
スマレジの管理画面の「設定 ＞ システム連携 ＞ スマレジAPI設定」でAPI連携を「利用する」に変更し、「契約ID」と「アクセストークン」を発行して利用します。
アクセストークンは有効期限のない固定の値です。（再発行も可能です）
スマレジAPIの仕様書はスマレジ管理画面からダウンロードを行う必要があります。
スマレジAPIの仕様書のダウンロード方法
なお、スマレジAPIは今後スマレジ・プラットフォームAPIへの移行が予定されており、 新しい機能追加やアップデートは行われない見込みです。 そのため、新規開発の場合は後述するスマレジ・プラットフォームAPIの利用が推奨されます。
スマレジ・プラットフォームAPIとは
Section titled “スマレジ・プラットフォームAPIとは”スマレジでは、2020年にスマレジのアプリケーションプラットフォーム『スマレジ・アプリマーケット』を公開しました。 スマレジがプラットフォーマーとなることで、開発者がサービスをスマレジユーザー向けに提供可能になり、ユーザーは自身の運用や利用状況にあわせたサービスを探し、利用・購入することが可能になりました。
スマレジ・プラットフォームAPIでは、OAuth2.0認証を採用し、スマレジユーザーの環境に対して開発者が連携アプリケーションを構築・提供できるよう設計されています。
開発したアプリは基本的にアプリマーケットに公開してご利用いただいております。 （公開範囲を設定したり、公開せずに利用することも可能です） そのため、外部システムと連携するためにはアプリとして登録し、登録したアプリにて連携設定も行ないます。
アプリの登録・設定などはすべて開発者専用のデベロッパーズアカウントで行なうため、スマレジAPIのように設定などをユーザーが行なう必要がなくなります。
ユーザーは、アプリマーケットに公開されたアプリを購入することで利用できるようになります。
スマレジを利用している契約IDのデータを直接操作する場合、従来はスマレジAPIを利用する必要がありました。
2024年10月29日のリリースより、マイページからプラットフォームAPIの利用設定ができるようになりました。
これにより、スマレジを利用している契約IDに対してもスマレジAPIではなくスマレジ・プラットフォームAPIを利用することが可能になりました。
主な用途・対象ユーザーの違い
Section titled “主な用途・対象ユーザーの違い”スマレジAPI
Section titled “スマレジAPI”スマレジAPIを利用するには、アカウント内でのデータ操作が必要です。
例えば、自社店舗の売上データを独自の基幹システムに取り込みたい場合や、自店舗の商品マスタを一括更新するといった個別企業内の開発にて利用されていました。
スマレジ・プラットフォームAPI
Section titled “スマレジ・プラットフォームAPI”スマレジ・プラットフォームAPIは、スマレジの開発パートナーや第三者開発者が、スマレジと連携するアプリケーションを開発・提供するためのAPIです。複数のスマレジユーザーに利用してもらうことを前提とした汎用的なサービス連携やアプリ開発に適しています。
例えば、スマレジとECサイトをつなぐ汎用アプリを作ってマーケットで販売したり、自社サービス（クラウドソフト等）とスマレジを連携させて多数の店舗に提供するなどです。
新規で開発を実施される場合は、スマレジ・プラットフォームAPIを推奨しています。
具体的な廃止時期は現在未定ですが、スマレジAPIは廃止予定であり、基本的にスマレジ・プラットフォームAPIを利用いただくことを推奨しています。（2025/3月末現在） 現在、スマレジAPIで実現可能な操作のうち、スマレジ・プラットフォームAPIで実現できない操作が存在しますが、順次対応予定ですので対応をお待ちいただければと思います。
API機能の主な違い
Section titled “API機能の主な違い”検証環境について
Section titled “検証環境について”スマレジAPIでは、設定や検証はすべて、通常アカウントを作成し、試用期間などで検証する必要がありました。 スマレジ・プラットフォームAPIでは、デベロッパーズアカウントに各プロダクトの管理画面も用意しており、検証用のアカウントとしてご利用いただけます。
デベロッパーズアカウントの環境を開発環境（サンドボックス環境）、ユーザーが利用する環境を本番環境（プロダクション環境）といい、リクエストのエンドポイントなどが開発環境と本番環境で異なります。
詳細については、こちらのヘルプページをご覧ください。
スマレジAPIでは、スマレジ管理画面からAPI連携の設定を行なう必要がありましたが、スマレジ・プラットフォームAPIでは、デベロッパーズアカウントにて設定を行ないます。 設定をするために必ず『アプリ』として登録する必要があり、アプリ単位での設定になるため、複数のシステムとの連携も容易になります。
スマレジAPIでできてスマレジ・プラットフォームAPIでできないこと
Section titled “スマレジAPIでできてスマレジ・プラットフォームAPIでできないこと”送信機能やWebhook
Section titled “送信機能やWebhook”スマレジAPIでは、送信機能の利用をONにしてもAPI経由のデータの登録や更新の通知はされませんでしたが、スマレジ・プラットフォームAPIでは、APIでデータの登録や更新を行なうとWebhookにて通知を受け取ることができます。
スマレジAPIの送信APIでは、全項目の情報が通知されていましたが、スマレジ・プラットフォームAPIでは、イベント名（商品など）とアクション（登録・更新・削除など）、主キーである項目（商品IDなど）の通知のみです。 通知された情報をもとに、取得APIを利用してデータを取得する必要があります。 具体的な通知内容は仕様書をご確認ください。
※スマレジ・タイムカードでは、現在Webhook機能の提供はありません
Webhook送信後『3秒以内』にレスポンスを受信できなければ、エラーとして扱い送信処理を終了します。
スマレジAPIでは、送信履歴を確認でき、再送信も可能でしたが、スマレジ・プラットフォームAPIでは、履歴の確認も再送信も行なうことができません。 エラーが発生しても問題ない仕組みづくりを行なう必要があります。
※送信履歴と再送信機能の追加について、現在検討中です
送信URL / ヘッダ情報 / パラメータ情報の個別設定
Section titled “送信URL / ヘッダ情報 / パラメータ情報の個別設定”スマレジAPIでは、送信URL / ヘッダ情報 / パラメータ情報を機能ごとに個別で設定できましたが、スマレジ・プラットフォームAPIでは、アプリ単位での設定となります。 送信URL / ヘッダ情報 / パラメータ情報を機能ごとに設定したい場合は、それぞれ別のアプリとして登録する必要があります。
マスタのID指定
Section titled “マスタのID指定”スマレジAPIでは、登録と更新を同じAPIで行っていたため、マスタを新規登録するときに一部項目では、IDを指定して登録することができましたが、スマレジ・プラットフォームAPIでマスタの登録を行なう際はIDを指定することができず、最大値 +1 の値が自動採番されます。
エラーメールの送信
Section titled “エラーメールの送信”スマレジAPIで連携しているとき、エラーが発生すると指定したメールアドレス宛にエラー内容を送信することができましたが、スマレジ・プラットフォームAPIでは、メールへの送信機能がありません。 レスポンスログからエラー内容を確認する必要があります。 ※弊社にお問い合わせいただいても回答できない可能性がありますので、必ずログを残してください
スマレジに関する機能について
Section titled “スマレジに関する機能について”- スタッフの登録・更新（取得は可能）
- 取置き登録APIや仮販売登録APIで『クーポン値引き』の指定
- 日次締め情報取得APIで客数の取得
ウェイターに関する機能について
Section titled “ウェイターに関する機能について ”- メニューの登録・更新（取得は可能）
- テーブルの移動や分割・結合
スマレジAPIでできなくてスマレジ・プラットフォームAPIでできること
Section titled “スマレジAPIでできなくてスマレジ・プラットフォームAPIでできること”スマレジ・タイムカードAPI
Section titled “スマレジ・タイムカードAPI”スマレジAPIでは、スマレジ・タイムカードに関するAPIの用意がありませんでしたが、 スマレジ・プラットフォームAPIでは、スマレジ・タイムカードに関するAPIも追加しました。 スマレジ・タイムカード仕様書 機能の追加も予定されておりますので、ぜひご利用ください。
お知らせについて
Section titled “お知らせについて”スマレジAPIでは、APIに関するお知らせもユーザーへ送られていましたが、スマレジ・プラットフォームAPIでは、デベロッパーズアカウントにログインすることで、トップ画面からAPIに関するお知らせをご確認いただけます。
スマレジ・アプリなどにログインしての検証
Section titled “スマレジ・アプリなどにログインしての検証”スマレジ・プラットフォームAPIの開発時にスマレジ・アプリやウェイター・アプリ、タイムカード・アプリでの検証が必要になることもあるかと思います。 アプリをインストールしてそのままの状態だと、本番環境のアプリになるため、デベロッパーズアカウントでログインすることができません。 開発環境（サンドボックス環境）に切り替えて利用する必要があります。
切り替え方法についてはこちらのヘルプページをご覧ください。
スマレジに関する機能について
Section titled “スマレジに関する機能について”ウェイターに関する機能について
Section titled “ウェイターに関する機能について ”今後の機能追加はスマレジ・プラットフォームAPIのみになり、上記に記載した通り様々な機能がスマレジ・プラットフォームAPIでのみ追加対応を行なっています。 現在、スマレジAPIでできてスマレジ・プラットフォームAPIでできないことも、スマレジ・プラットフォームAPIで対応予定です。
利用時の注意点
Section titled “利用時の注意点”リクエストの回数制限
Section titled “リクエストの回数制限”スマレジAPIでもリクエスト回数に制限を設けておりましたが、スマレジ・プラットフォームAPIでも制限を設けております。
制限内容については、こちらの仕様書をご確認ください。
サーバー保護のための制限になりますので、ご協力をお願いいたします。
お問い合わせについて
Section titled “お問い合わせについて”API連携に関する弊社へのお問い合わせはメールでのみ受け付けております。 専門的な内容になるため、電話対応やチャット対応は行なっておりませんので、あらかじめご了承ください。
お問い合わせ先： support_developer[アットマーク]smaregi.jp
リクエストやエラーに関するお問い合わせの場合、リクエスト内容やレスポンス内容を確認してご案内いたします。 リクエスト内容やレスポンス内容は開発者さまよりご提供いただいておりますので、ログは残すようにご対応いただければと存じます。 ※成功時もですが、エラー発生時は必ずご対応ください