订阅组家庭分享

获取当前用户共享验证码的接口

POST /bp/asset/share_group/code

接口功能： 提供当前用户的共享验证码，若用户有多个资产，则选择有效期最长的资产对应的验证码。

请求头部参数 (Headers)：

参考接入 BytePower

• X-BytePower-Session-Token：登录后获取用户的 session。
• X-BytePower-Sign：请求体签名

请求体

{
  "share_code_quota": 5
}

注意：此 body 可有可无如果没有，则使用 console 上配置；如果有则要求 console 配置的值 >= share_code_quota >=0

响应

• HTTP 状态码：200

  描述：成功 响应示例：

{
  "share_code": "<code_value>",
  "remain_count": 2
}

HTTP 状态码：4xx 描述：错误 响应示例：

{
  "error": {
    "error_type": "invalid_parameter",
    "message": "xxxxx"
  }
}

error_type：

• item_not_found（找不到条目）
• config_invalid （console 配置限制问题）
• asset_request_not_supported （平台不支持）
• share_group_limit （分享次数受限）

使用共享码分享订阅

POST /bp/asset/share_group/join

接口功能： 用于家庭成员使用共享码加入家庭组。

请求头部参数 (Headers)：

参考接入 BytePower

• X-BytePower-Session-Token：登录后获取用户的 session。
• X-BytePower-Sign：请求体签名

请求体

• content-type: "application/json"

• 描述：用户注册所需信息

• 请求体示例：

{
  "share_code": "<code_value>"
}

响应

• HTTP 状态码：200

  描述：成功 响应示例：

{
    "assets": [{
        "name": "资产名称 coin",
        "type": "类型 consumable | nonconsumable | subscription",
        "valid_seconds": int 订阅型资产的剩余秒数,
        "quantity": int 消耗型资产的剩余数量,
        "total_quantity": int 消耗型订阅(consumable subscription） 资产的当期
        "is_auto_renewable": bool 是否为自动续订商品,
        "is_trial_period": bool 是否在试用期,
        "expire_time": "2020-04-04T04:30:00Z", 订阅资产类型有效，过期时间。RFC3339 标准格式，例如："2023-04-17T07:45:53.997405Z"
        "custom_expire_time": "0001-01-01T00:00:00Z", 订阅资产类型有效，console 加减后的过期时间。RFC3339 标准格式，例如："2023-04-17T07:45:53.997405Z"
        "platform": string, 订阅平台，只有 type == subscription 时返回该字段
        "product_id": string 订阅平台的 product_id，只有 type == subscription 时返回该字段
     }]
}

HTTP 状态码：4xx 描述：错误 响应示例：

{
  "error": {
    "error_type": "invalid_parameter",
    "message": "xxxxx"
  }
}

error_type：

• invalid_parameter（无效参数）
• item_not_found（找不到条目）
• share_group_limit（达到限制）
• config_invalid （console 配置问题）