スコープ・Webhookについて – スマレジ・ヘルプ

開発したアプリをスマレジと連携させるためには、スコープ（連携の影響範囲）とWebhookの設定が必要です。
スコープとWebhookを適性に設定することで、スマレジと開発アプリを想定通りに連携させることができます。

■スコープ

■Webhook

■スコープ

スマレジ・デベロッパーズのスコープでは、開発したアプリがスマレジのサービスのどの機能に影響するかを設定します。
アプリと連携させたい機能を選択して影響範囲を設定してください。

スマレジ・デベロッパーズの『アプリ＞スコープ』を開きます。
設定したいスマレジのサービスを選択して、開発アプリと連携させる機能をONに切り替えます。
設定が完了したら『保存』をクリックして完了です。

一般的に、すでに利用者がいるアプリのスコープを変更する場合、再度利用者の同意が必要となります。

スマレジではアプリレベルの制御の他に、契約レベルでの制御を実装しておりますので、契約（利用者）の承認が必要です。
ですので、変更したスコープがその利用者で有効になるタイミングは、利用者がスコープの変更を承認した後からとなります。

スコープの変更はアプリ公開時にメールにて契約の管理者に通知され、スマレジのマイページで承認することができます。
利用者がメール通知に気づかない可能性もありますので、スコープの変更の際は作成したアプリなどでも通知することを推奨します。

※ プライベートアプリは自分自身がアプリの利用者なので、スコープの変更が審査無く即時に反映されます。上記の対象ではありません。

スマレジ・デベロッパーズのWebhookでは、スマレジ側で発生した内容を開発アプリへ自動的に通知するか設定します。
スマレジの機能ごとに通知／非通知を設定することが可能です。

※価格を無料で設定している場合は、Webhookを利用することができません

スマレジ・デベロッパーズを利用するためには、スマレジ・プラットフォームAPIの仕様書に従ってアプリを開発していただく必要があります。

各種仕様書は、スマレジ・デベロッパーズの『ドキュメント＞仕様書』を開くことで表示されます。
必要なサービスの仕様書をクリックしてください。