# アプリの最低技術要件
# インストール・アンインストールフックの受け取り
アプリがインストールされた際、インストールに関する情報を下記の形式で通知します。
- POSTメソッド
- application/json
そのためインストールフックの受け取り先をご用意いただく必要がございます。
アンインストールに関する情報も同様の形式で通知するため、アンインストールフックの受け取り先のご用意をお願いします。
またリクエストがカラーミーショップから送信されたことを確認いただくためフックの署名検証についてもご対応ください。
# アプリ開発における成功フロー
アプリストアからアプリが利用される際の成功フローについて、以下の図をご確認ください。
# インストール時
アプリがインストールされた際、インストールに関する情報を POSTメソッド、application/json形式で通知されますので、インストールフックの受け取り先をご用意いただく必要がございます。詳細は アプリのインストール (opens new window) をご確認ください。
# アンインストール時
また、アンインストール時もアンインストールに関する情報を通知するので、同様に受け取り先のご用意をお願いします。
リクエストがカラーミーショップから送信されたことを確認するフックの署名検証についてもご対応ください。詳細は アプリのアンインストール (opens new window) をご確認ください。
# インストール成功時
インストール成功後、インストールが成功した旨を通知する画面を表示してください。その後、アカウントの発行やサービスへの申し込みが別途ある場合は当該のページに誘導してください。
# カラーミーショップAPIやアプリストアAPIを利用する場合
インストール後、認可画面を表示してショップオーナーが認可できるよう設定してください。認可させるタイミングはアプリによって異なります。
インストール成功画面に認可画面への導線を設定する、サービス登録自社サービスの管理ページから認可させるなど適切な処理を行ってください。詳細は カラーミーショップAPI - 利用手順 (opens new window) をご確認ください。
API取得後にアカウントの発行やサービスへの申し込みを行う場合はリダイレクトURIに当該のページを設定してください。
# アプリ利用中のフロー
ショップオーナーが利用中のアプリを確認する時は利用中のアプリ一覧* (opens new window)から確認します。 *要ログイン
利用中のアプリ一覧ページから、アプリの管理ページやサービスページに遷移します。上記のページはデベロッパー画面のアプリ設定ページ等URL (opens new window)からご登録いただきます。
こちらのページではショップオーナーが認可をキャンセルしてしまった場合にも再度認可できるように、認可画面を設定してください。
# 認証・認可がキャンセルされるフロー
インストール後、認可画面でショップオーナーが離脱または認可をキャンセルした場合、アプリはショップオーナーにインストールされている状態ですが、デベロッパーでAPIをご利用いただくことができません。
認可がキャンセルされた場合、キャンセルされた旨を伝える画面でサービスが正しく機能しなくなる可能性や、再度認可するためのフローを記載してください。
# アプリ設定ページ等URLの設定
ショップオーナーがアプリの設定等を行う際に使用するページのURLを指します。 こちらは、アプリストア公開申請時に設定いただく アプリ設定ページ等URL にて設定ください。
アプリをインストールしたショップオーナーは、アプリ設定ページ等URLに設定されたURLを利用中のアプリ一覧 (opens new window)にて確認できます。
※ 利用中のアプリ一覧に表示される「設定」にアプリ設定ページ等URLのリンクが付与されます
# APIの利用
カラーミーショップAPIおよびアプリストアAPIを利用される場合は、OAuthの認可フローに則って認可を取得してください。
認可の取得は任意のタイミングで行うことが可能です。
# アプリからのログアウト
ショップオーナーの操作で、アプリからログアウトできる必要があります。
ログアウトの目的
事業者および個人が複数のショップ（アカウント）を運用しているケースがあり、意図しないアカウントでアプリの操作が行われることを防ぐ目的です。
# ログインしているアカウントをショップオーナーが特定できること
サービスの管理画面やアプリ設定ページ等で、ログインしているアカウントのショップ名やアカウントIDを確認できるようにしてください。
※ ログアウトの実装目的と同様、意図しないアカウントでアプリの操作が行われることを防ぐ目的です。
# ガイドライン
アプリストア公開申請の審査に関する詳細は 公開申請ガイドライン に記載しております。
← アンインストール スクリプトタグAPI →