アプリを Stripe App Marketplace に公開する
Stripe App Marketplace に公開し、ユーザーがアプリを見つけられるようにします。
チーム外のユーザーとアプリを共有するには、アプリを Stripe App Marketplace に公開します。公開すると、自分のアカウントだけでなく、あらゆる Stripe アカウントでアプリをインストールできるようになります。
公開する際には、いくつかの制限があります。
- アカウントを申請する必要があります。
- 公開できるアプリはアカウント当たり 1 つのみです。
- 現在、Stripe Marketplaceでアプリを公開している場合、プラットフォームアカウントになることはできません。
- 現時点で Stripe は、英語での掲載のみに対応できます。追加の言語への対応については、Stripe までお問い合わせください。
- 公開するアプリは、審査プロセスに合格する必要があります。詳細については、アプリの審査要件およびアプリリストのガイドラインをご覧ください。
- 後から Stripe App Marketplace でアプリを削除する必要がある場合、削除について Stripe に問い合わせる必要があります。
上記の制約は、Stripe App Marketplace で一般のユーザーと共有するアプリにのみ適用されます。アプリをご自身のチームメンバーにのみ提供する場合は、代わりにアプリをアップロードしてインストールするをご覧ください。
はじめに
- すでに本番環境でアプリをインストールしている場合は、それをアンインストールしてから、アプリの公開に切り替える必要があります。
- アプリに関連付ける Stripe アカウントを選択します。アカウントごとにアプリを 1 つのみ公開できます。
- アプリの掲載が承認されるまでのプロセスについては、アプリの審査要件をご覧ください。
配布タイプを更新する
- アプリを一般公開に設定します。
stripe apps set distribution public
このコマンドは distribution_ フィールドに public の値を設定して、マニフェストファイルを更新します。
{ "id": "com.example.app", "version": "1.2.3", "name": "Example App", "icon": "./example_icon_32.png", "distribution_type": "public" }
権限を追加する
アプリの必要な権限を追加するには、以下のようにします。
- アプリが Stripe API で呼び出すオブジェクトを決定します。拡張機能をアプリに移行する場合は、Stripe API で拡張機能 (アプリではなく) がどのオブジェクトを呼び出すかを判断し、含める権限を確認する必要があります。
- アプリマニフェストに追加できる権限のリストを確認します。
- 以下のコマンドを使用すると、
stripe-app.アプリマニフェストファイルのjson permissions配列に権限を追加できます。
stripe apps grant permission "PERMISSION_NAME" "EXPLANATION"
プロンプトに権限の情報を入力します。
PERMISSION_: 追加する権限の名前。使用可能な権限の名前をご覧ください。NAME EXPLANATION: アクセス有効化についての説明。この説明はアプリのインストール時にユーザーに表示されます。
アプリケーションに追加する新たな権限ごとに、このステップを繰り返します。
アプリのマニフェストファイルは以下のようになります。
権限の削除には、CLI を使用することもできます。
stripe apps revoke permission "PERMISSION_NAME"
テスト環境にアップロードする
アプリをアップロードするには、プロジェクトのルートディレクトリーで以下のコマンドを実行します。
stripe apps upload
Stripe はアプリマニフェストを検証した後、テスト用 Stripe アカウントにアプリをアップロードし、インストールを実行します。アプリマニフェストを設定して、サンドボックス環境へのインストールを有効にすることもできます。
このステップ後には、以下が可能になります。
- すべてのチームメンバーが、https://dashboard.stripe.com/test/ のテスト環境でお客様のアプリにアクセスできます。
- アプリは、テスト環境でシークレットを保存できます。
- アプリの署名シークレットにアクセスして、バックエンドに接続できます。
アプリを送信して審査を受ける
配布タイプを設定してから、新しいバージョンのアプリをアップロードします。
配布方法を決定すると、今後のすべてのアプリのバージョンに自動的にその配布方法が適用されます。すべての Stripe ユーザーにアプリを公開した後でその配布方法を変更する場合は、Stripe サポートにお問い合わせください。
Stripe ダッシュボードでアプリに移動し、アプリを選択して詳細ページを確認します。
アプリに複数のバージョンがある場合は、公開するアプリのバージョンを選択して、続行をクリックします。バージョンを選択できない場合は、最初に本番環境の利用を申請します。
リスト掲載内容を編集をクリックして、概要、機能、価格、サポート、ユーザーがアプリを評価するためのリソースリンクを入力し、アプリリストを作成します。リストの入力が完了すると、ダッシュボードの右側にプレビューが表示されます。
アプリが承認される確率を上げ、魅力的なリストを作成するためのヒントについては、アプリリストのガイドラインをご覧ください。
続行をクリックして、最終的なアプリの送信前に以下の情報を指定します。
- バージョン: アプリに複数のバージョンがある場合は、審査を受けるために送信するバージョンを選択して検証します。
- マーケットプレイスのインストール URL: このオプションは OAUTH アプリには必須であり、任意でインストールリンクに対応するアプリに利用できます。ユーザーは Stripe App Marketplace からこの URL にリダイレクトされ、アプリをインストールできます。
注
URL のリンク先のページには、アカウント登録とインストールプロセスを開始するための、明確な手順を示す必要があります。
- テスト用認証情報: サインインが必要なアプリの場合、少なくとも 1 つのテストアカウントを用意して、Stripe がアプリをテストし、審査できるようにします。サンプルのテスト用認証情報をご覧ください。
注意
Stripe は実在の (テスト用ではない) アカウントをアプリの審査プロセスに使用することを許可していません。
- テストのガイダンス: ユーザーシナリオを提供すると、意図したとおりにユーザーがインストールして使用できるか、Stripe でシミュレーションできます。アプリ審査の合格率を上げるには、サンプルテストのガイダンスをご覧ください。
- 連絡用のメールアドレス: アプリ審査に関する通知を受信するメールアドレスと、セキュリティインシデントを解決するための連絡先のメールアドレスを提供します。
審査プロセスを開始してから変更を行うと、審査期間がそれに応じて長くなります。遅延を避けるため、最終的にアプリを送信する際に、すべての情報が正確であり、アプリの審査要件に従っていることを確認してください。
審査プロセスを開始するには、送信して審査を受けるをクリックします。
Stripe がアプリを審査して承認したら、アプリを Stripe App Marketplace に公開できるようになります。変更を加える必要がある場合には、審査中のアプリをキャンセルできます。キャンセルすると、アプリは審査待ちリストから削除されます。
遅延を避けるため、最終的にアプリを送信する際に、すべての情報が正確であり、アプリの審査要件に従っていることを確認してください。アプリが
In Reviewになると、送信を取り消したり変更を加えたりすることはできなくなります。Stripe がアプリを審査して承認したら、Stripe App Marketplace に公開できるようになります。
アプリを公開する
Stripe はアプリが審査要件をすべて満たしていることを確認した後、連絡先のメールアドレスに通知を送信し、アプリの詳細ページに審査結果を追加します。アプリに追加の変更が必要な場合、Stripe は承認に必要とされる変更に関するガイダンスを提供します。変更を実施したら、アプリを再提出して再審査を求めることができます。
Stripe がアプリを承認したら、Stripe ダッシュボードのアプリページにアクセスします。アプリを選択し、確認して公開するをクリックしてリスト掲載内容をプレビューします。
変更する場合には、キャンセルして編集するをクリックします。この場合、再送信してアプリの審査を受ける必要があります。
Stripe App Marketplace でアプリを掲載して公開するには、公開するをクリックします。
このステップ後には、以下が可能になります。
- あらゆるユーザーが、Stripe App Marketplace でアプリを見つけられるようになります。
- あらゆる Stripe アカウントのユーザーが、アプリをインストールして使用できるようになります。
- 公開から 24 時間経つと、すぐにアプリのアナリティクスを確認できます。