YesApi 接口文档

4201 创建JWT Token接口

接口路径(新)：http://api.yesapi.net/api/App/Common_Jwt/ApplyToken

接口路径(旧)：http://api.yesapi.net/?s=App.Common_Jwt.ApplyToken

接口描述： 创建一个新的JWT Token，创建时可以指定用户id、订阅的使用场景以及有效时间。适用于未登录小白开放平台的会员。

接口参数 若无特殊说明，接口参数同时支持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表示不允许。
sub字符串可选YesApi订阅的使用场景
uid字符串可选授权的用户uid，可以是自定义的uid，也可以使用小白平台的uuid
expTime整型可选86400最小：10有效时间，单位为：秒，默认一天内有效

客户端请求示例

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

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


# 【 4201 创建JWT Token接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Jwt.ApplyToken`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  创建一个新的JWT Token，创建时可以指定用户id、订阅的使用场景以及有效时间。适用于未登录小白开放平台的会员。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Common_Jwt.ApplyToken` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| sub | string | 可选 | 订阅的使用场景 |
| uid | string | 可选 | 授权的用户uid，可以是自定义的uid，也可以使用小白平台的uuid |
| expTime | int | 可选 | 有效时间，单位为：秒，默认一天内有效 |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.jwt_token | string | 新创建的JWT Token|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Jwt.ApplyToken&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.Common_Jwt.ApplyToken&sub=YesApi&uid=123456&expTime=86400&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC93d3cueWVzYXBpLmNuIiwiYXVkIjoiaHR0cDpcL1wvYXBpLnllc2FwaS5jbiIsInN1YiI6Illlc0FwaSIsInVpZCI6IjEyMzQ1NiIsImlhdCI6MTU2OTQ4MzM1MiwiZXhwIjoxNTY5NTY5NzUyfQ.yP8-CSin9IK-xumj8QhO1rVErm4sX8HL2WvU2Qm5y5k"
    },
    "msg": "小白开放接口：App.Common_Jwt.ApplyToken"
}

接口返回

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

4202 校验JWT Token接口

接口路径(新)：http://api.yesapi.net/api/App/Common_Jwt/VerifyToken

接口路径(旧)：http://api.yesapi.net/?s=App.Common_Jwt.VerifyToken

接口描述： 对JWT Token进行检验，并返回相应的信息数据，包括uid、有效时间exp和使用场景sub。

接口参数 若无特殊说明，接口参数同时支持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表示不允许。
jwt_token字符串必须待校验的jwt Token

客户端请求示例

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

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


# 【 4202 校验JWT Token接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Jwt.VerifyToken`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  对JWT Token进行检验，并返回相应的信息数据，包括uid、有效时间exp和使用场景sub。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Common_Jwt.VerifyToken` |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|
| jwt_token | string | 必填 | 待校验的jwt Token |


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.err_coce | int | 操作状态码，0校验成功，1校验失败|
| data.sub | string | 该JWT所面向的使用场景，失败时为空字符串|
| data.uid | string | 用户ID，失败时为空字符串|
| data.exp | int | 有效时间，这是一个Unix时间戳，失败时为0|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Jwt.VerifyToken&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.Common_Jwt.VerifyToken&jwt_token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC93d3cueWVzYXBpLmNuIiwiYXVkIjoiaHR0cDpcL1wvYXBpLnllc2FwaS5jbiIsInN1YiI6Illlc0FwaSIsInVpZCI6IjEyMzQ1NiIsImlhdCI6MTU2OTQ4MzM1MiwiZXhwIjoxNTY5NTY5NzUyfQ.yP8-CSin9IK-xumj8QhO1rVErm4sX8HL2WvU2Qm5y5k&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "sub": "YesApi",
        "uid": "123456",
        "exp": 1569569752
    },
    "msg": "小白开放接口：App.Common_Jwt.VerifyToken"
}

接口返回

返回字段类型说明
ret整型接口状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务端异常，查看异常错误码
dataobject/array/混合接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当return_data=1时，接口只会返回此data字段。
data.err_coce整型操作状态码，0校验成功，1校验失败
data.sub字符串该JWT所面向的使用场景，失败时为空字符串
data.uid字符串用户ID，失败时为空字符串
data.exp整型有效时间，这是一个Unix时间戳，失败时为0
msg字符串提示信息，面向技术人员的帮助或错误提示信息
_t整数服务器当时Unix时间戳，例如：1657513450
_auth字符串反向数字签名，可用于客户端进行反向验证，防止数据篡改，例如：9bcd54ff53e71a1d80d37c52bdfabf76。验证算法：_auth = md5(data返回的JSON字符串 + _t当前时间戳字符串 + APP_SECRECT密钥字符串)，若需要关闭或开启请提交工单
YesApi 接口文档

4203 置换JWT Token接口

接口路径(新)：http://api.yesapi.net/api/App/Common_Jwt/ExchangeToken

接口路径(旧)：http://api.yesapi.net/?s=App.Common_Jwt.ExchangeToken

接口描述： 适用于已经登录小白开放平台的用户，通过将小白开放平台的uuid+token置换成jwt_token。成功置换后，uid为小白的UUID，sub固定为YesApiET，有效时间为当前小白会话的有效时间。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小：32公共参数 开发者应用的app_key，点击查看，或免费注册。
sign字符串可选公共参数接口签名，其中：
  1. 关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。
  2. 静态签名，简单，固定的签名，点击获取。
  3. 动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。
  4. 定制签名，支持个性化签名签名算法定制。
uuid字符串必须最小：32；最大：32UUID，全局唯一用户ID，查看全部注册会员。
token字符串必须最小：64；最大：64会话凭证，
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表示不允许。

客户端请求示例

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

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


# 【 4203 置换JWT Token接口】接口文档
**所属平台**: YesApi果创云
**接口地址**: `http://`你的API接口域名`/?s=App.Common_Jwt.ExchangeToken`
**请求方式**: POST/GET

## 接口基本信息
- **功能描述**:  适用于已经登录小白开放平台的用户，通过将小白开放平台的uuid+token置换成jwt_token。成功置换后，uid为小白的UUID，sub固定为YesApiET，有效时间为当前小白会话的有效时间。
- **返回格式**: JSON

## 请求参数说明

### 系统参数（使用Query传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|--------|
| s | string | 必填 | 接口服务名，固定为`App.Common_Jwt.ExchangeToken` |
| app_key | string | 必填 | 应用key，传入`你的app_key` |
| sign | string | 可选 | 公共参数接口签名，其中：                  关闭签名，默认，不需要签名，在接口签名设置关闭或开启接口签名。         静态签名，简单，固定的签名，点击获取。         动态签名，复杂，安全系数高，获取密钥，教程：如何生成签名，下载SDK开发包，在线测试对比签名。         定制签名，支持个性化签名签名算法定制。          |
| uuid | string | 必填 | UUID，全局唯一用户ID，查看全部注册会员。 |
| token | string | 必填 | 会话凭证， |
| 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传递）
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|


## 返回字段

| 返回字段	| 类型	| 说明 |
|--------|------|------|
| ret	| int | 接口状态码，`200`表示成功，`4xx`表示客户端非法请求，`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据，由不同的API接口决定不同的数据返回字段和结构。当`return_data=1`时，接口只会返回此`data`字段。|
| msg | 字符串 | 提示信息，面向技术人员的帮助或错误提示信息，成功返回时为空字符串 |
| data.jwt_token | string | 新创建的JWT Token|


## 请求示例

```bash
curl -X POST "http://`你的API接口域名`/?s=App.Common_Jwt.ExchangeToken&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参数错误"
}
```
请求：
/?=App.Common_Jwt.ExchangeToken&uuid=8AEA2AF1951C0376EC668A74B8CAA64A&token=56C12A5458793E90E183C64D50D318E450EF7E2F9D413E35645D99662867D41B&app_key={你的app_key}&sign={接口签名}

返回：
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "jwt_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwOlwvXC93d3cueWVzYXBpLmNuIiwiYXVkIjoiaHR0cDpcL1wvYXBpLnllc2FwaS5jbiIsInN1YiI6Illlc0FwaUVUIiwidWlkIjoiOEFFQTJBRjE5NTFDMDM3NkVDNjY4QTc0QjhDQUE2NEEiLCJpYXQiOjE1Njk0ODM3NzIsImV4cCI6MTY1MDU0NzY3OH0._5MjjbWtii7IFqXB0RfMiBOOoPPCPvUUjoiOoYRIHss"
    },
    "msg": "小白开放接口：App.Common_Jwt.ExchangeToken"
}

接口返回

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

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