Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

获取商品授权分配记录列表

查询并返回调用方身份有访问权限的商品授权分配记录列表

请求说明

请求地址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-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

查询参数(Query)

名称参数类型是否必填说明
entitlement_keystring授权 key
entity_idstring被分配对象实体 id
entity_typestring被分配对象实体类型
limitinteger元素个数,默认为:10
offsetinteger偏移量,默认为:0

请求地址示例

[GET] https://openapi.wps.cn/v7/store/allocations?entitlement_key={string}&entity_id={string}&entity_type={string}&limit={integer}&offset={integer}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ itemsarray[object]商品授权分配记录列表
∟ ∟ entitlement_keystring授权 key
∟ ∟ entity_idstring被分配对象实体 id
∟ ∟ entity_namestring被分配对象实体名称
∟ ∟ entity_typestring[enum]被分配对象实体类型
user:用户;app:应用
∟ ∟ idstring分配记录 id
∟ ∟ statestring[enum]分配记录状态
active:生效的;disabled:已禁用的;cancel:取消的;expired:过期的
∟ totalinteger数据总量
moreobject更多的错误信息

响应体示例

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
}
回到旧版