文档首页/ 云商店/ 接入指南/ 商品接入相关接口/ 联营License类授权码商品接入指南/ 云商店开放接口描述/ 接口列表/ 查询授权码（必选）
更新时间：2025-07-03 GMT+08:00
查看PDF
分享

查询授权码（必选）

功能介绍

  • 该接口为原“授权码心跳检测”，商家进行授权码的激活后，用户每日首次使用License软件时，商家需要调用该接口，若不使用则无需调用。
  • 商家通过该接口实时查询授权码的状态、过期时间等信息，并通过该信息控制License软件的生命周期以及客户端的使用。

URI

旧版接口

POST https://mkt.myhuaweicloud.com/api/mkp-openapi-public/global/v1/license/heartbeat

新版接口

POST https://mkt.myhuaweicloud.com/api/mkp-openapi-public/global/v2/license/heartbeat

  • 仅支持https协议，“mkt.myhuaweicloud.com”域名不可用时请使用“mkt.myhuaweicloud.cn”进行重试。
  • 新版接口支持批量查询授权码，商家可以按照自身业务场景选择“新版”和“旧版”接口进行调用，只需调测任意一个版本的接口，都满足接入要求。
  • 需要对mkt.myhuaweicloud.com HTTPS证书进行强校验，不能忽略证书校验，从而保证调用的是真实而非伪造的云商店服务。

旧版接口参数信息

表1 请求参数

参数

是否必选

参数类型

最大字符长度

描述

license

M

String

64

授权码id

heartbeatInfo

O

HeartbeatInfo

/

心跳检测信息

注意：

该字段已日落，上报软件使用情况请对接“授权码软件使用统计”接口，已接入的License软件可继续使用。

heartbeatInfo为Json格式，支持扩充，云商店会校验关键key必输，对于已经对接过该接口的商家，云商店会保持对以往版本的兼容。

表2 HeartbeatInfo

参数

是否必选

参数类型

最大字符长度

描述

thirdParty Account

M

String

256

三方系统用户唯一标识（代表商家软件内可以代表终端用户唯一性的字符串，如账号ID、设备码等）

ip

O

String

32

客户登录的IP地址

请求示例

{
    "license" : "PLXXXXXX",
    "heartbeatInfo":{
        "thirdPartyAccount":"myaccount1",
        "ip":"192.168.1.51"
    }
}

响应消息

表3 响应参数

参数

是否必选

参数类型

最大字符长度

描述

error_code

M

String

16

结果码。

error_msg

M

String

1024

结果消息。

data

M

LicenseInfo

/

授权码信息

LicenseInfo为Json格式，支持扩充字段，对于已经对接过该接口的商家，当响应字段增加，需要保持兼容。

表4 LicenseInfo

参数

是否必选

参数类型

最大字符长度

描述

license_code

M

String

64

授权码

status

M

String

10

授权码状态

ALIVE-正常

EXPIRED-过期

RELEASED-已释放

activate_time

M

String

16

激活时间，utc时间，格式：yyyyMMddHHmmss

real_effect_time

M

String

16

交付完成时间（软件生效时间），utc时间，格式：yyyyMMddHHmmss

expire_time

O

String

16

过期时间，utc时间，格式：yyyyMMddHHmmss

一次性订单无过期时间

product_name

M

String

128

商品名称

product_id

M

String

128

产品标识，同一skuCode下，不同周期类型的product_id不同。

例如：商家发布产品，新增一个规格，会生成一个skuCode，再配置包年、包月价格，会生成两个product_id。

说明：

该参数可在商品审核上架后，进入"卖家中心>商品管理>我的商品"页面，单击该商品操作列的“详情”进入详情页查看。

order_id

M

String

64

订单号

amount

O

Integer

7

数量类型的商品定价属性
成功响应示例 
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": {
       "license_code": "PL********01",
       "status": "ALIVE",
       "activate_time": "20230519024731",
       "real_effect_time": "20230619024731",
       "expire_time": null,
       "product_name": null,
       "product_id": null，
       "order_id": null,
       "amount": null
    }
}

失败响应示例

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=UTF-8Content-Length: lengthDate: response time 
{ 
    "error_code": "92020001", 
    "error_msg": "Unauthorized"
}

新版接口参数信息

表5 请求参数

参数

是否必选

参数类型

最大字符长度

描述

license_list

M

String[]

100

授权码，最高支持一次性批量查询100个授权码。

请求示例

{
     "license_list" : ["PL****001","PL****002","PL****003"]
}

响应消息

表6 响应参数

参数

是否必选

参数类型

最大字符长度

描述

error_code

M

String

16

结果码。

error_msg

M

String

1024

结果消息。

data

M

LicenseInfo[]

/

授权码信息

LicenseInfo为Json格式，支持扩充字段，对于已经对接过该接口的商家，当响应字段增加，需要保持兼容。

表7 LicenseInfo

参数

是否必选

参数类型

最大字符长度

描述

license_code

M

String

64

授权码

status

M

String

10

授权码状态

ALIVE-正常

EXPIRED-过期

RELEASED-已释放

INVALID-不合法的授权码

activate_time

M

String

16

激活时间，utc时间，格式：yyyyMMddHHmmss

real_effect_time

M

String

16

交付完成时间（软件生效时间），utc时间，格式：yyyyMMddHHmmss

expire_time

O

String

16

过期时间，utc时间，格式：yyyyMMddHHmmss

一次性订单无过期时间

product_name

M

String

128

商品名称

product_id

M

String

128

产品标识，同一skuCode下，不同周期类型的product_id不同。

例如：商家发布产品，新增一个规格，会生成一个skuCode，再配置包年、包月价格，会生成两个product_id。

说明：

该参数可在商品审核上架后，进入"卖家中心>商品管理>我的商品"页面，单击该商品操作列的“详情”进入详情页查看。

order_id

M

String

64

订单号

amount

O

Integer

7

数量类型的商品定价属性
成功响应示例 
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": [
        {
            "license_code": "PL*****01",
            "status": "ALIVE",
            "activate_time": "20230519024731",
            "real_effect_time": "20230619024731",
            "expire_time": null,
            "product_name": null,
            "product_id": null,
            "order_id": null,
            "amount": null
        },
        {
            "license_code": "PL*****02",
            "status": "ALIVE",
            "activate_time": "20230519024731",
            "real_effect_time": "20230619024731",
            "expire_time": null,
            "product_name": null,
            "product_id": null,
            "order_id": null,
            "amount": null
        },
        {
            "license_code": "PL*****03",
            "status": "INVALID"
        },
        {
            "license_code": "PL*****04",
            "status": "INVALID"
        }
    ]
}

失败响应示例

HTTP/1.1 401 UnauthorizedContent-Type: application/json;charset=UTF-8Content-Length: lengthDate: response time 
{ 
    "error_code": "92020001", 
    "error_msg": "Unauthorized"
}
父主题： 接口列表

相关文档