POST /api/v2/server-side-api/purchase/paddle/token/validate/

验证 Paddle 购买

使用 Adapty 看板应用设置中 Paddle 的凭据，通过提供的 Paddle 令牌验证购买。如果购买有效，则将交易历史记录从 Paddle 导入到 Adapty 中具有指定 customer_user_id 的用户画像。如果之前不存在具有此 customer_user_id 的用户画像，则将创建一个新的用户画像。

Request body

customer_user_idstringrequired

您系统中的用户 ID

paddle_tokenstringrequired

代表唯一购买的 Paddle 对象的令牌。可以是交易 ID（txn_...）或订阅 ID（sub_...）

Responses

购买验证成功

Schema

dataobjectrequired

app_idstringrequired

您的应用程序的内部 ID

profile_idstringrequired

Adapty 用户画像 ID

customer_user_idstringrequired

您的系统中该用户的 ID

total_revenue_usdnumberrequired

一个浮点数值，表示该用户画像所产生的以美元计算的总收入

segment_hashstringrequired

内部参数

timestampintegerrequired

响应时间（毫秒），用于解决竞态条件

custom_attributesarray of objectrequired

每个用户画像最多允许设置 30 个自定义属性

keystringrequired

键必须是不超过 30 个字符的字符串。只允许使用字母、数字、破折号、点和下划线

valuestring | numberrequired

属性值不得超过 50 个字符。值只允许使用字符串和浮点数

access_levelsarray of objectrequired

访问等级对象数组。如果用户没有任何访问等级，则为空数组

access_level_idstring

访问等级标识符

storestring

购买该访问等级的商店

store_product_idstring

商店中的产品 ID

store_base_plan_idstring

商店中的基础方案 ID

store_transaction_idstring

商店中的交易 ID

store_original_transaction_idstring

商店中的原始交易 ID

offerallOf

优惠详情（若应用了促销活动或新用户优惠）

categorystring

优惠类别

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

优惠类型

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

优惠 ID

starts_atstring

访问等级的生效时间

purchased_atstring

访问等级的购买时间

originally_purchased_atstring

访问等级的最初购买时间

expires_atstring

访问等级的到期时间

renewal_cancelled_atstring

续订取消的时间

billing_issue_detected_atstring

检测到计费问题的时间

is_in_grace_periodboolean

该访问等级是否处于宽限期

cancellation_reasonstring

取消原因

subscriptionsarray of objectrequired

订阅对象数组。如果用户没有任何订阅，则为空数组

storestring

购买订阅的商店

store_product_idstring

商店中的产品 ID

store_base_plan_idstring

商店中的基础方案 ID

store_transaction_idstring

商店中的交易 ID

store_original_transaction_idstring

商店中的原始交易 ID

offerallOf

优惠详情（若已应用促销活动或新用户优惠）

categorystring

优惠类别

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

优惠类型

One of: "free_trial", "pay_as_you_go", "pay_up_front"

idstring

优惠 ID

environmentstring

环境（沙盒、生产）

purchased_atstring

订阅的购买时间

originally_purchased_atstring

订阅的首次购买时间

expires_atstring

订阅的到期时间

renewal_cancelled_atstring

取消续订的时间

billing_issue_detected_atstring

检测到计费问题的时间

is_in_grace_periodboolean

订阅是否处于宽限期

cancellation_reasonstring

取消原因

non_subscriptionsarray of objectrequired

一次性购买对象数组。如果用户没有任何购买记录，则为空数组

purchase_idstring

唯一购买标识符

storestring

购买所在的商店

store_product_idstring

商店中的产品 ID

store_base_plan_idstring

商店中的基础方案 ID

store_transaction_idstring

商店中的交易 ID

store_original_transaction_idstring

商店中的原始交易 ID

purchased_atstring

购买时间

environmentstring

环境（沙盒、生产）

is_refundboolean

是否为退款

is_consumableboolean

是否为消耗型商品

Example

{
  "data": {
    "app_id": "14c3d623-2f3a-455a-aa86-ef83dff6913b",
    "profile_id": "3286abd3-48b0-4e9c-a5f6-ac0a006804a6",
    "customer_user_id": "Jane.doe@example.com",
    "total_revenue_usd": 0,
    "segment_hash": "8f45947bad31ab0c",
    "timestamp": 1736436751469,
    "custom_attributes": [
      {
        "key": "favourite_sport",
        "value": "yoga"
      }
    ],
    "access_levels": [],
    "subscriptions": [
      {
        "purchase_id": "5a7ab471-2299-45f7-ad69-1d395c1256e3",
        "store": "app_store",
        "store_product_id": "1year.premium",
        "store_base_plan_id": null,
        "store_transaction_id": "30002109551456",
        "store_original_transaction_id": "30002109551456",
        "purchased_at": "2022-10-12T09:42:50+00:00",
        "environment": "Production",
        "is_refund": false,
        "is_consumable": false
      }
    ],
    "non_subscriptions": []
  }
}

请求无效

Schema

errorsarray of objectrequired

sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

Example

{
  "errors": [
    "No products found"
  ],
  "error_code": "no_products_found",
  "status_code": 400
}

未授权

Schema

errorsarray of objectrequired

sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

Example

{
  "errors": [
    "Invalid API key"
  ],
  "error_code": "unauthorized",
  "status_code": 401
}

服务器内部错误

Schema

errorsarray of objectrequired

sourcestring

错误来源

errorsarray of string

错误消息数组

error_codestringrequired

简短错误名称

status_codeintegerrequired

HTTP 状态码

Try it

Authorization

Body

curl --request POST \
  --url 'https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/' \
  --header 'Authorization: Api-Key YOUR_SECRET_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
    "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
  }'

const response = await fetch('https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/', {
  method: 'POST',
  headers: {
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
    "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
  }),
});
const data = await response.json();

import requests

response = requests.post('https://api.adapty.io/api/v2/server-side-api/purchase/paddle/token/validate/', headers={
    'Authorization': 'Api-Key YOUR_SECRET_API_KEY',
    'Content-Type': 'application/json',
}, json={
      "customer_user_id": "<YOUR_CUSTOMER_USER_ID>",
      "paddle_token": "live_7d279f61a3339fed520f7cd8c08"
    })
data = response.json()