開発したアプリをスマレジと連携させるためには、スコープ（連携の影響範囲）とWebhookの設定が必要です。
スコープとWebhookを適性に設定することで、スマレジと開発アプリを想定通りに連携させることができます。
スコープとWebhookを適性に設定することで、スマレジと開発アプリを想定通りに連携させることができます。
スコープの設定
スマレジ・デベロッパーズのスコープでは、開発したアプリがスマレジのどの機能に影響するかを設定します。
アプリと連携させたい機能を選択して影響範囲を設定してください。
アプリと連携させたい機能を選択して影響範囲を設定してください。
※本文中の画像はクリックすると大きなサイズで表示されます
-
アプリの設定画面を開きます
スマレジ・デベロッパーズトップから、『アプリ ＞ パブリックアプリ（プライベートアプリ）』をクリックします。
設定を行なうアプリ欄の『概要を見る（利用状況を見る）』をクリックします。
-
スコープの設定を行ないます
タブから『スコープ』をクリックします。
設定を行なう、連携先のサービス名をクリックします。
アプリと連携させる機能を選択します。
設定完了後、【保存】をクリックします
利用者が存在するアプリのスコープを変更する
一般的に、すでに利用者がいるアプリのスコープを変更する場合、再度利用者の同意が必要となります。
スマレジではアプリレベルの制御の他に、契約レベルでの制御を実装しておりますので、契約（利用者）の承認が必要です。
なので、変更したスコープがその利用者で有効になるタイミングは、利用者がスコープの変更を承認した後からとなります。
スコープの変更はアプリ公開時にメールにて契約の管理者に通知され、スマレジのマイページで承認することができます。
利用者がメール通知に気づかない可能性もありますので、スコープの変更の際は作成したアプリなどでも通知することを推奨します。
※プライベートアプリは自分自身がアプリの利用者なので、スコープの変更が審査無く即時に反映されます
Webhookの設定
Webhookの設定で、スマレジ側で発生したイベントを開発アプリへ自動的に通知するか設定します。
スマレジの機能ごとに通知／非通知を設定することが可能です。
スマレジの機能ごとに通知／非通知を設定することが可能です。
※本文中の画像はクリックすると大きなサイズで表示されます
-
アプリの設定画面を開きます
スマレジ・デベロッパーズトップから、『アプリ ＞ パブリックアプリ（プライベートアプリ）』をクリックします。
設定を行なうアプリ欄の『概要を見る（利用状況を見る）』をクリックします。
-
Webhookの設定を行ないます
タブから『Webhook』をクリックします。
『基本設定』、『カスタムヘッダー』を設定し、連携先のサービス名を選択します。
アプリと連携させる機能を選択します。
【保存】をクリックします
仕様書の確認方法
スマレジ・デベロッパーズを利用するためには、スマレジ・プラットフォームAPIの仕様書に従ってアプリを開発していただく必要があります。
各種仕様書は、スマレジ・デベロッパーズの『ドキュメント ＞ 仕様書』を開くことで表示されます。
必要なサービスの仕様書をクリックしてください。