feidai API

来源:互联网 发布:数据库安全性 编辑:程序博客网 时间:2024/05/17 22:39

feidai API


  • feidai API
    • 登陆注册
      • 注册
      • 登录
      • 找回密码
    • 个人中心
      • 退出登录
      • 获取个人信息
      • 个人信息修改
    • 公司简介
      • 获取公司简介
    • 产品介绍
      • 获取产品列表
      • 获取产品详情
    • 消息中心
      • 获取消息列表
      • 获取消息详情
    • 通话记录备份
      • 上传通话记录
    • 通讯录备份
      • 上传通讯录
    • GPS定位
      • 上传GPS定位
    • 错误代码

【注: 所有的请求都有status,表示是否请求正确应答,当status为fail(字符串)时,则一定带有message(错误代码),message(错误代码对应表在最后面)】

登陆注册


注册

url:
/user/register
请求格式:
GET
请求参数

字段类型说明phonestring手机号,注意校验是否为手机号,尤其是长度不能超passwordstring密码,同样不能过长namestring姓名,注意校验是否为手机号,尤其是长度不能超genderboolean性别,男true,女false。



返回结果

{    "status":"success"/"fail"}

登录

url:
/user/login
请求格式:
GET
请求参数

字段类型说明phonestring手机号,注意校验是否为手机号,尤其是长度不能超passwordstring密码,同样不能过长,可以使用md5简单加密


返回结果

{    "status":"success"/"fail",    "token":"456gdfgwer3r235354",    "userId":"zhangsan"}

找回密码

url:
/user/findPassword
请求格式:
GET
请求参数

字段类型说明phonestring手机号,注意校验是否为手机号,尤其是长度不能超passwordstring密码,同样不能过长,可以使用md5等简单加密



返回结果

{    "status":"success"/"fail",    "token":"456gdfgwer3r235354",    "userId":"zhangsan"//用户id,与校验码一起}注:token为校验码,与userId协同校验



个人中心


退出登录

退出登录无需请求
注:退出登录success后,清除保存的token和userId


获取个人信息

url:
/user_info
请求格式:
GET
请求参数

字段类型说明tokenstring校验码userIdstring用户id



返回结果

{    "status":"success"/"fail",    "gender":true/false,    "phone":"15800000000",    "name":"zhangsan"}注:gender的true为男,false为女

个人信息修改

url:
/user_info/modify
请求格式:
GET
请求参数

字段类型说明phonestring手机号,注意校验是否为手机号,尤其是长度不超 15tokenstring校验码userIdstring用户id



返回结果

{    "status":"success"/"fail"}

公司简介


获取公司简介

url:
/company_info/detail
请求格式:
GET
请求参数

字段类型说明tokenstring校验码,同样不能过长userIdstring用户id



返回结果

{    "status":"success"/"fail",    "title":"公司标题",    "logo":"http://xxx.jpg",        "photos": [             { "url":"图片地址","text":"图片描述"},            { "url":"图片地址","text":"图片描述"}    ],    "content":"公司详情描述文字"}

产品介绍


获取产品列表

url:
/product/info/list
请求格式:
GET
请求参数

字段类型说明tokenstring校验码,同样不能过长userIdstring用户id



返回结果

{    "status":"success"/"fail",    "products":[        {"id":"234sdfwer23rf",        "title":"产品标题",        "thumbnail":"http://xxx.jpg (前面的缩略图)",        "summary":"产品简介"},        {"id":"234sdfwer23r1f",        "title":"产品标题",        "thumbnail":"http://xxx.jpg (前面的缩略图)",        "summary":"产品简介"}    ]}

获取产品详情

url:
/product/detail/{productId} 这里的productId对应上面products中的id
请求格式:
GET
请求参数

字段类型说明tokenstring校验码,同样不能过长userIdstring用户id



返回结果

{    "status":"success"/"fail",    "title":"产品标题",    "photos": [             { "url":"图片地址","text":"图片描述"},            { "url":"图片地址","text":"图片描述"}    ],    "content":"公司详情描述文字"}

消息中心


获取消息列表

url:
/message/info/list
请求格式:
GET
请求参数

字段类型说明tokenstring校验码,同样不能过长userIdstring用户id



返回结果(消息的缩略图自己弄个静态的)

{    "status":"success"/"fail",    "messages":[        {"id":"234sdfwer23rf",        "title":"消息标题",        "createTime":"Tue May 31 17:46:55 +0800 2011(datetime)",        "content":"消息内容"},        {"id":"234sdfwer23rf",        "title":"消息标题",        "createTime":"Tue May 31 17:46:55 +0800 2011(datetime)",        "content":"消息内容"}    ]}

获取消息详情

考虑到消息内容本身就不是很多,故返回消息列表的时候没有消息简介,content字段即是消息内容。




通话记录备份


上传通话记录

url:
/call_backup/info
请求格式:
GET
请求参数

字段类型说明callRecordsjson通话记录备份的jsontokenstring校验码,同样不能过长userIdstring用户id



上传的json格式,可分批上传

{    "callRecords":[        {"phone":"1580000000",        "name":"姓名",        "callTime":"通话时间(datetime)"},        {"phone":"1580000000",        "name":"姓名",        "callTime":"通话时间(datetime)"}    ]}

通讯录备份


上传通讯录

url:
/contact/info
请求格式:
GET
请求参数

字段类型说明contactRecordsjson通讯录备份的jsontokenstring校验码,同样不能过长userIdstring用户id



上传的json格式,可分批上传

{    "contactRecords":[        {"phone":"1580000000",        "name":"姓名",        },        {"phone":"1580000000",        "name":"姓名",        }    ]}

GPS定位


上传GPS定位

url:
/gps/info
请求格式:
GET
请求参数

字段类型说明lontitudestring用户的经度latitudestring用户的纬度tokenstring校验码,同样不能过长userIdstring用户id


错误代码

/**
* 正常
*/
public static final int RIGHT = 0;
/**
* phone 不存在
*/
public static final int PHONE_NOT_EXIST = 100001;
/**
* userId 不存在
*/
public static final int USER_ID_NOT_EXIST = 100002;
/**
* phone或password为空
*/
public static final int PHONE_PASSWORD_IS_NULL = 100003;
/**
* phone已经存在
*/
public static final int PHONE_ALREADY_EXIST = 100004;
/**
* company介绍信息 不存在
*/
public static final int COMPANY_INFO_NOT_EXIST = 100005;
/**
* 产品详情信息 不存在
*/
public static final int PRODUCT_DETAIL_NOT_EXIST = 100006;
/**
* gps信息为为空
*/
public static final int GPS_IS_NULL = 100007;
/**
* 未登录,userId和token校验失败
*/
public static final int LOGIN_IS_NULL = 100008;

0 0
原创粉丝点击