YesApi 接口文档

6801 生成数量卡密接口

接口路径(新)：http://hn.api.yesapi.net/api/App/Market_KamiNum/Generate

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Market_KamiNum.Generate

接口描述： 生成单个或多个数量卡密。注意，当卡密生成过多时，有可能批量生成的数量不足于指定的数量，建议卡密长度设置长一点，避免碰撞。当不足时，再次请求接口进行生成。使用前请先安装卡密插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构，其中：
  1. return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  2. return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求，1表示允许，0表示不允许。
num整型可选1最小：1；最大：1000需要生成的卡密数量
kami_num整型必须最小：1奖励数量
kami_type字符串必须最大：64卡密类型
kami_desc字符串必须卡密说明，支持富文本
kami_note字符串可选卡密备注
kami_min_len整型可选6最小：6卡密的最小字符长度
kami_max_len整型可选6最小：6；最大：100卡密的最大字符长度
kami_prefix字符串可选最大：10卡密前缀，如：kami_prefix=100，支持任意字符，不占用长度

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词HTTP通用示例 
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 6801 生成数量卡密接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_KamiNum.Generate`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  生成单个或多个数量卡密。注意，当卡密生成过多时，有可能批量生成的数量不足于指定的数量，建议卡密长度设置长一点，避免碰撞。当不足时，再次请求接口进行生成。使用前请先安装卡密插件
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Market_KamiNum.Generate` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| num | int | 可选 | 需要生成的卡密数量 |
| kami_num | int | 必填 | 奖励数量 |
| kami_type | string | 必填 | 卡密类型 |
| kami_desc | string | 必填 | 卡密说明，支持富文本 |
| kami_note | string | 可选 | 卡密备注 |
| kami_min_len | int | 可选 | 卡密的最小字符长度 |
| kami_max_len | int | 可选 | 卡密的最大字符长度 |
| kami_prefix | string | 可选 | 卡密前缀，如：kami_prefix=100，支持任意字符，不占用长度 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0表示成功，9表示插件未安装|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.kami_list | array | 返回成功创建的卡密列表|
| data.kami_list[].kami | string | 新的卡密|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_KamiNum.Generate&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```
请求：
{你的接口域名}/?s=App.Market_KamiNum.Generate&num=2&kami_num=3&kami_type=test&kami_desc=测试&kami_min_len=6&kami_max_len=6&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "kami_list": [
            "vkqCuc",
            "mNvnBD"
        ]
    },
    "msg": "小白开放接口：App.Market_KamiNum.Generate"
}

接口返回

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，9表示插件未安装
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.kami_list字符串返回成功创建的卡密列表
data.kami_list[].kami字符串新的卡密
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

6802 使用数量卡密接口

接口路径(新)：http://hn.api.yesapi.net/api/App/Market_KamiNum/Take

接口路径(旧)：http://hn.api.yesapi.net/?s=App.Market_KamiNum.Take

接口描述： 根据数量卡密，判断是否存在，是否已使用，成功使用时返回卡密的相关信息。使用前请先安装卡密插件

接口参数 若无特殊说明，接口参数同时支持GET和POST传递；推荐：查询/删除用GET，创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
uuid字符串可选公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选公共参数 数据返回结构，其中：
  1. return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；
  2. return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。
yesapi_allow_origin整型可选0公共参数 是否允许跨域请求，1表示允许，0表示不允许。
kami字符串必须最小：6卡密

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

AI提示词HTTP通用示例 
我的客户端是【XXX】，需求是【XXX】，app_key是【XXX】，请根据以下接口文档，完成API接入。


# 【 6802 使用数量卡密接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Market_KamiNum.Take`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  根据数量卡密，判断是否存在，是否已使用，成功使用时返回卡密的相关信息。使用前请先安装卡密插件
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Market_KamiNum.Take` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 可选 | 公共参数 UUID，当前登录的应用会员ID，即全局唯一用户ID，查看我的应用会员。传递此参数后，可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。 |
| token | string | 可选 | 公共参数 当前登录会员的会话凭证，可通过会员登录接口获得。uuid需要和token一起传递。 |
| return_data | string | 可选 | 公共参数 数据返回结构，其中：         return_data=0，返回完整的接口结果，示例：{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi，欢迎使用小白开放接口！"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"}；         return_data=1，返回简洁的接口结果，只返回data字段，结构简化一级，更扁平，示例：{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi，欢迎使用小白开放接口！"}。          |
| yesapi_allow_origin | int | 可选 | 公共参数 是否允许跨域请求，1表示允许，0表示不允许。 |


### 业务参数（使用POST或Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| kami | string | 必填 | 卡密 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_code | int | 操作码，0表示成功，1表示卡密不存在，2表示卡密已使用，9表示插件未安装|
| data.err_msg | string | 错误提示信息，err_code非0时参考此提示信息|
| data.kami_detail | object | 卡密的相关信息|
| data.kami_detail.kami | string | 卡密|
| data.kami_detail.kami_type | string | 卡密类型|
| data.kami_detail.kami_desc | string | 卡密描述|
| data.kami_detail.kami_num | int | 卡密数量|
| data.kami_detail.kami_note | string | 卡密备注|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Market_KamiNum.Take&app_key=YOUR_APP_KEY" \
  -H "Content-Type: application/json;charset=UTF-8" \
  -d "YOUR_POST_DATA_JSON"
```

成功返回示例（ret=200表示成功请求，data为成功后的业务数据）：
```json
{
    "ret": 200,
    "data": `成功返回的业务数据`,
    "msg": ""
}
```

失败返回示例：
```json
{
    "ret": 400,
    "data": [],
    "msg": "客户端非法请求：xxx参数错误"
}
```
请求：
{你的接口域名}/?s==App.Market_KamiNum.Take&kami=mNvnBD&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 2,
        "err_msg": "卡密已使用",
        "kami_detail": {
            "kami": "mNvnBD",
            "kami_type": "test",
            "kami_desc": "测试",
            "kami_num": 3,
            "kami_note": ""
        }
    },
    "msg": "小白开放接口：App.Market_KamiNum.Take"
}

接口返回

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_code整型操作码，0表示成功，1表示卡密不存在，2表示卡密已使用，9表示插件未安装
data.err_msg字符串错误提示信息，err_code非0时参考此提示信息
data.kami_detail对象卡密的相关信息
data.kami_detail.kami字符串卡密
data.kami_detail.kami_type字符串卡密类型
data.kami_detail.kami_desc字符串卡密描述
data.kami_detail.kami_num整型卡密数量
data.kami_detail.kami_note字符串卡密备注
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单

由 果创云YesApi.cn 提供技术支持，4万+开发者都在用，累计API调用1,800,000＋万次