获取订阅信息

如果计划在网页商城中销售订阅计划，请通过以下方式之一实现订阅操作信息的接收：

• 通过API（适用于无服务器集成）
• 通过Webhook（自动通知，适用于服务器集成）

通过API调用进行设置

在应用程序的客户端侧，实现通过HTTP GET请求获取关于用户订阅的信息。

艾克索拉API使用HTTP访问认证。请求必须包含Authorization: Bearer <client_user_jwt>头，其中<client_user_jwt>是一个根据Base64编码的唯一令牌。获取方法：

• 通过用户名和密码授权时，使用注册新用户和通过用户名和密码进行认证API调用。
• 通过社交网络授权时，使用通过社交网络进行认证API调用。

将项目ID指定为路径参数projectId。可在发布商帐户中项目名称的旁边找到该参数。指定查询参数：

• limit — 页面上元素数量的限制。（默认显示15个元素）。
• offset — 元素编号，从该元素开始生成列表（从0开始数）。
• locale — 界面语言（默认为英文）。接受符合ISO 639-1标准的值。

-X 'GET' \
  'https://subscriptions.xsolla.com/api/user/v1/projects/{projectId}/subscriptions?locale=ru&limit=5&offset=5 ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

响应示例：

{
  "items": [
    {
      "id": 11111111,
      "plan_id": 11111
      "plan_external_id": "TestChangePlanBase",
      "plan_name": "package_recurrent_name_66053",
      "plan_description": "package_recurrent_description_66053",
      "product_id": null,
      "product_external_id": null,
      "product_name": null,
      "product_description": null,
      "status": "active",
      "date_create": "2021-03-11T13:50:11+03:00",
      "date_next_charge": "2031-04-11T13:51:02+03:00",
      "date_last_charge": "2021-03-11T13:51:02+03:00",
      "charge": {
        "amount": "0.2500",
        "currency": "USD"
      },
      "period": {
        "value": 1,
        "unit": "day"
      }
    }
  ],
  "has_more": true
}

通过Webhook进行设置

1. 配置参数以接收Webhook：
   1. 在发布商帐户中打开您的项目。
   2. 在侧边栏中单击项目设置，然后前往Webhooks选项卡。
   3. 在Webhook服务器字段中指定要接收Webhook的服务器URL，格式为https://example.com。您也可以指定在工具中找到的URL来用于测试。
   4. 默认会生成一个用于项目Webhook签名的密钥。如要生成新密钥，请点击刷新图标。
   5. 单击启用Webhook。

2. 在应用程序中实现对以下类型Webhook的处理：
   • 要购买及续订订阅：
     • 用户验证
     • 支付
     • 已创建订阅
     • 已更新订阅
   • 要取消订阅：已取消订阅
   • 要退款：退款

3. 测试Webhook：
   1. 在发布商帐户 > 项目设置 > Webhooks中，前往订阅选项卡。

2. 要测试Webhook，请指定要包含在请求中向所提供Webhook URL发送的项目值（用户ID、发票ID）。如果没有真实值，可输入随意值。完成以下表单字段：
   • 用户ID
   • 艾克索拉发票ID
   • 金额
   • 货币
   • 计划ID
   • 订阅产品（可选）
   • 发票ID — 内部订单号（可选）
   • 试用期（要在沙盒模式下测试订阅购买或测试续订订阅计划，请将值设置为0。）

3. 单击测试。
4. 验证收到了测试成功消息。如果测试成功，您的服务器须作出如下响应：
   • 不带消息正文的HTTP代码204。
   • 描述问题的HTTP代码400或500（如果指定用户未找到或传入的签名无效）。

4. 测试接受剩余的Webhook：
   1. 使用沙盒模式测试购买和续订订阅及获取已创建订阅、已更新订阅和已取消订阅Webhook。
   2. 使用实时模式测试用真实支付购买订阅及获取退款、已取消订阅Webhook。

下一步

1. 设置用户认证。
2. 在沙盒模式下测试网页商城。

有用链接

集成过程