開発したアプリをスマレジと連携させるためには、スコープ（連携の影響範囲）とWebhookの設定が必要です。
スコープとWebhookを適性に設定することで、スマレジと開発アプリを想定通りに連携させることができます。
■スコープ
■Webhook
■スコープ
スコープとは
スマレジ・デベロッパーズのスコープでは、開発したアプリがスマレジのサービスのどの機能に影響するかを設定します。アプリと連携させたい機能を選択して影響範囲を設定してください。
スコープの設定
スマレジ・デベロッパーズの『アプリ ＞ スコープ』を開きます。
設定したいスマレジのサービスを選択して、開発アプリと連携させる機能をONに切り替えます。
設定が完了したら『保存』をクリックして完了です。
設定したいスマレジのサービスを選択して、開発アプリと連携させる機能をONに切り替えます。
設定が完了したら『保存』をクリックして完了です。
アプリの公開後は変更できません
開発したアプリの申請が承認され、一度スマレジ・アプリマーケットへ公開されると、スコープの設定は一切変更することができなくなります。スコープを変更したい場合は、再度アプリの新規登録からやり直す必要があります。
アプリの申請前に、スコープの設定に誤りがないか必ず確認をしてください。
■Webhook
Webhookの設定
Webhookとは
スマレジ・デベロッパーズのWebhookでは、スマレジ側で発生した内容を開発アプリへ自動的に通知するか設定します。スマレジの機能ごとに通知／非通知を設定することが可能です。
※価格を無料で設定している場合は、Webhookを利用することができません
-
スマレジ・デベロッパーズの『アプリ ＞ Webhook』を開きます。
『Webhookの利用』を『利用する』に切り替えます。
-
カスタムヘッダーの設定をする場合は、『＋カスタムヘッダーを追加』をクリックします。
ヘッダーキーとヘッダー値を登録してください。
-
『送信するイベント』の中から、開発アプリに情報を自動で連携させたい項目を選択しONに切り替えます。
設定が完了したら『保存』をクリックして完了です。
仕様書の確認方法
スマレジ・デベロッパーズを利用するためには、スマレジ・プラットフォームAPIの仕様書に従ってアプリを開発していただく必要があります。各種仕様書は、スマレジ・デベロッパーズの『ドキュメント ＞ 仕様書』を開くことで表示されます。
必要なサービスの仕様書をクリックしてください。