获取商品授权分配记录列表
查询并返回调用方身份有访问权限的商品授权分配记录列表
请求说明
请求地址 | https://openapi.wps.cn/v7/store/allocations |
---|---|
请求方法 | GET |
签名方式 | KSO-1 |
权限要求 | 查询和管理租户下的所有商城权益(应用授权) kso.store_allocation.readwrite.all 查询和管理该应用权限下的商城权益(应用授权) kso.store_allocation.readwrite.ownedby 查询租户下的所有商城权益(应用授权) kso.store_allocation.read.all 查询该应用权限下的商城权益(应用授权) kso.store_allocation.read.ownedby |
请求头(Header)
Header 名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
Content-Type | string | 是 | 使用:application/json |
X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
查询参数(Query)
名称 | 参数类型 | 是否必填 | 说明 |
---|---|---|---|
entitlement_key | string | 是 | 授权 key |
entity_id | string | 否 | 被分配对象实体 id |
entity_type | string | 否 | 被分配对象实体类型 |
limit | integer | 否 | 元素个数,默认为:10 |
offset | integer | 否 | 偏移量,默认为:0 |
请求地址示例
[GET] https://openapi.wps.cn/v7/store/allocations?entitlement_key={string}&entity_id={string}&entity_type={string}&limit={integer}&offset={integer}
响应体
名称 | 参数类型 | 说明 |
---|---|---|
code | integer | 响应代码。非 0 表示失败,参照《状态码说明》 |
msg | string | 响应信息 |
data | object | 响应数据 |
∟ items | array[object] | 商品授权分配记录列表 |
∟ ∟ entitlement_key | string | 授权 key |
∟ ∟ entity_id | string | 被分配对象实体 id |
∟ ∟ entity_name | string | 被分配对象实体名称 |
∟ ∟ entity_type | string[enum] | 被分配对象实体类型 user :用户;app :应用 |
∟ ∟ id | string | 分配记录 id |
∟ ∟ state | string[enum] | 分配记录状态 active :生效的;disabled :已禁用的;cancel :取消的;expired :过期的 |
∟ total | integer | 数据总量 |
more | object | 更多的错误信息 |
响应体示例
json
{
"data": {
"items": [
{
"entitlement_key": "string",
"entity_id": "string",
"entity_name": "string",
"entity_type": "string[enum]",
"id": "string",
"state": "string[enum]"
}
],
"total": 0
},
"msg": "string",
"code": 0
}