• 小白接口
  • 我的API
    • MyAPI(接口DIY,中文接口编程)
    • 私人定制API(由平台开发)
    • API在线测试
    • 免费创建我的接口
  • 应用API
    • 会员模块 重要
    • 配置模块
    • 数据统计模块
    • 日志模块
    • CDN图片文件模块
    • 邮件服务模块
    • 图形验证码模块
    • 微信集成模块
    • 短链接模块
  • 数据库API
    • 表单数据接口 [通用版] 开发必备
    • 表单结构API
    • 程序化数据API
    • MySQL/PostgreSQL API [直连版]
    • Sql Server API [数据库配置]
    • Sql Server API [存储过程]
    • Sql Server API [数据库操作]
  • 常用API
    • 二维码模块
    • 条形码模块
    • 会员头像模块
    • IP服务模块
    • 拼音模块
    • 昵称API
    • 密码API
    • 模拟数据API
    • 日期API
    • 唯一ID生成API
    • 快递API
    • 加解密API
    • JWT认证授权API
    • 中文分词API
    • 简繁体转换API
  • 教程
  • 登录
  • 注册



果创云开放接口

4201 创建JWT Token接口 查看接口详情

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

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

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

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • 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,欢迎使用小白开放接口!"}。
sub字符串可选YesApi订阅的使用场景
uid字符串可选授权的用户uid,可以是自定义的uid,也可以使用小白平台的uuid
expTime整型可选86400最小:10有效时间,单位为:秒,默认一天内有效

客户端请求示例

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

HTTP通用示例
请求:
{你的接口域名}/?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密钥字符串)

果创云开放接口

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。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • 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,欢迎使用小白开放接口!"}。
jwt_token字符串必须待校验的jwt Token

客户端请求示例

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

HTTP通用示例
请求:
{你的接口域名}/?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密钥字符串)

果创云开放接口

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,有效时间为当前小白会话的有效时间。

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

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名,点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串必须最小:32;最大:32UUID,全局唯一用户ID,查看全部注册会员。
token字符串必须最小:64;最大:64会话凭证,
return_data字符串可选0公共参数 数据返回结构,其中:
  • 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,欢迎使用小白开放接口!"}。

客户端请求示例

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

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"
}

返回结构说明

返回字段类型说明
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 | API低代码开发平台
零基础、低代码、接口稳定、自助快速开发


新手引导

1. 免费注册开发者
2. 创建一个新表单
3. 创建新数据API
4. SDK/客户端接入

产品

YesApi 果创云
YesApi 小白接口
YesApi 数据库大全
YesApi 接口大师
YesDev 项目管理

关于

用户服务协议

联系我们

合作:
huangchanzong@yesapi.cn
QQ群:1013085889(闲) 工作时间:09:00-18:00 (周一至周五) 地址:广州市黄埔区光谱中路11号云升科学园B1栋11层

微信咨询 客户经理

友情链接: 果创云 | YesDev项目管理 | PhalApi专业版 | PhalApi | ApiAdmin | 开发者工具 | 出海游戏SDK | 贝特游戏SDK
©2017-2023 V3.3.0 小白接口 果创云 YesApi.cn (原OkayApi.com) 广州果创网络科技有限公司 All Rights Reserved.