要件・仕様

その他必須要件

アプリ内データのショップオーナーへの提供

アプリ利用の中で生成 または連携されたデータのうち、ショップオーナーに所有権があるデータはご要望があった場合には提供のご対応をお願いいたします。
提供形態は自由ですが、ダウンロード機能の設定や運用におけるデータ提供等のご対応をご準備いただきますようお願いいたします。

インストール

インストールとは

ショップ管理画面にて、アプリを追加する処理が「インストール」となります。

インストールによって行われる処理

ショップオーナーによってアプリがインストールされた際、以下の処理が行われます。

• ・インストールフックURLの呼び出し

アンインストール

アンインストールとは

ショップ管理画面にて、アプリを削除する処理が「アンインストール」となります。

アンインストールによって行われる処理

ショップオーナーによってアプリがアンインストールされた際、以下の処理が行われます。

• ・アンインストールフックURLの呼び出し

提供可能なアプリパターン

無料プラン

• ・1プラン（0円プラン）のみ設置可能
• ・後から有料プランへの変更不可
• ・同一アプリ内に有料プランとの併設不可
  ※有料プランを作成する場合、別途アプリの新規登録（アプリ開発申請）が必要となります

有料プラン（サブスクリプション）

• ・0円の設定不可
• ・月額利用料を設定し、料金を支払うことで利用可能
• ・決済時のクレカ登録が必須(翌月以降自動更新を行うため)

トライアルについて

• ・トライアル期間中はプラン変更不可
• ・トライアル期間終了日の翌日に自動決済
• ・自動決済を回避したい場合はトライアル期間中であれば、キャンセルを行うことが可能
• ・キャンセル後もトライアル期間が残っている場合は期間終了日までは無料で利用可能

初期費用について

• ・初期費用の請求タイミングは、初回決済時のみ
• ・複数プランがある場合、プラン別に初期費用を設置可能

料金の計算方法

※日割りの計算方法

• ・プラン価格(税抜)×残日数÷30日(少数切り上げ)
• ・消費税計算では少数切り捨て
• ・日割り+消費税を合計金額とする
  例: 10月10日に1,000円のプランでインストールする場合
  [プラン料金] 1,000円 × 22日(10月残日数) ÷ 30日 = 734円(733.33..円の切り上げ)
  [消費税] 734円 × 10% = 73円(73.4円の切り捨て)
  [合計] 734円(プラン料金) + 73円(消費税) = 807円

サブスクリプションステータス

キャンセル後の自動更新、返金、アンインストール

• ・翌月以降の自動更新が停止
• ・当月の残期間の返金は不可
• ・キャンセル後もアプリ自体は残るため、アンインストールはショップオーナー自身で行う必要がある
  ※インストール状態のままであっても自動更新はされません

キャンセル後のプラン変更

• ・複数プランある場合は、別プランへのプラン変更は可能
• ・同プランで利用再開したい場合は、アンインストール後に再インストールが必要

利用終了後のアンインストール

• ・利用終了後もアプリ自体は残るため、アンインストールはショップオーナー自身で行う必要がある
  ※インストール状態のままであっても自動更新はされません

利用終了後のプラン変更

• ・アンインストール後に再インストールが必要

アンインストール後に再インストールした場合のデータ使用の制御

• アプリをアンインストール後、同ショップIDから再インストールがあった場合、ショップIDにて一意に識別し過去のデータを紐づけることによって、以前のデータを使用可能とするかはアプリ側でご判断ください。

決済失敗への状態移行の対象

• ・トライアルから自動更新移行時の決済に失敗した場合
• ・毎月1日のサブスクリプション自動更新時の決済に失敗した場合

アプリ/プランの制約

• ・無料プラン/サブスクリプションプランの混在は不可
• ・一度設定したプラン形態の変更は不可
• ・一度設定したプランの価格変更は不可

SSO(シングルサインオン)

SSOについて

makeshopのユーザ認証（ログイン）を行うことでアプリケーションのユーザー認証も行うための仕組みです。
また、makeshop apps APIを利用するための一時トークンを払い出すための仕組みとしても提供されます。

事前準備

redirect_uriの登録申請

「アプリ開発申請」及び「アプリ公開申請」にてredirect_uriの登録申請をお願いします。

SSO実行時に必要な情報

https://console.makeshop.jp/apps/sso

  https://app-auth.makeshop.jp/oauth2/token

https://app-auth.makeshop.jp/oauth2/token

シーケンス図

1. 一時トークンの有無を判定

アプリケーション起動で一時トークンが発行されているか判定し、発行されていればその一時トークンを利用できます。
一時トークンが発行されていない場合、SSOログインへリダイレクトをします。
一時トークンの有効期限を超えている場合、トークンリフレッシュを実行してください。

※APIリクエスト方法は、以下でご確認ください。
https://developers.makeshop.jp/api/graphql/index.html#introduction-item-1

2. SSOログインへリダイレクト

パラメータを付与してSSOログインへリダイレクトします。

https://console.makeshop.jp/apps/sso

code

S256

3. 認可コードの受け取り

redirect_uriに認可コード等のクエリパラメータが付与された状態でリクエストされます。

4. 一時トークン発行

認可コードを利用し、一時トークンを取得します。
以降、APIへアクセスする際に一時トークンを利用します。
一時トークンの有効期限を超えた場合、「5. トークンリフレッシュ」をご参照ください。

https://app-auth.makeshop.jp/oauth2/token

Basic クライアントID:クライアントシークレット

application/x-www-form-urlencoded

authorization_code

bearer

[レスポンス例]
{
  "error": "internal server error",
  "error_description": "The server encountered an error and could not complete your request" 
}

5. トークンリフレッシュ

一時トークンの有効期限が切れた際に、リフレッシュトークンを利用して新たな一時トークンの要求をします。

https://app-auth.makeshop.jp/oauth2/token

Basic クライアントID:クライアントシークレット

application/x-www-form-urlencoded

refresh_token

bearer

[レスポンス例]
{
    "error": "internal server error",
    "error_description": "The server encountered an error and could not complete your request" 
}

ユースケース

アプリを起動したショップが新規ショップか、既存ショップかを判別し、ユーザに合わせた画面を表示するユースケース