- 1、原创力文档(book118)网站文档一经付费(服务费),不意味着购买了该文档的版权,仅供个人/单位学习、研究之用,不得用于商业用途,未经授权,严禁复制、发行、汇编、翻译或者网络传播等,侵权必究。。
- 2、本站所有内容均由合作方或网友上传,本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺!文档内容仅供研究参考,付费前请自行鉴别。如您付费,意味着您自己接受本站规则且自行承担风险,本站不退款、不进行额外附加服务;查看《如何避免下载的几个坑》。如果您已付费下载过本站文档,您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等,请点击“版权申诉”(推荐),也可以打举报电话:400-050-0827(电话支持时间:9:00-18:30)。
- 4、该文档为VIP文档,如果想要下载,成为VIP会员后,下载免费。
- 5、成为VIP后,下载本文档将扣除1次下载权益。下载后,不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后,您将拥有八大权益,权益包括:VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传,每下载1次, 网站将根据用户上传文档的质量评分、类型等,对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
1文档说明
该文档用于描述一米APP前各类接口明细,包括:用户、用户登录、用户信
息获取等。本文档适用阅读人群:设计人员、前端APP开发工程师、服务端开发工程
师
2接口说明
一米APP接口采用RESTFUL方式提供,APP前端使用HTTP请求接口,接口返回采用
JSON格式传递。
后端服务返回JSON格式的字符串,格式如下:
{
“result_code”:1
}
3通用说明
3.1用户认证头
需要登录才能的一米APP前端对后端服务接口请求都需要携带用户认证头,认证
头放置在请求HTTP的head部分提交至后端服务,后端服务对认证头进行校验,校验
成功继续接口请求,失败则返回认证失败。
3.1.1请求参数
参数字段必选字段类型字段说明
uidtrueString用户ID
osVersiontrueString安卓:MI3Android4.4.4
IOS:iphone6plus
timeStamptruelong时间戳,当前时间
sysVersiontrueStringAppversionName
terminalNotrueString设备号
accessTokentruestring登录用户的令牌,
请查看生成规则
采用Restful方式的HTTP接口,状态使用令牌(Token)方式实现。
accessToken按生成规则由客户端来生成,服务端按生成规则重新验证accessToken
accessToken生成规则如下:
accessToken=md5(uid+sysVersion+timeStamp+key+request);
注意:参数全部转成大写,再进行md5加密
约定key:”@#$yimikey%@”(暂定)
请求地址request:”/user/update.json”
3.2通用错误返回
当接口请求处理出错时,接口会返回通用的错误返回格式。
3.2.1返回格式
{
“request”:”/user/update.json”,
“returnCode:”20001”,
“msg”:”NeedMobileNo”
}
3.2.2错误代码说明
200012000120001
服务级错误(1为系统级服务模块代码具体错误代码
错误)
3.2.3错误代码对照表
查看错误代码
4详细接口
4.1用户模块(00)
用户模块接口提供一米用户的管理接口,如用户、用户登录等功能。
模块代码:00
URL规则:%domain%/mobile/user/%interfacename%
4.1.1获取
时发送动态至用户指定,用于验证号码的有效性
请求URL
%domain%/mobile/user/getDynamicCode.json
HTTP请求方式
GET
是否需要登录
否
请求参数
参数字段是否必选字段类型
文档评论(0)