## 获取用户单条信息(userRead) >[info] 场景说明:获取当前登录用户或指定用户信息,方便第三方平台(APP、小程序、ERP)建立用户关联数据,实现营销 ### 是否需要获取用户TOKEN `否` ***** ### 请求地址 ``` POST http://api.xxx.com/user/read ``` ### 公共请求参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | appid | string | 必须 | 平台提供的唯一APPID | | version | string | 必须 | 接口版本号,固定填:v3 | | sign\_type | string | 必须 | 签名类型,目前只支持md5 | | timestamp | string | 必须 | 发起时间戳,格式为:yyyy-mm-dd hh::ii::ss | | format | string | 必须 | 返回的数据格式,只支持json | | sign | string | 必须 | 请求参数的签名,请参考:[签名规则](signature.md) | | token | string | 必须 | 访问TOKEN | | params | string | 必须 | 请求参数的集合,除公共参数外,所有请求参数都必须放在这个参数中传递,json\_encode后送入 | 应用请求参数`params`格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | userid | integer | 可选 | 用户ID | | username | string | 可选 | 用户名 | | phone\_mob | string | 可选 | 用户手机号 | ``` 注意:如果三个参数都缺省,则获取的是当前登录用户的信息(必须为登录状态下) ``` ### 请求示例 ``` { "appid": "您的APPID", "version": "v3", "sign_type": "md5", "timestamp": "2020-8-10 12:00:00", "format": "json", "sign": "op0987yhjmngt54rtg2wgdfvcder2765", "params": { "userid": 3, "username": "buyer" } } ``` ***** ### 公共返回参数 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | code | integer | 必须 | 0=成功,其它值代表请求失败的错误代码,请参考:[公共错误码](response-code.md) | | message | string | 必须 | 请求成功/失败的描述信息 | | data | array | 必须 | 返回结果,如果没有指定用返回空 | 返回`data`参数格式 | 字段 | 类型 | 是否必填 | 描述 | | --- | --- | --- | --- | | userid | integer | 必须 | 用户ID | | username | string | 必须 | 用户名 | | nickname | string | 必须 | 用户昵称 | | email | string | 可选 | 用户电子邮箱 | | phone\_mob | string | 必须 | 用户手机号 | | portrait | string | 必须 | 用户头像 | | money | decimal | 必须 | 用户金钱余额 | | integral | integer | 必须 | 用户积分数 | | gender | integer | 必须 | 用户性别,0=保密,1=男,2=女 | | birthday | string | 可选 | 生日,格式:yyyy-mm-dd | | im\_qq | string | 可选 | 用户QQ | | last\_login | string | 可选 | 上次登录时间,格式:yyyy-mm-dd hh:ii:ss | | store\_id | integral | 可选 | 店铺ID,如果该用户是卖家有该值 | ### 返回数据示例 ``` { "code": 0, "message": "成功", "data": { "userid":3, "username":"buyer", "nickname":"", "email":"", "gender":0, "birthday":"2000-08-20", "phone_mob":"18987654356", "im_qq":"", "portrait":"http://www.xxx.com/data/system/default_user_portrait.gif", "last_login":"2020-08-20 10:01:26", "integral":0, "money":0 } } ```