激活码
# 创建新的激活码
* 只有渠道商账号允许创建激活码,客户端或服务端认证的用户填入对应渠道商账号的userId或userNo
请求路径:
`/openapi/activeCode/add`
请求方法:
`POST`
接口参数:
| 字段名 | 类型 | 必填 | 说明 |
| ------------ | ------------ | -----| ------------ |
| companyTaxNo | String |否 | 公司税号 |
| partnerStoreNo | String |否 | 第三方机器码或门店编号 |
注:
1.如果只填companyTaxNo,则该激活码只能用于该税号的公司创建使用。
2.如果只填partnerStoreNo,则公司创建时填写该激活码,那么公司注册后会自动创建对应门店。
请求参数示例:
```json
{
"partnerStoreNo":"1233"
}
```
响应结果:
| 字段名 | 类型 | 说明 |
| ------------ | ------------ | ------------ |
| code | Integer | 处理结果 |
| message | String | 结果描述 |
| data | Object | 激活码信息(ActiveCodeDTO) |
ActiveCodeDTO:
| 字段名 | 类型 | 说明 |
| ------------ | ------------ | ------------ |
| activeCode | String | 激活码 |
响应结果示例:
```json
失败:
{
"code": -1,
"message": "门店编码不合法"
}
成功:
{
"code": 0,
"data": "5U4S95"
}
```
# 查询激活码使用状态
查询激活码的使用详情,包括:激活时间、激活状态、过期时间。
注:该接口只允许服务端调用,签名参数中无需传入userId或userNo。
请求路径:
`/openapi/activeCode/get`
请求方式:
`GET`
接口参数:
| 参数 | 类型 | 是否必填 | 说明 |
| ------------ | ------------ | ------------ |------------ |
| activeCode | String | 是 | 激活码 |
请求示例:
`/openapi/activeCode/get?activeCode=Z4KS4H`
响应结果:
| 字段名 | 类型 | 说明 |
| ------------ | ------------ | ------------ |
| code | Integer | 处理结果 |
| message | String | 结果描述 |
| data | Object | 激活码信息(ActiveCodeDTO) |
ActiveCodeDTO:
| 字段名 | 类型 | 说明 |
| ------------ | ------------ | ------------ |
| activeCode | String | 激活码 |
| status | Integer | 激活状态【0:未使用;1:使用中;2:已失效 3.已生效 4.即将失效】 |
| activeTime | DateTime | 激活时间:2019-03-27 11:22:17 |
| endTime | DateTime | 结束时间:2019-03-27 11:22:17 |
| useTime | DateTime | 使用时间:2019-03-27 11:22:17 |
响应结果示例:
```json
失败:
{
"code": -1,
"message": "激活码不能为空。"
}
成功:
{
"code": 0,
"message": "success",
"data": {
"activeCode":"Z4KS4H",
"status":1,
"activeTime":"2019-03-27 11:22:17",
"endTime":"2099-12-31 23:59:59"
}
}
```