[关闭]
@kyletiao 2016-03-18T13:12:22.000000Z 字数 8704 阅读 2320

U9云端用户中心使用文档 V0.3

账号中心 使用文档

（一）接口

所有输入值及返回值都以json字符串形式表现。
所有返回值格式固定，格式如下：

  1. {
  2.     "code":返回值代码（000000为正确，其他都是错误返回，错误码信息详见附录）,
  3.     "msg":信息,
  4.     "data":数据（json格式）
  5. }

1、登陆接口（仅供无法使用页面的移动端使用）

接口地址：
http://u9usercenter.yonyou.com/service/login
传入参数：

参数名称 字段名称 字段长度 是否必输
username 用户名 32 Y
password 密码 32 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{
  5.         "ticket":用户标识,
  6.         "timestap":时间戳,
  7.         "userinfo":{
  8.             "dis_name":显示名称,
  9.             "avatar":头像地址,
  10.             "wxid":微信id,
  11.             "email":邮箱,
  12.             "tel":电话
  13.         }
  14.     }
  15. }

2、注册用户接口（仅供单点登陆的注册页面使用）

接口地址：
http://u9usercenter.yonyou.com/account/register
传入参数：

参数名称 字段名称 字段长度 是否必输
tel 电话 32 Y
email 邮箱 64 Y
wxid 微信unionid 64 Y
dis_name 显示名称 64 Y
avatar 头像 64 N
password 密码 64 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5. }

3、批量注册用户接口

接口地址：
http://u9usercenter.yonyou.com/account/register4list

传入参数格式：

  1. [{
  2.     "tel":"电话"，
  3.     "email":"邮箱"，
  4.     "wxid":"微信unionid"，
  5.     "dis_name":"显示名称"，
  6.     "avatar":"头像"，
  7.     "password":"密码"
  8. }]

传入参数：

参数名称 字段名称 字段长度 是否必输
tel 电话 32 Y
email 邮箱 64 Y
wxid 微信unionid 64 Y
dis_name 显示名称 64 Y
avatar 头像 64 N
password 密码 64 Y

返回值：

  1. [{
  2.    "code":"000000"，
  3.    "msg":"ok"，
  4.    "data":{
  5.         "ticket":用户标识,
  6.         "timestap":时间戳,
  7.         "userinfo":{
  8.             "dis_name":显示名称,
  9.             "avatar":头像地址,
  10.             "wxid":微信id,
  11.             "email":邮箱,
  12.             "tel":电话
  13.         }
  14. },
  15. {
  16.     "code":"错误码"，
  17.     "msg":"错误提示"，
  18.     "data":{
  19.             "dis_name":显示名称,
  20.             "avatar":头像地址,
  21.             "wxid":微信id,
  22.             "email":邮箱,
  23.             "tel":电话
  24.     }
  25. },
  27. ]

4、用户是否存在校验（仅供单点登陆的注册页面使用）

接口地址：
http://u9usercenter.yonyou.com/account/checkusername
传入参数：

参数名称 字段名称 字段长度 是否必输
type 用户名类型（email邮箱/tel电话/wxid微信id） 32 Y
value 用户名值 64 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5. }

5、用户修改密码（仅供单点登陆的密码修改页面）

接口地址：
http://u9usercenter.yonyou.com/account/resetpassword
传入参数：

参数名称 字段名称 字段长度 是否必输
ticket 用户唯一标识 32 Y
oldpassowrd 原始密码 32 Y
password 新密码 32 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5. }

6、 判断用户是否登录及获取已登陆用户信

接口地址：
http://u9usercenter.yonyou.com/service/islogin
传入参数：

参数名称 字段名称 字段长度 是否必输
ticket 用户标识 32 Y

如果不录入参数，择取cookie中的ticket

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{
  5.         "ticket":用户标识,
  6.         "timestap":时间戳,
  7.         "userinfo":{
  8.             "dis_name":显示名称,
  9.             "avatar":头像地址,
  10.             "wxid":微信id,
  11.             "email":邮箱,
  12.             "tel":电话
  13.         }
  14.     }
  15. }

7、 用户登出

接口地址：
http://u9usercenter.yonyou.com/service/logout
传入参数：

参数名称 字段名称 字段长度 是否必输
ticket 用户标识 32 Y

如果不录入参数，择取cookie中的ticket

返回值：
返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5.     }
  6. }

8、 更改用户信息接口

接口地址：
http://u9usercenter.yonyou.com/account/setuserinfo
传入参数：

参数名称 字段名称 字段长度 是否必输
ticket 用户标识 32 Y
dis_name 用户显示名 32 Y
email 邮箱 64 Y
tel 手机 32 Y
avatar 用户头像地址 32 Y

如果不录入参数，择取cookie中的ticket

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5.     }
  6. }

9、 手机校验码发送

接口地址：
http://u9usercenter.yonyou.com/account/sendchekcode
传入参数：

参数名称 字段名称 字段长度 是否必输
tel 电话号码 32 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5.     }
  6. }

10、 验证手机校验码

接口地址：
http://u9usercenter.yonyou.com/account/viladatachekcode
传入参数：

参数名称 字段名称 字段长度 是否必输
tel 电话号码 32 Y
checkcode 手机校验码 32 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5.     }
  6. }

11、 找回密码邮件发送

接口地址：
http://u9usercenter.yonyou.com/account/sendpasswordemail
传入参数：

参数名称 字段名称 字段长度 是否必输
email 电子邮件 32 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5.     }
  6. }

12、 用户行为记录

接口地址：
http://u9usercenter.yonyou.com/actionlog/add
传入参数：

参数名称 字段名称 字段长度 是否必输
ticket 用户标识 32 Y
accountkey 应用标识 32 Y
action 动作描述 64 Y
action_des 动作描述 64 Y

如果不录入参数，择取cookie中的ticket

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5.     }
  6. }

13、 微信登录接口

接口地址：
http://u9usercenter.yonyou.com/wechat/login
传入参数：

参数名称 字段名称 字段长度 是否必输
code 微信登录界面返回code 32 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{
  5.         "ticket":用户标识,
  6.         "isregister":是否注册（1已经注册 0未注册）
  7.         "timestap":时间戳,
  8.         "userinfo":{
  9.             "dis_name":显示名称,
  10.             "avatar":头像地址,
  11.             "wxid":微信id,
  12.             "email":邮箱,
  13.             "tel":电话
  14.     }
  15.     }
  16. }

14、 用户补全信息接口

接口地址：
http://u9usercenter.yonyou.com/account/setpwdbyticket
传入参数：

参数名称 字段名称 字段长度 是否必输
ticket 用户标识 32 Y
dis_name 用户显示名 32 Y
email 邮箱 64 Y
tel 手机 32 Y
avatar 用户头像地址 32 Y
password 密码 32 Y

返回值：

  1. {
  2.     "code":"000000"，
  3.     "msg":"ok"，
  4.     "data":{}
  5. }

14、 批量查询用户信息接口

接口地址：
http://u9usercenter.yonyou.com/account/getuserinfolist
传入参数：

参数名称 字段名称 字段长度 是否必输
ticketlist 用户标识串，用“，”分割 32 Y

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.    "data":    [
  5.             {
  6.          "ticket": "27ed0fb950b856b06e1273989422e7d3",
  7.          "userinfo":          {
  8.             "tel": "1333333333785",
  9.             "email": "7851@qq.com",
  10.             "dis_name": "niming785",
  11.             "wxid": "wx1785",
  12.             "avatar": ""
  13.          }
  14.       },
  15.             {
  16.          "ticket": "6d70cb65d15211726dcce4c0e971e21c",
  17.          "userinfo":          {
  18.             "tel": "1333333333784",
  19.             "email": "7841@qq.com",
  20.             "dis_name": "niming784",
  21.             "wxid": "wx1784",
  22.             "avatar": ""
  23.          }
  24.       }
  25.    ]
  26. }

15、 添加u9网关信息接口

接口地址：
http://u9usercenter.yonyou.com/u9info/add
传入参数：

参数名称 字段名称 字段长度 是否必输
name u9网关标识 32 Y
netgate 网关地址 255 Y
port 网关端口 32 Y
customername 用户名称 32 Y

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.     "data":｛｝
  5. }

16、 修改u9网关信息接口

接口地址：
http://u9usercenter.yonyou.com/u9info/update
传入参数：

参数名称 字段名称 字段长度 是否必输
id u9网关记录id 32 Y
name u9网关标识 32 N
netgate 网关地址 255 N
port 网关端口 32 N
customername 用户名称 32 N

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.     "data":{}
  5. }

17、 删除u9网关信息接口

接口地址：
http://u9usercenter.yonyou.com/u9info/delete
传入参数：

参数名称 字段名称 字段长度 是否必输
id u9网关记录id 32 Y

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.     "data":{}
  5. }

18、 删除u9网关信息接口

接口地址：
http://u9usercenter.yonyou.com/u9info/delete
传入参数：

参数名称 字段名称 字段长度 是否必输
id u9网关记录id 32 Y

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.     "data":{}
  5. }

19、 列表显示u9网关信息接口

接口地址：
http://u9usercenter.yonyou.com/u9info/delete
传入参数：

参数名称 字段名称 字段长度 是否必输
where 匹配条件目前匹配name字段 32 N
currentPage 当前页码分页用 32 N
itemsPerPage 每页显示数量 32 N

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.     "data":[{
  5.         "id":"id",
  6.         "name":"U9网关标识",
  7.         "netgate":"网关地址",
  8.         "port":"网关端口",
  9.         "customername":"用户名称"
  10.     }]
  11. }

20、 添加u9用户对应网关信息接口

接口地址：
http://u9usercenter.yonyou.com/userroutes/add
传入参数：

参数名称 字段名称 字段长度 是否必输
ticket 用户唯一标识 32 Y
netgate 网关地址 255 Y
port 网关端口 32 Y

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.     "data":｛｝
  5. }

21、 修改u9用户对应网关信息接口

接口地址：
http://u9usercenter.yonyou.com/userroutes/update
传入参数：

参数名称 字段名称 字段长度 是否必输
id 用户唯一标识 32 Y
netgate 网关地址 255 Y
port 网关端口 32 Y

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.     "data":｛｝
  5. }

22、 删除u9用户对应网关信息接口

接口地址：
http://u9usercenter.yonyou.com/userroutes/delete
传入参数：

参数名称 字段名称 字段长度 是否必输
id 用户唯一标识 32 Y

返回值：

  1. {
  2.     "code": "000000",
  3.     "msg": "ok",
  4.     "data":[{
  5.         "id":"id",
  6.         "ticket":"用户标识",
  7.         "netgate":"网关地址",
  8.         "port":"网关端口"
  10.     }]
  11. }

23、获取所有u9用户对应网关信息接口

接口地址：
http://u9usercenter.yonyou.com/userroutes/getlist
传入参数：

参数名称 字段名称 字段长度 是否必输
ticket 用户唯一标识 32 Y

返回值：

  1. {
  2.    "code": "000000",
  3.    "msg": "ok",
  4.     "data":｛
  5.     ｝
  6. }

（二）接口校验

所有访问用户中心接口的链接都必须带上相关sign校验，相关校验规则如下：
接入的系统在接入之前需线下申请获得accoutkey作为介入应用的唯一标识。在访问接口的最末尾以get形式拼接参数。参数如下
accountkey：app的唯一key
timestap：unix时间戳
sign：sha1（accountkey＋timstap）

sign是通过sha1算法加密的accountkey和时间戳的字符串链 例子如下：
app1分配的accountkey为202cb962ac59075b964b07152d234b70
；当前时间戳为1446452796；那么需要加密的字符串为202cb962ac59075b964b07152d234b701446452796；通过sha1加密后得出结果04234f42cced998f043feb83377e757feebbc261；访问链接为http://server/login；经过参数拼接得出的访问地址为http://server/login？accountkey＝202cb962ac59075b964b07152d234b70&tiemstap＝1446452796&sign＝04234f42cced998f043feb83377e757feebbc261

sha1算法 java代码demo

  1. public static String SHA1(String decript) {
  2.         try {
  3.             MessageDigest digest = java.security.MessageDigest.getInstance("SHA-1");
  4.             digest.update(decript.getBytes());
  5.             byte messageDigest[] = digest.digest();
  6.             // Create Hex String
  7.             StringBuffer hexString = new StringBuffer();
  8.             // 字节数组转换为 十六进制 数
  9.             for (int i = 0; i < messageDigest.length; i++) {
  10.                 String shaHex = Integer.toHexString(messageDigest[i] & 0xFF);
  11.                 if (shaHex.length() < 2) {
  12.                     hexString.append(0);
  13.                 }
  14.                 hexString.append(shaHex);
  15.             }
  16.             return hexString.toString();
  18.         } catch (NoSuchAlgorithmException e) {
  19.             e.printStackTrace();
  20.         }
  21.         return "";
  22.     }

sha1算法 php代码demo

  1. <?php
  2.     sha1($strtemp);

sha1算法 c#代码demo

  1. public static string HashCode(string str)  
  2. {  
  3.     string rethash = "";  
  4.     try  
  5.     {  
  7.           System.Security.Cryptography.SHA1 hash = System.Security.Cryptography.SHA1.Create();  
  8.            System.Text.ASCIIEncoding encoder = new System.Text.ASCIIEncoding();  
  9.            byte[] combined = encoder.GetBytes(str);  
  10.            hash.ComputeHash(combined);  
  11.            rethash = Convert.ToBase64String(hash.Hash);  
  12.     }  
  13.     catch (Exception ex)  
  14.     {  
  15.            string strerr = "Error in HashCode : " + ex.Message;  
  16.     }  
  17.     return rethash;  
  18. }

js中处理sha1加密 可以在页面引用引用相关js的sha1加密库
用法

  1. <!DOCTYPE HTML>
  2. <html>
  3. <head>
  4. <meta charset="utf-8">
  5. <title>sha1加密</title>
  6. <script type="text/ecmascript" src="sha1.js"></script>
  7. <script type="text/javascript">
  8.   var sha = hex_sha1('mima123465')
  9.     alert(sha)   
  10. </script>  
  11. </head>
  13. <body>
  14. </body>
  15. </html>

（三）页面

1、登陆页面

页面地址：
http://u9usercenter.yonyou.com/login.html
get传入参数：

参数名称 字段名称 字段长度 是否必输
redirct 回调地址 Y

页面回调行为：
完成登陆后将回调redirct传入的地址。同时以get形式传入相关用户信息。
例如传入的redirct＝“http://www.baidu.com”，则运行后回调地址为http://www.baidu.com?ticket=xxxxxxx&dis_name=wanger&avatar＝http://123/1.png

回调传入参数如下

参数名称 字段名称 字段长度 是否必输
ticket 用户唯一标识 Y
dis_name 用户显示名 Y
avatar 头像地址 Y

2、注册页面

页面地址：
http://u9usercenter.yonyou.com/register.html
get传入参数：

参数名称 字段名称 字段长度 是否必输
redirct 回调地址 Y

页面回调行为：
完成注册后将回调redirct传入的地址。同时以get形式传入相关用户信息。
例如传入的redirct＝“http://www.baidu.com”，则运行后回调地址为http://www.baidu.com
回调传入参数如下
无

3、重置密码页面

接口地址：
http://u9usercenter.yonyou.com/resetpassword.html
get传入参数：

参数名称 字段名称 字段长度 是否必输
redirct 回调地址 Y

页面回调行为：
完成注册后将回调redirct传入的地址。同时以get形式传入相关用户信息。
例如传入的redirct＝“http://www.baidu.com”，则运行后回调地址为http://www.baidu.com

回调传入参数如下
无

4、更改用户信息页面

接口地址：
http://u9usercenter.yonyou.com/updateuserinfo.html
get传入参数：

参数名称 字段名称 字段长度 是否必输
redirct 回调地址 Y

页面回调行为：
完成注册后将回调redirct传入的地址。同时以get形式传入相关用户信息。
例如传入的redirct＝“http://www.baidu.com”，则运行后回调地址为http://www.baidu.com

回调传入参数如下
无

（附录一）账号登陆流程

  1. 在界面上添加登陆按钮，为登陆按钮添加点击事件，点击后跳转至登陆页面。为登录页面出入回调地址。
  2. 在调用登录接口时候 在cookie中写入相关用户的ticket。用户登录在服务端存储的信息有效期为2小时。
  3. 用户在登录页面上登录完成会跳转到相关回掉页面，并以get参数形式回传ticke、dis_name、avatar
  4. 所有调用的接口必须按照校验流程走，否则不通过。开放调试方式在接口中get传入参数debug=1，则跳过校验。
  5. 调用账户中心所有接口，必须传入参数为accoutkey，具体accountkey根据应用不同联系线下获取。

（附录二）错误码对照

错误码 信息
"000000" "ok"
"100001" "传入字段不完整"
"100002" "用户没有登录"
"100003" "ticket已经过期"
"100004" "缺少sign参数"
"100005" "sign校验失败"
"100006" "用户名或者密码错误"
"100007" "错误的类型"
"100008" "已经有的数据"
"100009" "缺少原始密码"
"100010" "缺少密码"
"100011" "原始密码输入错误"
"100012" "缺少输入参数"
"100013" "缺少用户名"
"100014" "缺少密码"
"100015" "短信发送不成功"
"100016" "验证码失效"
"100017" "验证码错误"
"100018" "邮件发送不成功"
添加新批注
在作者公开此批注前，只有你和作者可见。
回复批注