YesApi 接口文档

4201 创建JWT Token接口

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

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

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

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
subStringOptaionYesApi订阅的使用场景
uidStringOptaion授权的用户uid，可以是自定义的uid，也可以使用小白平台的uuid
expTimeIntOptaion86400MIN: 10有效时间，单位为：秒，默认一天内有效

API Usage Demo

HTTP 
请求：
{OKAYAPI_API_HOST}/?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"
}

API Response

KEYTypeDescription
jwt_tokenString新创建的JWT Token
YesApi 接口文档

4202 校验JWT Token接口

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

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

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

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
jwt_tokenStringRequired待校验的jwt Token

API Usage Demo

HTTP 
请求：
{OKAYAPI_API_HOST}/?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"
}

API Response

KEYTypeDescription
err_coceInt操作状态码，0校验成功，1校验失败
subString该JWT所面向的使用场景，失败时为空字符串
uidString用户ID，失败时为空字符串
expInt有效时间，这是一个Unix时间戳，失败时为0
YesApi 接口文档

4203 置换JWT Token接口

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

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

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

API Params

ParameterTypeRequiredDefaultNoteDescription
HTTP_APPKEYStringRequiredMIN: 32Common Put Your APPKEY
uuidStringRequiredMIN: 32；MAX: 32UUID，全局唯一用户ID，查看全部注册会员。
tokenStringRequiredMIN: 64；MAX: 64会话凭证，

API Usage Demo

HTTP 
请求：
/?=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"
}

API Response

KEYTypeDescription
jwt_tokenString新创建的JWT Token

Power by OkayAPI.com Contact us (WA: okayapi OR Email: chanzonghuang@gmail.com).
Timezone: America/New_York Jan/19/2025 16:59:07