アプリ開発者向け資料 ·...

31
アプリ開発者向け資料 20191028日現在 1

Upload: others

Post on 16-Oct-2020

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリ開発者向け資料

2019年10月28日現在 1

Page 2: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

目次

2

● アプリストアについて

● アプリ開発フローについて

● アプリの課金について

● アプリの利用フローについて

● アプリの「無料お試し」について

● アプリ審査・公開について

● アプリ売上について

● よくある質問

● 参考リンク

● お問い合わせ先

Page 3: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリストアについて

3

Page 4: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

カラーミーショップ アプリストアとは

カラーミーショップAPIを使って開発されたアプリケーションが

並ぶオンラインストアです。

アプリストアは、外部デベロッパーが開発した機能(アプリ)を、ショップオーナー

がショップの成長に応じて必要なタイミングで追加することができるプラット

フォームです。

アプリの総インストール数(5月時点):5,629件

毎月の平均インストール数:433件

【アプリストアを利用するメリット】

● 全国4万店以上のショップにアプリをアプローチできる

● アプリ利用料金の回収はアプリストアに任せてコストが削減できる

● カラーミーショップAPI等を利用して機能開発ができる

4

Page 5: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

連携仕様の概要

カラーミーショップ

API

デベロッパー

Webアプリケーション

ショップ

アプリの利用開始1

処理指示2

アクセストークン取得(OAuth2)

3

タグ配信URLの登録4

課金設定の登録5

タグの配信6

カラーミーショップと連携する

Webアプリケーションの開発をお願い

いたします。

5

Page 6: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリ開発フローについて

6

Page 7: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

事前準備

1. デベロッパー登録をする

カラーミーショップAPI及びOAuthアプリ登録を行うためにデベロッパー登録を行ってください。

https://api.shop-pro.jp/developers/sign_up

2. テストショップ用のアカウントを取得する

アプリのテストなどを行うためのテストショップ用のアカウントを取得してください。

デベロッパーページ上から行えます。

https://developer.shop-pro.jp/my/

以上で準備完了です。

7

Page 8: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

大まかな開発フロー

1. アプリを開発するカラーミーショップ Developers にログインし、プライベートアプリを作成します。

アプリを作成すると、アプリのクライアントID 及び クライアントシークレット を取得できるようになります。

画面左サイドメニューから「アプリストアモードに切り替える」を選択し、アプリの状態を「アプリストア アプリ」に切り替えてください。

任意のスクリプトを設置したいアプリに対して スクリプトタグAPI をご用意しています。

2. アプリ課金設定を登録する アプリの料金プランを設定するための登録します。

詳細はこちら

3. アプリストア公開申請をする アプリストアに公開するアプリはカラーミーショップによる審査が必要です。

アプリストア公開情報を作成し、アプリストア公開申請を行ってください。

詳細はこちら

4. アプリストアにアプリを公開する 審査が通過したアプリはアプリストアに公開※できます。※アプリストアへの公開はカラーミーショップで行います。

8

Page 9: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリの課金について

9

Page 10: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリの課金について

アプリストアのアプリ利用料金は、カラーミーショップがショップオーナーから徴収します。

アプリの課金方法は2種類あります。

● 課金方法① 料金プラン(必須)

ショップオーナーがアプリを追加する際には必ず料金プランを1つ選択する仕組みになっています。

どのような料金プランを作成できるかは次ページ以降に説明します。

● 課金方法② その他アプリ内課金

アプリを利用中のショップオーナーに対して、料金プランとは別の有料オプション等を提供する場合に

スポットで課金をすることができます。

料金は0円、もしくは100〜100万円で設定することができます。

10

Page 11: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

料金プランの課金形式

料金プランの課金形式は6種類の中から選択できます。

課金形式に応じて、課金タイミング(前払い or 後払い)が決まっています。

具体的な課金タイミングについては 利用料金マニュアル をご確認ください。

11

課金形式 課金タイミング 補足

無料 -

買い切り 前払い

月額固定費のみ 前払い

月額固定費+初期費用 前払い

月額固定費+従量による課金 後払い 課金APIをご利用ください

従量による課金のみ 後払い 課金APIをご利用ください

従量による課金の場合は 課金API を利用して従量に応じたアプリ利用料を通知してください。

Page 12: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

料金プランの設定方法

12

1. プラン課金を登録する カラーミーショップ Developers にログインし、アプリの編集ページの左メニュー「課金設定」から料金プランの追加をします。

2. 料金プラン情報を設定する 登録したプラン課金に対して料金形態、金額、無料お試しの有無を設定をします。

3. 従量による課金を行う場合は課金APIを利用する 従量に応じてアプリ利用料が発生する場合は 課金API を利用してください。

Page 13: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

料金プランの表示イメージ

13

設定した料金プランは、アプリストアのアプリ詳細ページに表示されます。

課金形式毎に表示が異なります。

無料 買い切り 月額固定費のみ

月額固定費+初期費用 月額固定費+従量による課金 従量による課金のみ

Page 14: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

その他アプリ内課金の設定方法

14

その他アプリ内課金を利用する有料オプション等は、料金プランのようにアプリストア上で選択するのでは

なく、各アプリ側にて選択できるようにしてください。

(料金の徴収はカラーミーショップが行います)

1. 課金マスタを登録する カラーミーショップ Developers にログインし、アプリの編集ページの左メニュー「課金設定」からアプリ内課金の設定をします

2. その他アプリ内課金を行う場合は課金APIを利用する その他アプリ内課金を行う場合は 課金API を利用し、発生したアプリ利用料をカラーミーショップへ通知してください。

3. その他アプリ内課金を利用する有料オプション等はアプリ側で選択できるようにする

Page 15: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

その他アプリ内課金がある場合の表示イメージ

15

その他アプリ内課金の説明は、アプリ詳細ページの料金プランの下にある枠内に記述できます。

Page 16: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリの利用フローについて

16

Page 17: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリの追加(インストール)フロー

ショップオーナーがアプリを追加するフローについて説明します。

アプリが追加された際の処理は インストールフック にて行います。詳しくはAPIドキュメントをご確認ください。

17

Page 18: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリの削除(アンインストール)フロー

ショップオーナーがアプリを削除するフローについて説明します。

アプリが削除された際の処理は アンインストールフック にて行います。詳しくはAPIドキュメントをご確認ください。

18

Page 19: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリの「無料お試し」について

19

Page 20: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリの「無料お試し」について

アプリストアのアプリには「無料お試し(トライアル期間)」を設定することができます。

「無料お試し」を設定することで、ショップオーナーはアプリを実際に利用してから契約することができます。

また、アプリ側に利用不可商品等がある場合は、無料お試し期間中に確認することができ、キャンセル処

理もスムーズに行うことができます。

20

「無料お試し」を設定していると、アプリ詳細ページで上図のように表示されます。

Page 21: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

「無料お試し」を設定する方法

「無料お試し」を設定する方法

● カラーミーショップ Developersにログインし、アプリの編集ページの左メニュー「課金設定」から無料お試し期間を設定し

ます。設定後、すぐに無料期間が反映されます。

「無料お試し」設定時の注意点

● 無料お試しはアプリに対して設定できます。

○ 料金プランの課金形式が買い切り、無料の場合は「無料お試し」は利用できません。

● 期間は3日以上から90日までの間で設定してください。

● ショップオーナーが「無料お試し」を利用できるのは、1アプリにつき1度のみです。

○ 「無料お試し」利用後にアプリを再追加した場合は通常料金が発生します。

● 「無料お試し」期間が終了する3日前に、ショップオーナーにリマインドメールを送信します。

21

Page 22: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリ審査・公開について

22

Page 23: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリ審査フロー

アプリストアに公開するアプリは、カラーミーショップにて審査を行います。

1. アプリストア公開申請を行う アプリの編集ページ「アプリストア公開情報変更・申請」より公開申請を行ってください。

・アプリストア掲載情報設定(アプリアイコン、アプリの説明、利用イメージ画像、規約のURL等が必要になります)

 表示イメージは アプリ審査・公開について を参考にしてください。

・開発元情報(会社情報、担当者名、お振込み用の講座情報が必要になります)

・料金プランの設定(設定する料金プラン、プランの説明などを記載してください)

 表示イメージは アプリ課金 を参考にしてください。

・利用規約に同意いただき、申請いただきます

2. カラーミーショップがアプリ審査を行う この審査では、アプリストア公開情報の内容、アプリの追加・削除などの確認を行います。

アプリの審査は通常2〜3営業日程度で完了し、結果を審査状況・申請一覧に掲載し公認デベロッパー申請時に登録いただいたメールアドレス宛に

ご連絡いたします。

審査NGの場合は、NG理由をご連絡しますので修正いただき再申請を行ってください。

3. 審査が完了後、アプリストアに公開する 審査が通過したアプリはアプリストアに公開※できます。※アプリストアへの公開はカラーミーショップで行いますが、今後はデベロッパー様にて公開・非公開設定が行える予定です。

23

Page 24: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリ売上について

24

Page 25: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

アプリ売上について

アプリストア利用手数料、アプリ売上振込に関するルールは以下のとおりです。

25

利用手数料 最低振込金額 振込タイミング

有料アプリ1課金につき手数料が発生し

ます。詳細はお問い合わせく

ださい。

利用手数料を引いた売上が

3,000円以上の場合※3,000円未満の場合は翌月に繰越

毎月末に口座振込※振込手数料(一律税込264円)は

 ご負担ください。

無料アプリ 都度相談 - -

※消費税の増税に伴い2019年10月1日より、振込手数料は一律 259円→264円に変更になりました。

Page 26: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

よくある質問

26

Page 27: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

よくある質問● Q. 料金プランの変更はできますか?

A. 現在はプラン変更を行うことはできませんが、今後機能を実装する予定です。

● Q. アプリ利用中のショップがカラーミーショップを退会した場合はどうなりますか?

A. アプリを利用中、また未払いのアプリ利用料がある場合はカラーミーショップを退会できません。

● Q. アプリ利用料をショップが支払わなかった場合はどうなりますか?

A.アプリ利用料は毎月自動で引き落としされるので、支払われないことはありません。

 無料期間終了後に残高不足でアプリ利用料が不足していた場合は、アプリを強制削除します。

 アプリが強制削除されたかどうかはアンインストールフックにて判別できるようになる予定です。

● Q. アプリを検証できる環境はありますか?

A. アプリの検証には無料で利用できるテストショップとカラーミーショップ Developerをご利用ください。

● Q. アプリを作成するにあたり、最低限必要な開発はなんですか?

A. アプリがインストール・アンインストールされた時にそれぞれに関する情報を POSTメソッド、 application/json 形式で通知

します。 そのためフックの受け取り先をご用意いただく必要がございます。27

Page 28: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

参考リンク

28

Page 29: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

参考リンク

● アプリストアhttps://app.shop-pro.jp/

● 公認デベロッパー登録

https://developer.shop-pro.jp/sign_up● カラーミーショップ APIドキュメント

https://shop-pro.jp/?mode=api_started

● アプリストア APIドキュメント https://app.shop-pro.jp/open_api  

● カラーミーショップ ショップ独自タグ一覧

https://shop-pro.jp/manual/menu_06_02_01

● カラーミーショップ ロゴマーク仕様規定 https://shop-pro.jp/news/logo/

29

Page 30: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

お問い合わせ先

30

Page 31: アプリ開発者向け資料 · カラーミーショップapiを使って開発されたアプリケーションが ... 詳しくはapiドキュメントをご確認ください。

お問い合わせ先

31

デベロッパー様からのアプリストアについてのお問い合わせは下記フォームよりお願いいたします。

カラーミーショップ お問い合わせフォーム

※プルダウンから「アプリストア デベロッパー窓口」を選択してお問い合わせいただくとスムーズです。