logo资料库

api模板文档.docx

发布时间：2022-06-14 发布人：admin 分类：说明书 资料大小：0.04M 资料格式：docx 举报 版权申诉
第1页 / 共16页
第2页 / 共16页
第3页 / 共16页
第4页 / 共16页
第5页 / 共16页
第6页 / 共16页
第7页 / 共16页
第8页 / 共16页
资料共16页，剩余部分请下载后查看
    前言
    接口概述
    概述
    接口路径设计
    设计原则
    URL组成（http://ad
    URL定义限制
    接口请求方式
    get方式
    post方式
    接口返回数据规则
    code定义
    1.登录
    2.根据账号搜索查询
    3.添加好友1(在不是还有且曾经未添加好友的情况下)
    4.修改/添加好友备注
    5.删除好友
    6.添加申请好友信息
    7.好友申请信息列表
    8.可能认识的人列表(随机返回四个对象)
    9.申请好友通过回调接口
    小牛币 APP_接口文档 （内部资料 请勿外传） 文档变更记录 版本 更新日期 Version 1.0 2017.08.09 内容 创建 修订人 孙荣荣 备注 创建文档 1 前言 .................................................................................................................................................... 1.1 接口概述 ................................................................................................................................ 1.1.1 概述 ............................................................................................................................. 1.2 接口路径设计 ........................................................................................................................ 1.2.1 设计原则 ..................................................................................................................... 1.2.2 URL 组成（http://address//account?userid=1）..................................................... 1.2.3 URL 定义限制............................................................................................................. 1.3 接口请求方式 ........................................................................................................................ 1.3.1 get 方式 ...................................................................................................................... 1.3.2 post 方式 .................................................................................................................... 1.4 接口返回数据规则 ................................................................................................................ 1.4.1 code 定义 .................................................................................................................... 1.4.1.1 ‘--’说明： ......................................................................................................... 1.4.1.2 ’##’说明：....................................................................................................... 1.4.1.3 具体 Code ........................................................................................................ 1.4.2 接口数据返回格式 .................................................................................................... 2 详细接口 ............................................................................................................................................ 2.1 用户 ........................................................................................................................................ 2.1.1 注册 .............................................................................................................................
    前言 接口概述 概述 小牛币 APP 接口路径设计 设计原则 a) URI 指向的是唯一资源对象 b) URI 隐式指向唯一集合列表 c) 避免资源路径嵌套（要有单一性） URL 组成（http://address//account?userid=1） a) 网络协议（http,https） b) 服务器地址 c) 版本 d) 接口名称 e) 参数 f) 接口地址： http://192.168.0.246:8001/
    URL 定义限制 a) 不使用大写字母 b) 参数不乱码，指定字符（utf-8） 接口请求方式 get 方式 适用场景：获取资源，幂等型。 post 方式 适用场景：增删改数据。 接口返回数据规则 code 定义 1.登录 接口地址：http://192.168.1.29:8080/User/ 接口协议：post 请求参数： 字段名称 字段名称 id 用户 ID 类型 Int 可空 备注 必填 用户 ID
    uuid token 会员账号 用户令牌 数据返回说明： Int String 必填 会员账号 必填 用户令牌 字段名称 字段名称 类型 备注 数据返回格式： { "error_code": "200", "reason": "success", "result": { "UserID": 1, "UserName": "13778417349", "MgId": 0, "LoginPassword": "3v0H3bYSZhtwQREm1KWb0g==", "FundsPassword": "MzmU7flJCB3ref6Twk2ukg==", "Mobile": "13778417349", "ReferrerA_Mobile": null, "ReferrerA_UserID": null, "RealName": "向德军",
    "IDCard_Number": "510622199001254814", "IDCard_VerifyStatus": 1, "AvailableBalance_RMB": 1.08, "FreezeBalance_RMB": 0, "AvaiableBalance_VC": 0, "VC_Buy": 0, "VC_Get": 0, "FreezeBalance_VC": 0, "VC_Get_Reward": 0, "VC_Get_Allocation": 0, "VC_Unfreeze": 0, "VC_Freeze_Buyback": 0, "VC_Freeze_Order": 0, "ManuallyFreeze_VC": 0, "IsHidden": 0, "Pic": null, "ExtendBalance": 0, "Deal_MaxQuantity": 0, "Totle_InCome": 1.08, "ExchangeFee": 0.03, "LoginErr": 0, "AvaiableBalance_LB": 0, "FreezeBalance_LB": 0, "LBBuyDayMax": 0, "LBBuyMaxOrderCount": 0 } } 2.根据账号搜索查询 接口地址：http://192.168.1.29:8080/friend/selFriendNo
    可空 备注 必填 用户 ID 必填 好友账号，即电话号码 备注 搜索用户性别 搜索用户电话 搜索用户地区 搜索用户个性签名 搜索用户年龄 搜索用户头像 搜索用户真实姓名 搜索用户 ID 类型 Long String 类型 String String String String Int String String Long 接口协议：post 请求参数： 字段名称 字段名称 userID 用户 ID friendAccount 好友账号 数据返回说明： 字段名称 字段名称 sex phone area signName age userIcon realName userInfoID 性别 电话 地区 个性签名 年龄 头像 真实姓名 用户 ID 数据返回格式： 账号不是 app 用户：{ "message":"该账号不是 app 用户", "status":"200", } 账号不是用户好友：
    { "message":"该账号不是用户好友", "status":"300", "data":[{ "sex":"", "phone":"13709071005 ", "area":"", "signName":"", "age":2, "userIcon":"", "realName":"刘虹伶 ", "msg":"", "userInfoID":13 }] } 账号曾经是用户好友： { "message":"该账号从曾经是用户好友", "status":"400", "data":[{ "sex":"", "phone":"13709071005 ", "area":"", "signName":"", "age":2, "userIcon":"", "realName":"刘虹伶 ", "msg":"", "userInfoID":13
    }] } 账户是用户好友： { "message":"该账号是 app 用户", "status":"100", } 3.添加好友 1(在不是还有且曾经未添加好友的情况下) 接口地址：http://192.168.1.29:8080/friend/saveFriend 接口协议：post 请求参数： 字段名称 字段名称 userID 用户 ID 类型 Long 可空 备注 必填 用户 ID friendAccount 添加的好友账号 String 必填 添加的好友账号 数据返回格式： 添加成功： { "message":"success", "status":"100", } 4.修改/添加好友备注 接口地址：http://192.168.1.29:8080/friend/commentFriend
    分享到：
    赞 收藏

    相关推荐

    资料库

    开发技术

    共收录19306份资料，累计14个分类，关注成员有19位，主要包括：Actionscript,Javascript,PHP,VB,Perl,Delphi,Python,C#,C,Java,C++,Web开发,硬件开发,其它

    热门标签

    Actionscript Javascript PHP VB Perl Delphi Python C# C Java C++ Web开发 硬件开发 其它

    最新资料