小白接口

2008 获取会员个人资料接口 App.User.Profile

接口地址:http://api.yesapi.cn/?s=App.User.Profile

接口描述: 获取用户自己的账号/昵称、注册时间以及是否为管理员、扩展信息等信息

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签  登录

请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON

在线测试    添加收藏    直接访问接口    我要调整此接口


接口参数 若无特殊说明,接口参数同时支持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"}
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}

在线测试

参数是否必填
s 必须
uuid 必须
token 必须
return_data 可选

客户端请求示例

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

请求:
{你的接口域名}/?s=App.User.Profile&uuid=6C227C5775E547105BBD3D49756C850A&token=7AFD8AFB86C3651E14228CAE1EA5E462C8148199C8ED860BE7B12890D08090E7&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "info": {
            "uuid": "6C227C5775E547105BBD3D49756C850A",
            "username": "test",
            "role": "user",
            "rolename": "普通会员",
            "register_time": "2017-11-10 22:39:15",
            "register_ip": "120.25.156.74",
            "ext_info": {
                "nickname": "dogstar",
                "age": 19
            }
        }
    },
    "msg": ""
}
<?php

// 引入文件
require_once dirname(__FILE__) . '/OkayApiClient.php';

// 调用小白开放接口
$uuid='E7FA3ED38345FBD3367711E61FE4E2FC';
$token='66493A11E1EB97BA438023527F93CFB35AABBF5DB0386F1EBCF76266080B13A7';
$rs = OkayApiClient::request('App.User.Profile', array('uuid' => $uuid,'token'=>$token));

// 输出结果
print_r($rs);


/*
Array 
( 
	[ret] => 200
    [data] => Array
     ( 
     	[err_code] => 0 
        [err_msg] => 
        [info] => Array 
        ( 
        	[uuid] => E7FA3ED38345FBD3367711E61FE4E2FC 
            [username] => 小白 
            [role] => user 
            [rolename] => 管理员 
            [register_time] => 2019-02-02 22:24:18 
            [register_ip] => 120.229.171.203 
            [ext_info] => Array ( ) 
          )
       ) 
       
      [msg] => 小白开放接口:App.User.Profile 
)
*/

接口使用帮助说明

小白君正在拼命补充中……

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型操作码,0正常获取,1用户不存在,或者已被封号
data.err_msg字符串错误提示信息,err_code非0时参考此提示信息
data.info.uuid字符串全局唯一UUID,全局唯一用户ID,注册成功时返回
data.info.username字符串账号/昵称
data.info.role字符串用户角色(user/admin)
data.info.rolename字符串用户角色说明(普通用户/管理员)
data.info.register_time字符串注册时间,示例:2018-01-20 15:00:00
data.info.register_ip字符串注册IP,示例:192.168.1.1
data.info.ext_info对象用户扩展信息,开发者可以自定义存放更多用户信息,如:昵称、头像、年龄、性别等。以yesapi_开头的扩展字段,属于小白开放平台维护的信息。其中,yesapi_avatar是会员头像链接。
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链接里面去掉。