拡張機能を Stripe Apps に移行する
拡張機能を Stripe Apps に移行する理由と方法をご紹介します。
拡張機能は Stripe 上に構築されるレガシーアプリで、Stripe ユーザーがパートナーディレクトリーから利用できます。OAuth および API リクエストを使用して、アナリティクスダッシュボードやデータウェアハウスなど、その他のビジネスツールに支払いデータを送信します。
拡張機能に代わる機能として、Stripe Apps が他のツールに Stripe を連携させるための優先手段になります。Stripe はパートナーディレクトリーからユーザーをリダイレクトして、Stripe App Marketplace でアプリを検索できるようにします。
2022 年 5 月 24 日以降は、新しい拡張機能を作成できなくなります。2022 年 8 月 31 日に、Stripe はパートナーディレクトリー上の拡張機能についての記載をすべて削除します。拡張機能を所有している場合は、今すぐ Stripe Apps に移行してユーザーへの表示を維持できるようにしましょう。
移行する理由
Stripe Apps は現在の拡張機能からのアップグレードです。移行することで以下を実現できます。
- Stripe ダッシュボードと Stripe App Marketplace で広範囲に表示することによる見つけやすさの向上
- アプリでアクセスできるデータと API を設定 (およびユーザーが把握) できるようにする、より細かい権限
- 埋め込みの UI コンポーネントを使用した、Stripe ダッシュボードでのインタラクティブな機能 (ユーザーは Stripe のサイト内でアプリを直接操作できます)
- 移行を選択した場合、拡張機能の既存ユーザーの操作が中断されることはありません
移行しない場合のプロセス
拡張機能を Stripe アプリに移行しない選択をした場合、拡張機能は、2024 年まではユーザーに影響することなくこれまでどおり機能します。2024 年末まではバックエンドでの拡張機能のサポートを継続する予定です。ただし、2022 年 8 月 31 日以降、新しいユーザーにはパートナーディレクトリーに拡張機能に関する記載が表示されなくなります。
Stripe Apps と拡張機能の比較
アプリでは、拡張機能のすべての機能に加えて、2 つの重要な機能を実行できます。
- 埋め込みの UI コンポーネントを使用した、Stripe ダッシュボードでのインタラクティブな機能
- ユーザーがアプリでアクセスできる機能を簡単に把握できるようにするより細かい権限
この他の違いとして、ユーザーはアプリをパートナーディレクトリーではなく Stripe App Marketplace から見つけることができます。
拡張機能 | Stripe Apps |
---|---|
すべての Stripe ユーザーが使用できます。 | すべての Stripe ユーザーが使用できます。 |
2022 年 8 月 31 日以降、Stripe はパートナーディレクトリーから拡張機能についての記載をすべて削除します。 | すべての Stripe ユーザーの目につきやすい、Stripe App Marketplace に掲載されます。 |
既存の拡張機能は、ダッシュボードの開発者 > 拡張プログラムで確認できます。 | アプリは、ダッシュボードの開発者 > **アプリ**で確認できます。 |
拡張機能は、すべて読み取りまたはすべて書き込みの権限に限定されます。より細かい権限は使用できません。 | アプリのインストールの一環として、より細かい権限セットをユーザーにリクエストできます。 |
2022 年 5 月 24 日以降は新しい拡張機能を作成できません。 | 開発者は Stripe プラットフォーム上に構築できます。 |
ユーザーが OAuth を介して Stripe アカウントを拡張機能に関連付けた後で、ユーザーの代理として API リクエストを実行できます。 | ユーザーがアプリを認証してインストールしたら、ユーザーの代理として API リクエストを実行できます。 |
ユーザーは、その他のツールをインストールして Stripe のサイトを離れることで、拡張機能を操作します。 | ユーザーは Stripe のサイトを離れずに UI 内でアプリを操作できます。 |
Stripe の UI を拡張することはできません。 | Stripe ダッシュボードから開始して、Stripe の UI 上に直接構築できます。 |
拡張機能のユーザーへの影響
拡張機能を移行すると、既存のユーザーの拡張プログラムの設定ページにはバッジが表示され、再度認証するように求められます。ユーザーは、移行したアプリの使用を開始するために権限を承認する必要があります。権限を承認しないことを選択した場合でも、2024 年まで拡張機能を継続して使用できます。
移行により、既存の拡張コードは、すでに使用している Stripe アカウントに維持されます。ただし、同じ Stripe アカウントで既存の拡張機能と Stripe アプリを両方設定することはできず、拡張機能またはアプリのどちらかを指定できます。移行を選択した場合は、拡張機能に関連付けられた Stripe アカウントを使用して移行する必要があります。同じ Stripe アカウントを使用することで、ユーザーは中断なく使用を続けることができます。ユーザーは、Stripe ダッシュボードで確認メッセージに同意するだけで、新しいアプリに切り替えることができます。
拡張機能を移行しないままアプリを作成することを希望する場合、いくつかの制限が適用されます。
- 別の Stripe アカウントを作成してアプリを公開する必要があります。
- アプリは、既存の拡張機能のサービスとは異なる一意の目的を持つ必要があります。
Stripe Apps に移行する
拡張機能を Stripe Apps に移行するには、次の手順に従います。
拡張プログラムを Stripe アプリに移行する
はじめに
- Stripe アプリの開発が拡張機能のユーザーに影響しないようにするために、別個または新規の Stripe アカウントでアプリをテストしてアップロードし、アプリのユーザーを拡張機能のユーザーから完全に分離します。
- セキュリティをさらに強化するには、バックエンドのテスト用インスタンスを別に作成します。Stripe アプリをテストする際、本番環境の拡張機能が利用しているバックエンドのコードの変更は避けてください。
- Stripe アプリを全面的にテストした後、拡張機能に関連付けられているのと同じ Stripe アカウントにアプリをアップロードして、アプリを提出し、審査を受けることができます。
インタラクティブな機能を追加する
オプションで、UI コンポーネントを使用して、Stripe ダッシュボードでインタラクティブな機能を追加できます。
Webhook リスナーを追加する
拡張機能で Stripe に対して認証されたリクエストを行えることを確認します。account.
イベントの Webhook リスナーを追加します。
連結アカウントの各イベントには、Event オブジェクトのリファレンスに記載されている応答プロパティーに加えて、上位レベルの account
プロパティーも含まれます。このプロパティーは、Webhook の送信先のユーザーを識別します。
連結アカウントの各イベントには、Event オブジェクトのリファレンスに記載されている応答プロパティーと、上位レベルの account
プロパティーが含まれます。account
プロパティーは、Webhook の送信先のユーザーを識別します。
{ "id": "evt_uTDTFUG1IRr2qJ", "livemode": true, "object": "event", "type": "account.application.authorized", "account": "acct_c5qjjeLjSng3B4", "pending_webhooks": 2, "created": 1349654313, "data": {...} }
これで、ユーザーはプラットフォームに連結されました。account
をデータベースに保存します。これは、新しいアカウントの Stripe ID です。この値を Stripe-Account
ヘッダーでリクエストに渡すことで、連結アカウントとして認証します。
詳細については、Connect Webhook をご覧ください。
権限を追加して、アプリをアップロードする
アプリマニフェストに権限を追加して、アプリをアップロードします。連結アカウントの管理者は、アプリに移行するために、これらの権限を承認する必要があります。
警告
Stripe アプリの権限モデルは、以前に拡張機能を承認したグローバルな権限を上書きします。既存のユーザーが権限に関連する中断に直面しないように、お客様の拡張機能 (アプリではなく) が Stripe API で呼び出すオブジェクトを特定して、アプリに追加する権限を確認する必要があります。
連結アカウントの管理者、Stripe、拡張機能の間の移行プロセスは以下のようになります。
アプリが審査に合格し、アプリを公開したら、拡張機能のユーザーは移行されたアプリを表示して使用するために、ダッシュボードの設定で権限を承認する必要があります。UI Extensions を追加する場合、ユーザーは変更を承認するためにダッシュボードではなく Stripe App Marketplace にリダイレクトされます。
アプリを公開する
審査のためにアプリを送信し、Stripe App Marketplace で公開します。
アプリの審査に合格する可能性を高めるには、以下の Stripe のドキュメントに従ってください。
アプリを Stripe App Marketplace に公開するためには、審査に合格する必要があります。アプリを公開する準備ができたら、拡張機能のユーザーがそのアプリに移行できるように、本番環境のトラフィックで使用する Stripe のプライマリーアカウントを使用します。
ユーザーのアカウント登録
移行後に、既存のユーザーは Stripe アプリを使用するためにダッシュボードで再度認証する必要があります。ユーザーが要求された権限を承認しない場合は、2024 年まで拡張機能を継続して使用できます。
次の 2 つの方法で、「新しい」ユーザーを Stripe アプリにアカウント登録できます。
- アプリを移行して、アプリを掲載するための要件を満たすと、移行したアプリを Stripe App Marketplace に掲載できるようになります。2022 年 6 月下旬以降、Stripe App Marketplace のすべての Stripe アプリを、Stripe アカウントのユーザーがインストールできるようになります。
- 新しいユーザーは、引き続きウェブサイトから OAuth 経由で拡張機能へのアカウント登録を行うことができます。ユーザーが OAuth 認証を受け入れて Stripe ダッシュボードに戻ると、Stripe は移行後の Stripe アプリを使用するようにユーザーに求めます。ユーザーがこれを拒否した場合、2024 年までは拡張機能の使用を続行できます。
注
移行の完了後に OAuth 経由で新しいユーザーのアカウント登録が行われないようにするために、OAuth コールバックを削除し、ウェブサイトの **Connect with Stripe (Stripe と連結)**ボタンを変更して、新しいユーザーを Stripe App Marketplace に掲載のアプリリストにリダイレクトできます。OAuth コールバックを削除すると、2022 年 6 月下旬までは Stripe App Marketplace 経由で新しいユーザーのアカウント登録を行うことができません。OAuth コールバックを削除しない場合は、拡張機能と Stripe アプリの両方について、貴社の責任で掲載とユーザーを別々に管理していただくことになります。