美文网首页
App接口文档实例(md格式)

App接口文档实例(md格式)

作者: LWide | 来源:发表于2018-10-12 17:41 被阅读0次

App接口文档实例(md格式)
通用约定

  1. 域名HOST代表xxxxxxx.com
  2. 所有的SALT代表字符串exam.com.cn(加密认证时使用)

目录

账号

  1. 时间同步
  2. 登陆
  3. 注册
  4. 退出
  5. 找回密码(设置密码)
  6. 发送验证码
  7. 验证手机号(包括修改手机号码)

时间同步

https://exam.com/system/get_system_time

post参数

变量名 注释
uuid 设备编号
version 当前版本号

返回值

  • data 服务器系统的时间(13位时间戳)

example

{
    "code": 200,
    "msg": "success",
    "data": 1400000000000
}

登陆

https://exam.com.cn/Auth/login

post参数

变量名 注释
username 用户名
time 服务器系统时间戳(10位时间 + 3位随机数)
key sha1(username + md5(password) + time + SALT)
uuid 设备编号
version 当前版本号
jpush_id 极光推送RegistrationID(获取方式见极光API)

返回值

  • data 是经过des(substr(md5(password), 0, 8))加密过的
  • uid 用户id
  • token 令牌
  • phone 用户手机号码
  • name 用户姓名
  • inviter_id 邀请人id

example

{
    "code": 200,
    "msg": "success",
    "data": {
        "uid": "123",
        "phone": "13500000000",
        "name": "张三",
        "token": "xxxxxxxx",
        "inviter_id": "xxxx"
    }
}

注册

https://example.com/Auth/reg

post参数

变量名 注释
uuid 设备编号
version 当前版本号
pwd md5后的密码
in_uid 邀请码
mob_token_key 验证参数
mob 手机号码

返回值

example

{
    "code": 200,
    "msg": "success"
}

相关文章

  • App接口文档实例(md格式)

    App接口文档实例(md格式)通用约定 域名HOST代表xxxxxxx.com 所有的SALT代表字符串exam....

  • 接口文档.md

    前后端接口文档规范 约定接口一般包括以下数据 当前接口的路径是什么? 如 /auth/register, 当前接口...

  • 币安的接口文档分析

    币安的接口文档 总的接口文档列表rest-api.md, Details on the Rest APIerror...

  • python 项目-后台接口文档字段翻译

    后台接口文档格式如下: 数据库文档格式如下数据库文档.png 最后得到翻译完成的接口文档 项目地址

  • 接口文档实例

    有的小公司 或者 不太规范公司没接口文档,开发前,没,开发完成后也没。有的写网上,伙伴都可以看到。 现自己找了一个...

  • 接口文档格式

    1、注册 提供手机号和密码的登录方式。 请求说明 请求方式:POST 请求URL :login 参数 返回结果...

  • 接口文档的编写

    参考资料 如何优雅的格式化接口 如何优雅的“编写”api接口文档 接口文档的编写

  • X直播新版API文档

    X直播 App API 接口 接口修改说明 目录 [TOC] 接口文档概要说明 文档是《X直播平台接口通讯协议》的...

  • 主流开源库-Retrofit的使用

    基本使用 github官网 官方文档 第一定义一个接口 第二步创建Retrofit和接口的实例 根据接口实例调用...

  • markdown写后台api文档

    接口文档示例 用户模块 接口详情 登录接口 接口地址:/user返回格式:Json请求方式:Post请求示例:/u...

网友评论

      本文标题:App接口文档实例(md格式)

      本文链接:https://www.haomeiwen.com/subject/zztgaftx.html