通过订阅令牌获取订阅数据
注意
该门户网站正在开发中。文档的完整版本请看这里.
此方法允许通过订阅令牌获取订阅信息。
交互参数
GET https://public-api.rustore.ru/public/subscription/{subscriptionToken}
属性 | 类型 | 描述 | 必须 | 布局 | 填写示例 |
---|---|---|---|---|---|
Public-Token | string | Public API Rustore的访问令牌 | 是 | header | |
subscriptionToken | string | 如何获取订阅令牌 | 是 | path | 111.123 |
响应参数
属性 | 类型 | 描述 | 必须 | 布局 | 填写示例 |
---|---|---|---|---|---|
code | string | 响应代码 | 是 | body | ОК,ERROR,BAD_REQUEST,NOT_FOUND |
message | string | 响应代码解释 | 否 | body | |
timestamp | timestamptz | 响应时间 | 是 | body | |
body{} | object | 响应正文 | 否 | body |
body
属性 | 类型 | 描述 | 必须 | 布局 | 填写示例 |
---|---|---|---|---|---|
code | number | 响应代码 | 是 | body | |
success | boolean | 响应成功标志 | 是 | body | true |
message | string | 响应代码解释 | 否 | body | 未知错误 |
body{} | object | 消息正文 | 否 | body |
body.body
属性 | 类型 | 描述 | 填写示例 |
---|---|---|---|
serviceName | string | 服务名称 | Okko |
subscriptionId | integer | 订阅的唯一标识符 | 12345 |
addParameters | string | 订阅的附加参数 | Something about subscription |
productType | string | 产品类型 | SUBSCRIPTION |
productName | string | 产品名称 | Okko优选 |
productCode | string | 产品代码 | monthly_sub |
recurrent | boolean | 自动续订标志 | true |
countOfDay | integer | 天数 | 10 |
periodType | string | 周期类型 | 可用值:DAY, MONTH,YEAR |
periodDuration | integer | 周期时长 | 10 |
nextPaymentDate | string | 下次支付日期 | 2021-03-23 |
price | integer | 以货币最小单位(即戈比)表示的价格 | 9999 |
currency | string | 货币 | RUB |
imageUrl | string | 产品图片链接 | |
state | string | 订阅状态 | 活跃状态。ACTIVATED --- 订阅已激活。中间状态。ACCEPTED --- 等待支付。DEPOSITED --- 支付已成功,订阅等待激活;CLOSE_PENDING --- 订阅正在关闭中;REPEATING --- 订阅处于续订阶段,正在尝试续订支付。最终状态。DECLINED --- 订阅已关闭,所有尝试进行订阅支付均失败。GRACE 和 HOLD 期限以及续订尝试次数已结束。CANCELED --- 用户未支付订阅费;CLOSED --- 订阅已关闭;用户已关闭自动续订功能,已到期的订阅期满,且提供商已确认订阅关闭;REFUNDED --- 启动向用户退款。 |
currentPeriod | string | 当前期间的名称 | 可用值:PROMO --- 免费期间;START --- 初始期间,享有降价优惠;STANDARD --- 标准期间;GRACE --- 宽限期,用户未支付订阅费,扣费尝试仍在继续,内容访问权限保留;HOLD --- 暂停期,用户未支付订阅费,扣费尝试仍在继续,但应停止访问内容。 |
debtPaymentPeriod | string | 支付周期的名称 | Null如果周期是标准的 |
description | string | 订阅产品描述 | 描述 |
tariffId | integer | 费率的唯一标识符 | 12345 |
periods\[\] | array[object] | 当前周期信息 | 费率周期 |
body.body.periods []
属性 | 类型 | 描述 | 填写示例 |
---|---|---|---|
periodName | string | 当前期间的名称 | 可用的值包括:PROMO,START,STANDARD,GRACE,HOLD |
periodType | string | 周期类型 | 可用的值包括:DAY,MONTH,YEAR |
periodDuration | number | 周期时长 | 10 |
periodPrice | number | 以货币最小单位(即戈比)表示的价格 | 10000 |
nextPeriod | string | 下一个周期的名称 | 可用的值包括:PROMO,START,STANDARD,GRACE,HOLD |
示例回复:
"code":"200",
"message":"something",
"timestamp":"2023-08-02T10:11:04.655684723+03:00",
"body":
{
"code": 40401,
"success": false,
"message": "Неизвестная ошибка",
"body": {
"serviceName": "Okko",
"subscriptionId": 100500,
"addParameters": "something",
"productType": "string",
"productName": "ОККО Оптимум",
"productCode": "string",
"recurrent": true,
"countOfDay": 100,
"periodType": "DAY",
"periodDuration": 30,
"nextPaymentDate": "2021-03-23",
"price": 999,
"currency": "RUB",
"imageUrl": "https://static-eu.insales.ru/images/products/1/7435/306650379/thumb_1586524817849_15832463664565053990106868.jpg",
"state": "ACTIVATED",
"currentPeriod": "STANDARD",
"debtPaymentPeriod": "string",
"description": "Описание",
"tariffId": 100500,
"periods": [
{
"periodName": "STANDARD",
"periodType": "DAY",
"periodDuration": 10,
"periodPrice": 10000,
"nextPeriod": "STANDARD"
}
]
}
}
请求验证
在接收请求时,会检查通过授权令牌获取方法获得的授权令牌。
- 所有者和/或应用程序不应被封锁;
- 令牌应该是有效的;
- 应用程序代码 application_code 应该与获得授权令牌的所有者相对应。