文档Experience Platform源连接器指南

[Beta 版]{class="badge informative"}

Stripe

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员
NOTE
Stripe源为测试版。 有关使用测试版标记源的更多信息，请阅读源概述。

数千家各种规模的企业利用Stripe在线或亲自接受付款、创造新的收入来源，并在Adobe Experience Platform、Adobe Commerce和Magento Open Source的帮助下在全球范围内进行扩展。

在Experience Platform中使用Stripe源摄取客户在购买流程中捕获的数据。 引入后，使用此数据创建个性化优惠并解锁更丰富的业务洞察。

TIP
有关Experience Platform上Stripe源的问题，请通过adobe-partnership@stripe.com联系Stripe。
recommendation-more-help

源Stripe的示例用例

您的企业允许客户在您的在线商店购买商品，其选项为​ 立即购买 ​和​ 稍后付款（使用Klarna、Afterpay、Affirm或Zip）。

使用Stripe数据源分析​ 立即购买 ​和​ 稍后付款 ​选项的使用情况，并尝试为这些客户提供个性化优惠。 例如，考虑推荐附加产品，以便在结账前增加购物车中的产品数量。

style
shade-box

请阅读以下文档，了解如何设置Stripe源帐户、检索必要的凭据以及创建架构。

先决条件 prerequisites

以下部分提供了在将Stripe帐户连接到Experience Platform之前必须完成的先决条件设置的信息。

检索您的访问令牌

  • 使用您的Stripe电子邮件地址和密码登录到Stripe 仪表板。
  • 在Developers仪表板中，选择​ API keys for developers。
  • 在​ API密钥 ​选项卡下，选择​ Reveal test key ​以显示您的访问令牌。
  • 在将Stripe帐户连接到Experience Platform时，您现在可以使用此令牌作为访问令牌，使用Flow Service API或Experience PlatformUI。

收集所需的凭据

为了将您的Stripe帐户连接到Experience Platform，您必须提供以下身份验证凭据的值：

API

在使用Flow Service API连接Stripe帐户时，必须提供以下凭据。

table 0-row-2 1-row-2 2-row-2
凭据 描述
accessToken 您的Stripe OAuth 2刷新代码身份验证令牌。
connectionSpec.id Stripe源的连接规范ID。 此ID被固定为： cc2c31d6-7b8c-4581-b49f-5c8698aa3ab3。
UI

在使用Experience Platform用户界面连接Stripe帐户时，必须提供以下凭据。

table 0-row-2 1-row-2
凭据 描述
访问令牌 您的Stripe OAuth 2刷新代码身份验证令牌。

有关使用Stripe API的更多信息，请阅读有关API密钥🔗的Stripe 文档。

创建Experience Data Model (XDM)架构

Stripe源支持从以下资源路径摄取数据：

  • 费用
  • 订阅
  • 退款
  • 余额交易记录
  • 客户
  • 价格

您必须创建描述数据集的XDM架构，该数据集可以存储将从Stripe发送到Experience Platform的字段和数据类型。

费用

在Stripe中，费用 ​表示尝试将资金转入Stripe。 有关特定收费属性的更多信息，请阅读Stripe 收费的API指南。

accordion
选择以查看Stripe费用对象
code language-json 
{
  "id": "ch_3MmlLrLkdIwHu7ix0snN0B15",
  "object": "charge",
  "amount": 1099,
  "amount_captured": 1099,
  "amount_refunded": 0,
  "application": null,
  "application_fee": null,
  "application_fee_amount": null,
  "balance_transaction": "txn_3MmlLrLkdIwHu7ix0uke3Ezy",
  "billing_details": {
    "address": {
      "city": null,
      "country": null,
      "line1": null,
      "line2": null,
      "postal_code": null,
      "state": null
    },
    "email": null,
    "name": null,
    "phone": null
  },
  "calculated_statement_descriptor": "Stripe",
  "captured": true,
  "created": 1679090539,
  "currency": "usd",
  "customer": null,
  "description": null,
  "disputed": false,
  "failure_balance_transaction": null,
  "failure_code": null,
  "failure_message": null,
  "fraud_details": {},
  "invoice": null,
  "livemode": false,
  "metadata": {},
  "on_behalf_of": null,
  "outcome": {
    "network_status": "approved_by_network",
    "reason": null,
    "risk_level": "normal",
    "risk_score": 32,
    "seller_message": "Payment complete.",
    "type": "authorized"
  },
  "paid": true,
  "payment_intent": null,
  "payment_method": "card_1MmlLrLkdIwHu7ixIJwEWSNR",
  "payment_method_details": {
    "card": {
      "brand": "visa",
      "checks": {
        "address_line1_check": null,
        "address_postal_code_check": null,
        "cvc_check": null
      },
      "country": "US",
      "exp_month": 3,
      "exp_year": 2024,
      "fingerprint": "mToisGZ01V71BCos",
      "funding": "credit",
      "installments": null,
      "last4": "4242",
      "mandate": null,
      "network": "visa",
      "three_d_secure": null,
      "wallet": null
    },
    "type": "card"
  },
  "receipt_email": null,
  "receipt_number": null,
  "receipt_url": "https://pay.stripe.com/receipts/payment/CAcaFwoVYWNjdF8xTTJKVGtMa2RJd0h1N2l4KOvG06AGMgZfBXyr1aw6LBa9vaaSRWU96d8qBwz9z2J_CObiV_H2-e8RezSK_sw0KISesp4czsOUlVKY",
  "refunded": false,
  "review": null,
  "shipping": null,
  "source_transfer": null,
  "statement_descriptor": null,
  "statement_descriptor_suffix": null,
  "status": "succeeded",
  "transfer_data": null,
  "transfer_group": null
}
订阅

在Stripe中，您可以使用​ 订阅 ​定期向客户收费。 有关特定订阅属性的更多信息，请阅读订阅🔗上的Stripe API指南。

accordion
选择以查看Stripe预订对象
code language-json 
{
  "id": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
  "object": "subscription",
  "application": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null
  },
  "billing_cycle_anchor": 1679609767,
  "billing_thresholds": null,
  "cancel_at": null,
  "cancel_at_period_end": false,
  "canceled_at": null,
  "cancellation_details": {
    "comment": null,
    "feedback": null,
    "reason": null
  },
  "collection_method": "charge_automatically",
  "created": 1679609767,
  "currency": "usd",
  "current_period_end": 1682288167,
  "current_period_start": 1679609767,
  "customer": "cus_Na6dX7aXxi11N4",
  "days_until_due": null,
  "default_payment_method": null,
  "default_source": null,
  "default_tax_rates": [],
  "description": null,
  "discount": null,
  "ended_at": null,
  "invoice_settings": {
    "issuer": {
      "type": "self"
    }
  },
  "items": {
    "object": "list",
    "data": [
      {
        "id": "si_Na6dzxczY5fwHx",
        "object": "subscription_item",
        "billing_thresholds": null,
        "created": 1679609768,
        "metadata": {},
        "plan": {
          "id": "price_1MowQULkdIwHu7ixraBm864M",
          "object": "plan",
          "active": true,
          "aggregate_usage": null,
          "amount": 1000,
          "amount_decimal": "1000",
          "billing_scheme": "per_unit",
          "created": 1679609766,
          "currency": "usd",
          "interval": "month",
          "interval_count": 1,
          "livemode": false,
          "metadata": {},
          "nickname": null,
          "product": "prod_Na6dGcTsmU0I4R",
          "tiers_mode": null,
          "transform_usage": null,
          "trial_period_days": null,
          "usage_type": "licensed"
        },
        "price": {
          "id": "price_1MowQULkdIwHu7ixraBm864M",
          "object": "price",
          "active": true,
          "billing_scheme": "per_unit",
          "created": 1679609766,
          "currency": "usd",
          "custom_unit_amount": null,
          "livemode": false,
          "lookup_key": null,
          "metadata": {},
          "nickname": null,
          "product": "prod_Na6dGcTsmU0I4R",
          "recurring": {
            "aggregate_usage": null,
            "interval": "month",
            "interval_count": 1,
            "trial_period_days": null,
            "usage_type": "licensed"
          },
          "tax_behavior": "unspecified",
          "tiers_mode": null,
          "transform_quantity": null,
          "type": "recurring",
          "unit_amount": 1000,
          "unit_amount_decimal": "1000"
        },
        "quantity": 1,
        "subscription": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
        "tax_rates": []
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/v1/subscription_items?subscription=sub_1MowQVLkdIwHu7ixeRlqHVzs"
  },
  "latest_invoice": "in_1MowQWLkdIwHu7ixuzkSPfKd",
  "livemode": false,
  "metadata": {},
  "next_pending_invoice_item_invoice": null,
  "on_behalf_of": null,
  "pause_collection": null,
  "payment_settings": {
    "payment_method_options": null,
    "payment_method_types": null,
    "save_default_payment_method": "off"
  },
  "pending_invoice_item_interval": null,
  "pending_setup_intent": null,
  "pending_update": null,
  "quantity": 1,
  "schedule": null,
  "start_date": 1679609767,
  "status": "active",
  "test_clock": null,
  "transfer_data": null,
  "trial_end": null,
  "trial_settings": {
    "end_behavior": {
      "missing_payment_method": "create_invoice"
    }
  },
  "trial_start": null
}
退款

在Stripe中，您可以使用​ 退款 ​退款以前创建的费用。 有关特定退款属性的更多信息，请阅读退款Stripe API指南。

accordion
选择以查看Stripe退款对象
code language-json 
{
  "id": "re_1Nispe2eZvKYlo2Cd31jOCgZ",
  "object": "refund",
  "amount": 1000,
  "balance_transaction": "txn_1Nispe2eZvKYlo2CYezqFhEx",
  "charge": "ch_1NirD82eZvKYlo2CIvbtLWuY",
  "created": 1692942318,
  "currency": "usd",
  "destination_details": {
    "card": {
      "reference": "123456789012",
      "reference_status": "available",
      "reference_type": "acquirer_reference_number",
      "type": "refund"
    },
    "type": "card"
  },
  "metadata": {},
  "payment_intent": "pi_1GszsK2eZvKYlo2CfhZyoZLp",
  "reason": null,
  "receipt_number": null,
  "source_transfer_reversal": null,
  "status": "succeeded",
  "transfer_reversal": null
}
余额交易记录

在Stripe中，余额交易记录 ​表示您的Stripe帐户之间的资金流动。 有关特定余额交易属性的详细信息，请阅读余额交易的Stripe API指南。

accordion
选择以查看“Stripe余额事务处理”对象
code language-json 
{
  "id": "txn_1MiN3gLkdIwHu7ixxapQrznl",
  "object": "balance_transaction",
  "amount": -400,
  "available_on": 1678043844,
  "created": 1678043844,
  "currency": "usd",
  "description": null,
  "exchange_rate": null,
  "fee": 0,
  "fee_details": [],
  "net": -400,
  "reporting_category": "transfer",
  "source": "tr_1MiN3gLkdIwHu7ixNCZvFdgA",
  "status": "available",
  "type": "transfer"
}
客户

在Stripe中，客户 ​代表您公司的给定客户。 有关特定客户属性的信息，请阅读有关客户的Stripe API指南，了解有关特定客户属性的更多信息。

accordion
选择以查看Stripe客户对象
code language-json 
{
  "id": "cus_NffrFeUfNV2Hib",
  "object": "customer",
  "address": null,
  "balance": 0,
  "created": 1680893993,
  "currency": null,
  "default_source": null,
  "delinquent": false,
  "description": null,
  "discount": null,
  "email": "jennyrosen@example.com",
  "invoice_prefix": "0759376C",
  "invoice_settings": {
    "custom_fields": null,
    "default_payment_method": null,
    "footer": null,
    "rendering_options": null
  },
  "livemode": false,
  "metadata": {},
  "name": "Jenny Rosen",
  "next_invoice_sequence": 1,
  "phone": null,
  "preferred_locales": [],
  "shipping": null,
  "tax_exempt": "none",
  "test_clock": null
}
价格

在Stripe中，价格 ​表示产品循环购买和一次性购买的单位成本、货币和可选帐单周期。 有关特定价格属性的更多信息，请阅读价格🔗的Stripe API指南。

accordion
选择以查看Stripe价格对象
code language-json 
{
  "id": "price_1MoBy5LkdIwHu7ixZhnattbh",
  "object": "price",
  "active": true,
  "billing_scheme": "per_unit",
  "created": 1679431181,
  "currency": "usd",
  "custom_unit_amount": null,
  "livemode": false,
  "lookup_key": null,
  "metadata": {},
  "nickname": null,
  "product": "prod_NZKdYqrwEYx6iK",
  "recurring": {
    "aggregate_usage": null,
    "interval": "month",
    "interval_count": 1,
    "trial_period_days": null,
    "usage_type": "licensed"
  },
  "tax_behavior": "unspecified",
  "tiers_mode": null,
  "transform_quantity": null,
  "type": "recurring",
  "unit_amount": 1000,
  "unit_amount_decimal": "1000"
}

IP地址允许列表

在使用源连接器之前，必须将IP地址列表添加到允许列表中。 未能将特定于区域的IP地址添加到允许列表中，可能会导致使用源时出现错误或性能不佳。 有关详细信息，请参阅IP地址允许列表页。

配置Experience Platform权限

若要将您的Stripe帐户连接到Experience Platform，您必须同时为您的帐户启用​ 查看源 ​和​ 管理源 ​权限。 请联系您的产品管理员以获取必要的权限。 有关详细信息，请阅读访问控制UI指南。

后续步骤

完成先决条件设置后，您可以继续连接并将Stripe数据摄取到Experience Platform。 请阅读以下指南，了解如何使用API或用户界面将Stripe付款数据摄取到Experience Platform：

337b99bb-92fb-42ae-b6b7-c7042161d089