要件・仕様

その他必須要件

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

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

インストール

インストールとは

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

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

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

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

アンインストール

アンインストールとは

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

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

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

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

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

無料プラン

• ・0円プラン(1つのプラン)のみ設置可能
• ・後からサブスクリプションプランへの変更不可
  ※サブスクリプションプランを作成する場合、別途新規でアプリ開発申請が必要となります

サブスクリプションプラン

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

トライアルについて

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

初期費用について

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

料金の計算方法

※日割りの計算方法

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

アプリの状態(2024.06.04追加)

アプリの状態を確認するためには、サブスクリプション決済ステータスとサブスクリプションステータスを組み合わせてご判断ください。

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

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

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

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

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

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

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

利用終了後のプラン変更

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

再決済(2024.06.04追加)

再決済の対象、再決済可能な期間

再決済の対象
・アプリの状態が「再決済中」状態のもの
・自由決済APIで決済失敗したもの(2024.06.28追加)

再決済が実行されるタイミング
・ショップオーナーが以下画面にて、対象アプリに表示された再決済ボタンより手続き後
ショップ管理画面）アプリ管理 > アプリ一覧 > 利用中のアプリ

再決済可能な期間
・決済失敗の当日を1日目として14日間は再決済が可能（例:12/1に失敗の場合、12/15以降は不可）
※再決済期限の超過後、再決済を希望する場合はサポート対応が必要

再決済中の制限

• ・再決済中（決済失敗）となった場合、サブスクリプションは自動キャンセル
• ・再決済が完了するまで対象アプリのプラン変更・アンインストール不可
  ※決済失敗していない他のアプリは制限されません
• ・再決済完了時にサブスクリプションが自動で再登録
• ・再決済期限切れ後に再決済する場合はサポート対応が必要
• ・再決済期限切れ後はAPIは利用不可となる

再決済のメール・Webhook

再決済誘導メール
・ショップオーナーに、自動更新の決済失敗時に再決済へ誘導するメールを通知

再決済成功メール
・ショップオーナーに、決済完了メールの送信

再決済期限のリマインドメール
・ショップオーナーに、再決済期限の「7日前」「1日前」「当日」にメール通知

再決済のWebhook
・再決済期限が超過した際にリクエスト
※詳細はWebhookをご確認ください。

自由決済API（アプリ内課金）(2024.06.28追加)

• ・自由決済APIを用いて、従量課金や初期費用、オプション費用等のアプリの様々な費用形態に合わせて決済可能
• ・無料プラン/サブスクプランに自由決済APIを組み合わせて使用

決済予約

• ・「決済予約登録」で決済日を指定し、 「決済予約明細登録」で金額や決済名目を登録してください。
  ※登録した決済名目は、 管理画面）アプリ決済情報の「内訳」に表示されます。
• ・決済タイミングは指定した決済日の0:10となります。
• ・決済予約の日付指定は最大1年後まで可能です。
  例）2024/6/1にリクエストする場合、2025/6/1まで指定可能。

決済失敗時

• 再決済の対象となります。
  ※ショップ契約満了日/アンインストール日を超えた際の決済失敗は再決済の対象にはなりません。

決済対象の申し込み/キャンセル

• ・自由決済APIの決済対象とするプラン、オプション費用等の申込/キャンセルの受付や動線はアプリ側でご用意ください。
• ・キャンセル受付後、対象が未決済であれば決済予約削除をしてください。
• ・決済後の返金/予約削除は不可となります。

決済対象の日付/金額等の変更

• ・日付変更は、未決済であれば決済予約更新で可能です。
• ・決済名目/金額変更は、未決済であれば決済予約明細更新で可能です。

ショップ契約終了後/アンインストール後の決済予約

• ・ショップ契約満了日/アンインストール日から翌月末以内であれば決済予約は実行されます。
  ※上記ケースで決済失敗となった場合、ショップ様の状況によっては料金が未収となることがあります。
  利用規約に支払い等に関する事項を含めていただくようお願いいたします。

アプリ/プランの制約

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

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

SSOについて

makeshopをIdPとして、makeshop管理画面のユーザ認証（ログイン）を行うことでアプリ（サービス）のユーザー認証も行うための仕組みです。

事前準備

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" 
}

ユースケース

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

memberSSO(会員シングルサインオン)

memberSSOについて

makeshopをIdPとして、ショップ会員のユーザ認証（ログイン）を行うことで外部サイトのユーザー認証も行うための仕組みです。

• ①外部サイトのログインボタンをクリック
• ②makeshopのログイン画面でログイン（ログイン済みの場合はスキップ）
• ③外部サイトに戻る（Makeshopも外部サイトもログイン状態）

事前準備

シーケンス図

makeshopに未ログインのケース

makeshopにログイン済みのケース

1. ユーザー認証API

ユーザーがログインID、クライアントが認可コードを取得するAPIです。

https://member-auth.makeshop.jp/sso/login

2. トークン取得API

アクセストークンおよびIDトークンを取得するためのAPIです。

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

  [レスポンス例]
  {
    "error": "invalid_grant",
    "error_description": "The provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client."
  }
  

3. 会員ID取得API

ユーザの会員IDを取得するためのAPIです。

https://member-auth.makeshop.jp/userinfo

[レスポンス例]
{
  "error": "request_unauthorized",
  "error_description": "The request could not be authorized. Check that you provided valid credentials in the right format."
}

ログアウト連携API

外部サイトとmakeshop間でログアウト連携するためのAPIです。

外部サイトログアウトのケース

makeshopログアウトのケース

  https://member-auth.makeshop.jp/sso/logout