Stripe Apps を使用してプラグインを移行または構築する
これまで Stripe は、自社製品と連携させるためのユーザーの標準 API キーをリクエストする方法としてサードパーティーのプラグインを許可していました。2024 年 1 月以降、Stripe では、Stripe Apps を利用するためにプラグインが必要となりました。新規および既存のプラグインはすべて、Stripe Apps を使用して、Oauth 2.0 または制限付きの API キーを使用してサービスのユーザーを認証する必要があります。
既存のプラグインがある場合は、セキュリティとコンプライアンスの目的のため、標準の Stripe Apps の組み込みパスに移行します。既存のプラグインを Stripe アプリの組み込みに移行する場合は、プラグインの認証方法を変更するだけで移行できます。
注
移行する理由
Stripe アプリを介した認証は、すべての新しいプラグイン、拡張機能、パートナーコネクターの新しいデフォルトの、標準の組み込みパスです。新しい組み込みパスのメリットは、以下のとおりです。
- アカウント登録の効率化: ユーザーが手動で API キーを作成する必要がなくなります。
- セキュリティの強化: 制限付き API キーなので、キーが公開された場合でもユーザーを保護できます。
- アナリティクス: アプリの導入率とパフォーマンスを確認できます。
- 見つけやすさ: Stripe Apps によって、Stripe ダッシュボード、Stripe App Marketplace、Stripe パートナープログラムのさまざまなところでお客様の製品が表示されるようにして、視認性を高めます。
- 認定パートナー: Stripe パートナーエコシステムのアプリトラックに参加して、共同販売、マーケティング、技術面での特典を受けることができます。
移行しない場合に起きること
認証を Stripe アプリに移行しない選択をした場合、認証は、2024 年まではユーザー体験に影響することなくこれまでどおり機能します。2024 年末まではバックエンドでのプラグインのサポートを継続する予定です。
移行後のユーザーへの影響
移行する選択をした場合、ユーザーはプラグインを再度アカウント登録して認証する必要があります。プラグインを移行または構築するには、OAuth 2.0 (推奨) または制限付き API キー (RAK) 認証を選択します。OAuth は、ユーザーがプラグインを安全に認証するための最も簡単な方法です。RAK では、お客様が追加のバックエンドを用意する必要はありませんが、ユーザーは生成された Stripe API キーをコピーしてサードパーティープラグインに貼り付ける必要があります。この方法では、ユーザーの認証プロセスがより複雑になります。
はじめに
- Stripe Apps の使用を開始するのはじめにセクションを読んで実行します。Stripe CLI の最新バージョンをインストールしていることを確認してください。
- 認証タイプ (OAuth または RAK) を選択します。アプリをアップロードした後に、認証方法を変更することはできません。認証の詳細については、API 認証をご覧ください。
- Stripe Connect を使用していて、Stripe Apps を通じて既存のプラグインを移行する場合は、新しい Stripe アカウントを作成する必要があります。現在、Connect が有効になっている Stripe アカウントではアプリを公開することはできません。
- アカウントごとに作成できる公開アプリは 1 つのみです。アカウントにすでに公開アプリがある場合は、新しい Stripe アカウントを作成してください。同じアカウント上でも、プライベートアプリの場合は、公開アプリと並行して複数作成することができます。
プラグインを移行または構築するための認証方法を以下から選択してください。
アプリを開発する
CLI で
stripe apps create <app-name>
を実行して、Stripe アプリを作成します。アプリのマニフェストで次のフィールドを編集します。
stripe_api_access_type
をoauth
に設定します。distribution_type
をpublic
に設定します。allowed_redirect_uris
を設定します。これは、ユーザーが OAuth を使用してアプリをインストールした後にリダイレクトされる URL です。リストの最初の URL がデフォルトのリダイレクト先として使用されます。
アプリのマニフェストは以下のようになります。
stripe-app.json{ "id": "com.example.my-app", "version": "0.0.1", "name": "Your Stripe App", "icon": "./[YOUR_APP]_icon_32.png", "permissions": [ // Your app permissions here ], "stripe_api_access_type": "oauth", "distribution_type": "public", "allowed_redirect_uris": [ // Your redirect URIs here ] }
アプリに必要な権限をすべて追加します。
(オプション) UI 拡張機能をアプリに追加します。ユーザーが設定を変更できるようにしたり、アプリのドキュメントへのリンクを追加したりするために、設定ビューを追加することをお勧めします。
アプリを Stripe にアップロードします。
Command Linestripe apps upload
アプリをテストする
- アプリの詳細ページに移動します。
- 外部テストタブを開き、始めるをクリックして外部テストを設定します。
- OAuth をテストセクションにある認証リンクにアクセスします。このリンクを使用すると、自分のアカウントを使用してテストすることができます。
OAuth 2.0 を設定する
OAuth 2.0 を正しく設定していることを確認します。アクセストークンの保存方法や更新方法については、OAuth 設定をご覧ください。