使用场景:

编辑器,奖品选择可见性接口


接口地址 由第三方企业开发者或中间件开放接口并在自建应用中配置查询接口

请求方式 POST

consumes ["application/json"]

produces ["application/json"]

应用权限 奖品->奖品可见性列表

请求参数


公共参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

orgId企业IDbodytrueString
appInstanceId应用实例IDbodytrueString
noticeData通知数据bodytruearray
nonce签名随机数stringtrueString签名随机数
timestamp签名时间戳longtrueLong签名时间戳
signature签名stringtrueString签名
instanceAppId自建应用appidStringtrueString
thirdUid开放平台登陆uid String非开放平台用户为空String
thirdCompanyId开放平台登陆componyIdString非开放平台用户为空String

奖品可见性查询参数

参数名称

参数说明

请求类型

是否必须

数据类型

schema

prizeName查询奖品名称bodyfalseString编辑器奖品选择列表,左上角输入框输入就有值。
appId作品IdbodytrueString
componyId开放平台登陆componyIdbodytrueString
uid开放平台登陆 uidbodytruestring
pageIndex页码bodytrueInteger
pageSize页面大小bodytrueInteger

请求示例

{
  "appInstanceId""778985290508406784",
  "orgId""928a852d-e749-45be-bc31-f8e23f07b7f4",
  "callbackData": [
    {
            "prizeName":"查询奖品名称"
            "appId""432852d-a749-45be-bc31-f8e23f22b7f4",
            "componyId""11111",
            "uid":"11111",
            "pageIndex":1,
            "pageSize":10
    }
  ],
  "nonce""n14GvACT6Ed768TUlJHKwD2Ml2ej89n1",
  "timestamp": 1625793771858 ,
"instanceAppId": "Ipu_t60KoV-gTTtCSkFMWtrkTIA",
"orgId": "572d9b1a-aca5-40a9-ad6e-4d8deb6395c4",
"thirdCompanyId": "0707",
  "signature""1d11d6b2be2113fd42519be97421b1ad0ddcb1e5"
}


响应参数


参数名称

参数说明

请求类型

是否必须

数据类型

schema

code状态码bodytruestring
msg描述bodytruestring
data返回内容body



data实体

参数名称

参数说明

请求类型

是否必须

数据类型

schema

callbackSuccessData成功数据List
大小为pageSize规定的大小

成功实体

参数名称

参数说明

数据类型

是否必须

schema

totalCount总数量Integertrue

可见奖品,总数量

data分页数据List<Object>true


data实体

参数名称

参数说明

数据类型

是否必须

schema

visibleCount

可见数量Integertrue

非零:列表显示该值。

0:显示库存可用数量

thirdPrizeId外部奖品idStringtrue可见的奖品id

响应示例

{
    "code""200",
    "errorCode""SUCCESS",
    "msg""通讯成功",
    "data": {
        "callbackSuccessData": [
                    {
                        "totalCount":1000,
                        "data":[
                            {
                                "visibleCount":100,
                                "thirdPrizeId":"asdadaa-asdasd-asd-asda"
                            }
                        ]
                    }
        ]
    }
}

响应状态

状态码

说明

schema

200OK
201Created
401Unauthorized
403Forbidden
404Not Found
500FAIL
  • 无标签