小白接口
接口地址:http://api.yesapi.cn/?s=App.User.Login
接口描述: 热门 根据账号和md5后的密码进行会员登录
接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签
在线测试
添加收藏
直接访问接口
我要调整此接口
接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。
参数名字 | 参数类型 | 是否必须 | 默认值 | 备注 | 参数说明 |
app_key | 字符串 | 必须 | | 最小:32 | 公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。 |
sign | 字符串 | 可选 | | | 公共参数 动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包。
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。
企业版支持专属签名算法定制。 |
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"} ;
- return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:
{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"} 。
|
username | 字符串 | 必须 | | 最小:1;最大:50 | 会员账号,开发者应用的会员,非开发者自己账号。进入会员列表可查看自己的应用会员。 |
password | 字符串 | 必须 | | 最小:32;最大:32 | MD5后的密码,须md5后传递,保持全部小写,MD5加密工具 |
is_allow_many | 布尔型 | 可选 | true | | 是否允许多设备同时登录,true/yes/1 表示:是,false/no/0 表示:否,不允许时会注销已登录的会话状态。 |
client | 字符串 | 可选 | | 最大:30 | 客户端,可用于纪录登录时的设备、版本或应用信息 |
在线测试
客户端请求示例
查看我的接口域名、app_key和app_secrect
客户端接入指南(如何生成签名)
开启/关闭签名
请求:
{你的接口域名}/?s=App.User.Login&username=xxx&password={md5后的密码}&app_key={你的app_key}&sign={动态签名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"uuid": "6C227C5775E547105BBD3D49756C850A",
"token": "7AFD8AFB86C3651E14228CAE1EA5E462C8148199C8ED860BE7B12890D08090E7"
},
"msg": ""
}
<?php
// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';
// 调用小白开放接口
$rs = OkayApiClient::request('App.User.Login', array('username' => 'AAA','password'=>'ba8c8eef2ce4a75eb264485baabbf6ae'));
// 输出结果
print_r($rs);
/*
Array
(
[ret] => 200
[data] => Array
(
[err_code] => 0
[err_msg] =>
[uuid] => 5DDC99652BE5C698411400CC693802A1
[token] => A6AEF88DC84DF8E01B992E9756CCAE49C9403D2B0FC1588A7617FF64235DA9CF
)
[msg] => 小白开放接口:App.User.Login
)
*/
接口使用帮助说明
小白君正在拼命补充中……
返回结构说明
返回字段 | 类型 | 说明 |
ret | 整型 | 接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码 |
data.err_code | 整型 | 操作码,0登录成功,1登录失败,账号不存在;2登录失败,密码错误;3会员已过期,请联系管理员或开发者;4账号已被封号 |
data.err_msg | 字符串 | 错误提示信息,err_code非0时参考此提示信息 |
data.uuid | 字符串 | 全局唯一UUID,全局唯一用户ID |
data.token | 字符串 | 登录凭证,一个月内有效 |
msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息 |
ret异常错误码
错误码 | 错误类型 | 错误描述信息 | 解决方法 |
ret = 200 | 成功 | 请求成功 | |
ret = 400 | 客户端非法请求 | 非法请求,参数错误 | 1、根据接口文档的接口参数,提供正确的参数 |
ret = 404 | 客户端非法请求 | 接口服务不存在 | 1、查看小白接口大全,确保接口服务名称拼写正确 |
ret = 500 | 小白接口异常 | 如果出现此错误,请联系技术人员处理 | 1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复 |
ret = 401 | 客户端非法请求 | 用户未登录,或登录凭证已过期 | 1、如果用户未注册,请先用注册接口;2、如果注册未登录或会话过期,请先用登录接口 |
ret = 406 | 客户端非法请求 | 非法app_key,请核对你所在的接口域名 | 1、在我的套餐查看并核对接口域名 |
ret = 407 | 客户端非法请求 | 当前应用已过期 | 1、进行续费或续约,延长应用有效期 |
ret = 408 | 客户端非法请求 | 当前应用存在异常,已被封号 | 1、联系在线客服人工处理 |
ret = 409 | 客户端非法请求 | 签名错误 | 1、使用在线测试,校正签名;2、关闭特定或全部签名设置;3、如果过期,可以进行续约/升级 |
ret = 410 | 客户端非法请求 | 权限不足,非系统管理员 | 1、应用权限不足,可联系在线客服咨询沟通 |
ret = 411 | 客户端非法请求 | 权限不足,应用管理员未登录 | 1、请提供应用管理员的admin_uuid和admin_token参数后重试 |
ret = 412 | 客户端非法请求 | 权限不足,非应用管理员 | 1、请在果创云把会员设置为管理员 |
ret = 413 | 客户端非法请求 | 本月接口流量超出,已被临时冻结 | 1、开通接口流量叠加包,或升级套餐 |
ret = 414 | 客户端非法请求 | 并发过高 | 1、请降低请求频率,检测是否有死循环调用,或是否被他人恶意使用。如果流量确实很大,可联系在线客服进行定制化或私有云部署。 |
ret = 415 | 客户端非法请求 | 接口已被开发者关闭 | 1、接口已被开发者关闭,请进入果创云接口开关重新开启 |
ret = 416 | 客户端非法请求 | 权限不足,个人免费版套餐无法使用专业版接口 | 1、请先升级终身会员/标准版/旗舰版/企业版 |
常见问题FAQ
Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。