Stripe Connector リファレンス

Stripe などのオンライン支払処理プラットフォームを使用している企業が増えています。Stripe では、あらゆる規模の企業が顧客と支払の情報の同期を保つことで、API を通じて支払を処理できます。

Connections (接続)

システムに接続するには、それがデータの取得元であるかデータの取得先であるかに関係なく、そのシステムに必要なログイン情報を使用して接続を作成する必要があります。通常、フロー内の異なるシステムに接続し、接続が必要になるたびに各接続を再利用できます。

このシステムでは、接続のために次のログイン情報が必要です。

Connection Name (接続名)

この接続の詳細を把握するのに役立つ接続名を入力します。 1 つのフローおよび複数のフローで接続を複数回再利用できます。接続の作成後、ログイン情報は非表示になります。そのため、この接続を他の接続と簡単に区別できる名前を付けると役立ちます。

接続は自分にのみ表示されます。コンポーザーアプリケーションの他のユーザーは、独自の接続を作成する必要があります。

API key (API キー)

この項目の値はスペシャリストコネクタの ​Authorization​ 項目にマップされ、Stripe でユーザー名として機能します。API への認証は、HTTP 基本認証を使用して実行されます。API キーはユーザー名であり、パスワードは不要です。API キーは [Stripe Dashboard (Stripe ダッシュボード)Leaving the Site]​ で確認できます。Stripe API では、次の動作になります。

  • API キーを使用して要求を認証します。

  • プレフィックス ​sk_test_​ を持つテストモードキーと、プレフィックス ​sk_live_​ を持つライブモードの秘密鍵を指定します。

  • ユーザーが制限された API キーを使用してよりきめ細かい権限を実現します。

  • すべての API 要求が HTTPS を通じて行われていることを確認します。

Stripe ConnectLeaving the Site​ では OAuth 認証がサポートされますが、Stripe ではサポートされません。Stripe での OAuth 認証についての詳細は、​https://www.similartech.com/compare/stripe-vs-stripe-connectLeaving the Site を参照してください。

トリガー

各フローは、​スケジューラー​または​トリガー​によって開始します。スケジューラーはデフォルトの頻度である 15 分に設定されます。トリガー (例:「each time a new record is created (新規レコードが作成されるたび)」) はユーザーが定義し、システム内のデータに関連する複数のオプションがあります。

トリガーは、ポーリングプロセスを使用して外部システムからの最新情報を能動的にチェックします。ポーリングの頻度は 15 秒に 1 回です。

このシステムでは、次のトリガーオプションが提供されます。

New charge

支払元に対する新規の請求をチェックします。

New refund

新しい返金が作成されたときに実行します。

Polling Frequency (ポーリング頻度)

このコネクタのトリガーでは、​[Polling Frequency (ポーリング頻度)]​ 項目が必須です。この項目により、アクティブなフローのレコードの変更を検索するためにコンポーザーが基盤となるシステム API に対して要求を実行する頻度を選択できます。組織のフローごとに異なるポーリング頻度を選択できます。頻度が短くなると、フローの実行頻度は高くなりますが、より多くの ​『API コール』​がコンシュームされます。たとえば、注文管理フローがある場合、15 秒のポーリング間隔 (5760 API コール/日) で達成できるほぼリアルタイムの更新が必要になる可能性があります。これに対して、フローで価格設定カタログを更新する場合、1 時間ごと (24 API コール/日) にフローをポーリングすれば済みます。

アクション

システムに接続してトリガーを定義するか、スケジューラーを設定した後に、フローが実行するアクション (Workday から Salesforce へのレコードのコピーなど) を定義します。実行できるアクションは、接続しているシステムによって異なります。

このシステムでは次のアクションが提供されます。

Create charge

新しい請求を作成します。新しい請求を作成するときは、次の点に注意してください。

  • Amount​ 項目の値は整数です。たとえば、1.00 は 100 になります。

  • 次の項目には値が必要です。

    • Source​ 項目または ​Customer​ 項目

    • Customer ID
      ベストプラクティスとしては、[Customer ID (顧客 ID)] 項目の値を Stripe の既存のアカウントから取得するようにします。例: cus_JQ1BWAcXfKuswb​。

    • 配送項目が存在する場合、一部の配送項目は必須になります。

Stripe での ​Create Charge​ アクションについての詳細は、 https://stripe.com/docs/api/charges/createLeaving the Site を参照してください。

Create customer

新しい顧客を作成します。新しい顧客を作成する場合、​Phone​ 項目は顧客の電話番号であり、配送先電話番号ではありません。

Find customer

Customer ID​ で既存の顧客を検索します。

Create product

新しい Product オブジェクトを作成します。次の項目は必須です: Name (名前)​。

カスタム項目

カスタム項目はサポートされていません。MuleSoft Composer を使用して、Stripe レコードで設定したアクションとトリガーのカスタム項目値にアクセスできます。