授权码心跳检测
功能介绍
商家进行授权码的激活后,用户每日首次使用License软件时,商家需要调用该接口,若不使用则无需调用。
URI
POST https://mkt.myhuaweicloud.com/api/mkp-openapi-public/global/v1/license/heartbeat
仅支持https协议。
“mkt.myhuaweicloud.com”域名不可用时请使用“mkt.myhuaweicloud.cn”进行重试。
请求消息
参数 |
是否必选 |
参数类型 |
最大字符长度 |
描述 |
---|---|---|---|---|
license |
M |
String |
64 |
授权码(新授权码对接商品传过来的是授权码,存量线上License商品也会调用该接口,传instanceId即可) |
heartbeatInfo |
M |
HeartbeatInfo |
心跳检测信息 |
heartbeatInfo为Json格式,支持扩充,云商店会校验关键key必输,对于已经对接过该接口的商家,云商店会保持对以往版本的兼容。
参数 |
是否必选 |
参数类型 |
最大字符长度 |
描述 |
---|---|---|---|---|
thirdParty Account |
M |
String |
256 |
三方系统用户唯一标识(代表商家软件内可以代表终端用户唯一性的字符串,如账号ID、设备码等) |
ip |
O |
String |
32 |
客户登录的IP地址 |
请求注意事项:
需要对mkt.myhuaweicloud.com HTTPS证书进行强校验,不能忽略证书校验,从而保证调用的是真实而非伪造的云商店服务。
请求示例
{ "license" : "PLXXXXXX", "heartbeatInfo":{ "thirdPartyAccount":"myaccount1", "ip":"192.168.1.51" } }
响应消息
参数 |
是否必选 |
参数类型 |
最大字符长度 |
描述 |
---|---|---|---|---|
error_code |
M |
String |
16 |
结果码。 |
error_msg |
M |
String |
1024 |
结果消息。 |
data |
O |
LicenseInfo |
license_info为Json格式,支持扩充字段,对于已经对接过该接口的商家,当响应字段增加,需要保持兼容。
参数 |
是否必选 |
参数类型 |
最大字符长度 |
描述 |
---|---|---|---|---|
status |
M |
String |
10 |
授权码状态 ALIVE-正常 EXPIRED-过期 RELEASED-已释放 |
activate_time |
M |
String |
16 |
激活时间,utc时间,格式:yyyyMMddHHmmss |
expire_time |
M |
String |
16 |
过期时间,utc时间,格式:yyyyMMddHHmmss |
product_name |
M |
String |
128 |
商品名称 |
product_id |
M |
String |
128 |
产品标识,同一skuCode下,不同周期类型的product_id不同。 例如:商家发布产品,新增一个规格,会生成一个skuCode,再配置包年、包月价格,会生成两个product_id。
说明:
该参数可在商品审核上架后,进入"卖家中心>商品管理>我的商品"页面,单击该商品操作列的“详情”进入详情页查看。 |
HTTP/1.1 200 OK Content-Type: application/json;charset=UTF-8 Content-Length: length Date: response time { "error_code": "92020000", "error_msg": "success" , "data": { "status": "ALIVE", "activate_time": "20230519024731", "expire_time": null, "product_name": null, "product_id": null } }
失败响应示例
HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=UTF-8Content-Length: lengthDate: response time { "error_code": "92020001", "error_msg": "Unauthorized" }