Stripeをデータパイプラインソースとして設定 ​

Stripeをデータパイプラインソースとして設定し、支払い、請求、財務レコードを宛先に抽出します。 このガイドでは、Stripe APIキーの生成、コネクションの設定、パイプラインの構成、オブジェクトの追加、同期動作の確認、既知の制限事項の把握を行います。

サポートされている機能 ​

Stripeをパイプラインソースとして使用する場合、次の機能がサポートされます:

• クラウド接続: https://api.stripe.comを通じてHTTPS経由でStripeに接続します。 オンプレミスエージェントは不要です。
• ライブモードとテストモード: 対応するシークレットキーを指定して、ライブモードまたはテストモードのデータに接続します。 Workatoは各モードを別々のEnvironmentとして扱います。
• 完全更新と増分同期: 完全更新モードと増分同期モードをサポートします。 増分同期では、Stripe Events APIとリストエンドポイントのカーソルベースのページネーションを組み合わせて使用します。 詳細については、同期モードを参照してください。
• オブジェクトレベルの選択: 宛先内の個別のテーブルとして同期するStripeオブジェクトを選択します。 完全なリストについては、サポートされているオブジェクトを参照してください。
• ソフト削除の追跡: Stripeイベントを通じてサポートされているオブジェクトの削除を検出し、宛先内の削除済みレコードにソフト削除フラグを付けます。
• スキーマドリフトの検出と処理: 新しいフィールドを自動同期でスキーマの変更を自動的に検出して適用するか、新しいフィールドをブロックでスキーマを固定します。
• フィールドレベルのデータ保護: 機密フィールドをそのままレプリケートするか、宛先に到達する前にハッシュ化します。
• 構成可能な同期頻度: 時間ベースの間隔またはcron式を使用して同期をスケジュールします。 サポートされる最小間隔は15分です。

前提条件 ​

Stripeをデータパイプラインソースとして接続する前に、次の要件を満たしてください。

• ライブモードまたはテストモードのStripeアカウント
• 選択した認証方法の認証情報:
  • APIキー: 同期する予定のリソースに対する読み取り権限を持つStripe APIシークレットキー、およびそれを生成するためのStripeダッシュボードへのアクセス。 設定手順については、Stripe APIキーを生成を参照してください。
  • 認可コードグラント: サードパーティアプリケーションを認可する権限を持つStripeアカウントユーザー。

Stripe APIキーを生成 ​

APIキー認証でStripeに接続する場合は、Workatoでコネクションを作成する前にStripeダッシュボードでキーを生成します。 認可コードグラントで接続する場合は、このセクションをスキップしてください。

推奨権限 ​

サポートされているStripeオブジェクトを同期するには、Stripeの権限グリッドで次のリソースカテゴリに読み取り権限を付与します:

ユースケースに基づいて、その他のカテゴリの権限を構成します。

サポートされるコネクションタイプ ​

Stripeデータパイプラインは、次の2つの認証方法をサポートしています:

• APIキー: Stripeダッシュボードから生成された制限付きまたは標準のシークレットキーを指定します。 Workatoでは、データパイプラインにこの方法を推奨します。 設定手順については、Stripe APIキーを生成を参照してください。
• 認可コードグラント: StripeアカウントからWorkatoアクセスを認可し、OAuth 2.0を通じて接続します。 事前に認証情報は必要ありません。

Stripeに接続 ​

Stripeをデータパイプラインソースとして接続するには、次の手順を実行します。

パイプラインの設定 ​

Stripeをデータパイプラインソースとして構成するには、次の手順を実行します:

[minute] [hour] [day of month] [month] [day of week]

0 8 * * *

サポートされるオブジェクト ​

Stripeデータパイプラインは、Stripe REST APIリソースからデータを同期します。 次の表は、サポートされているオブジェクトをカテゴリ別に示しています。 各オブジェクトは、宛先内の個別のテーブルとして同期されます。

コア支払いオブジェクト ​

請求とサブスクリプション ​

財務照合 ​

税金と割引 ​

アカウントとイベント ​

支払い方法の詳細 ​

Stripe Issuing ​

次のオブジェクトは、アカウントでStripe Issuing製品を使用している場合にのみ同期されます:

同期モード ​

Stripeデータパイプラインは、完全更新と増分同期をサポートしています。 同期モードは、パイプラインに追加するときにオブジェクトごとに設定されます。

完全更新 ​

完全更新同期では、選択したオブジェクトについてStripeから利用可能なすべてのレコードを読み取り、宛先テーブルを上書きします。 実行ごとに完全なスナップショットが必要なオブジェクトには、完全更新を使用します。

増分同期 ​

増分同期では、最後に成功した実行以降に変更されたレコードのみが抽出されます。 Workatoは、イベントを発行するオブジェクトの作成、更新、削除を検出するためにStripe Events APIを使用します。 更新イベントを発行しないオブジェクトについては、Workatoはcreatedタイムスタンプを増分カーソルとして使用して新しいレコードを抽出します。

各オブジェクトの増分メカニズムを確認するには、サポートされているオブジェクトの表を参照してください。

削除追跡 ​

ソフト削除追跡をサポートするオブジェクトについて、WorkatoはStripeからの*.deletedイベントをリッスンし、宛先行を物理的に削除するのではなく、ソフト削除フラグ（is_deleted = true）を設定します。 削除追跡をサポートするオブジェクトを確認するには、サポートされているオブジェクトの表を参照してください。

Stripeは、すべてのオブジェクトタイプに対して削除イベントを発行するわけではありません。 削除追跡のないオブジェクトは、宛先に最後に確認された状態を保持します。

スキーマとデータ型の処理 ​

Stripeからデータを同期する場合、スキーマとデータ型には次の考慮事項が適用されます。

金額 ​

Stripeでは、すべての金額が該当通貨の最小通貨単位の整数として保存されます。 たとえば、1000はUSDでは$10.00、JPYでは¥1,000を表します。 Workatoは、これらの値を宛先で整数として保持します。 Workatoは通貨換算を実行しません。

JPYやKRWなどの小数なし通貨は、小数通貨とは異なる動作をします。 JPYの値100は¥1ではなく¥100を表します。 小数なし通貨のリストについては、Stripeの通貨ドキュメントを参照してください。

タイムスタンプ ​

Stripeは、タイムスタンプをUnixエポック整数として返します。

メタデータフィールド ​

ほとんどのStripeオブジェクトには、任意のデータを入力できるJSONキー値マップであるmetadataフィールドが含まれます。 Workatoは、metadataフィールドを宛先のJSON文字列列として保存します。 Workatoは、メタデータキーを個別の列にフラット化しません。

metadataフィールドを含むオブジェクトには、Customer、Charge、Card、Dispute、Invoice、InvoiceLineItem、PaymentIntent、PaymentMethod、Payout、Plan、Price、Refund、Subscription、Transferがあります。

Livemodeフラグ ​

ほとんどのStripeオブジェクトには、レコードがライブモードとテストモードのどちらに由来するかを示すlivemodeブールフィールドが含まれます。 Workatoは、宛先スキーマでこのフラグを保持します。

合成列 ​

Workatoは、特定のオブジェクトの宛先テーブルに次の合成列を追加します:

主キー列と_workato_is_deletedはnull不可です。 削除追跡対象オブジェクトのその他の列は、主キーと削除フラグのみを含むソフト削除行に対応するため、null可能です。

機密データの処理 ​

Stripeオブジェクトには、大量のPIIや財務データが含まれる場合があります。 次のオブジェクトには、一般的に機密フィールドが含まれます:

StripeはAPIを通じて公開していないため、顧客の支払い方法（Cardオブジェクト）について、生のカード番号やCVV値を返しません。 プラットフォーム発行カード（IssuingCardオブジェクト）の場合、これらのフィールドが要求されると、Stripeは完全なカード番号とCVVを返します。 Workatoは、これらの値を宛先に渡します。 IssuingCardsを同期する場合は、フィールドレベルのデータ保護でハッシュオプションを使用してnumberフィールドとcvcフィールドをマスクするか、同期から除外するためになしに設定します。

その他のPIIが宛先に到達する前に保護するには、パイプライン構成中にフィールドレベルのデータ保護でハッシュオプションを使用します。 詳細については、パイプラインを構成手順を参照してください。

制限事項 ​

Stripeをデータパイプラインソースとして使用する場合、次の制限事項が適用されます。

Events APIの30日間の保持 ​

Stripeはイベントを30日間保持します。 パイプラインカーソルが30日を超えて遅れると、パイプラインはイベントだけではギャップ期間の更新や削除を再構築できません。 カーソルが30日の制限に達する前に、一時停止したパイプラインを再開または再実行してください。 詳細については、同期モードを参照してください。

レート制限 ​

Stripeは、ライブモードでアカウントあたり1秒あたり25リクエストというデフォルトのレート制限を適用します。 テストモードのレート制限は、ライブモード制限の約25%です。 アカウントでより高いレート制限が必要な場合は、Stripe Supportにお問い合わせください。

ページネーション制限 ​

数百万件のレコードを持つアカウントでは、大規模な履歴同期の完了に時間がかかります。

メタデータのみの更新はキャプチャされません ​

Stripeは、オブジェクトのmetadataフィールドのみが更新された場合、イベントを発行しません。 メタデータのみの変更は増分同期に表示されません。 メタデータのみの変更をキャプチャするには、影響を受けるオブジェクトの完全更新を実行します。

SubscriptionHistoryは追加専用です ​

SubscriptionHistoryオブジェクトは追加専用の監査ログです。 このオブジェクトを再同期すると、履歴レコードが削除され、現在の状態のみで置き換えられます。 SubscriptionHistoryを再同期しないでください。

Stripe Connectプラットフォームアカウントはサポートされていません ​

Workatoは、指定したAPIキーのアカウントのデータのみを同期します。 Connectプラットフォームのマルチアカウント同期は現在サポートされていません。

一部のCard列にはStripe Supportによる有効化が必要です ​

iinやissuerなど、特定のCardオブジェクト列は標準のAPIレスポンスでは返されません。 宛先でこれらの列を利用する前に、Stripe Supportに連絡してアカウントでこれらの列を有効にしてください。

最小同期頻度 ​

サポートされる最小同期間隔は15分です。 これより高い頻度で同期をトリガーすることはできません。