美文网首页app接口产品
App接口需求文档

App接口需求文档

作者: 心远久长 | 来源:发表于2017-03-11 10:00 被阅读125次

    1、客户端与服务器端交互的网络传输协议 https。

    2、客户端与服务器端交互的数据格式 json(utf-8编码)

    3、登录注册模块接口需求

    1.注册接口

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | mobile | string | 是 |手机号|
    |password | string | 是 |密码|
    | nickname| string | 是 |昵称|
    | smsCode| string | 是 |验证码|
    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    data string 信息
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "data":"注册成功",
      "message":"注册成功",
      "result":"success"
    }
    

    2.获取验证码

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | mobile | string | 是 |手机号|

    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    message string 返回信息
    result string 返回码解读信息
    {
      "code":200,
      "message":"短信已经下发,请注意查收9648",
      "result":"success"
    }
    

    3.登录接口

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | mobile | string | 是 |手机号|
    |password | string | 是 |密码|
    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    data string 信息
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":450,
      "data":"参数不全",
      "message":"登录失败",
      "result":"success"
    }
    

    4.用户退出

    1.接口地址:
    2.支持格式:json
    3.请求方式:delete
    4.请求参数:session_id
    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    data string 信息
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "data":"退出成功",
      "message":"退出成功",
      "result":"success"
    }
    

    4首页接口

    1.推荐产品接口

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | page | string | 是 |页码|

    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    banners array 推广产品信息
    data array 推荐产品信息
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "banners":[//数据同下data模型
                ],
      "data":[{
              "ID":12,
              "title":"第三季七天大草原之旅",
              "price":2980,
              "type_id":0,//产品类型
              "type":"推荐产品",
              "repertory":344,//库存
              "current_price":2980,
              "images":[],
              "collects":34,//收藏数
              "likes":23,//关注数
              "sales_month":43,//月销量
              "address":"中国内蒙赤峰市",
              "longitude":"",//经度
              "latitude":"",//纬度
              "create_time":"2017-03-08 15:42:13",
              "update_time":"2017-03-08 15:42:13",
              "merchant":{
                          "ID":23,//商家id
                          "name":"天骄自营",
                          "create_time":"2017-03-08 15:42:13",
                          "update_time":"2017-03-08 15:42:13",
                          "icon":"",//商家图标
                          "likes":77,//关注人数
                },
              "comments_num":22,
              "comments":[
                          {   "create_time":"2017-03-08 15:42:13",
                              "update_time":"2017-03-08 15:42:13",
                              "content":"评论内容",
                              "images":[],
                              "user":{
                                      "ID":32,
                                      "super_user_id":2,
                                      "super_user_name":"lisi",
                                      "nick_name":"zhangsan",
                                      "icon":""//用户图像
                                      "province":"山东省",
                                      "city":"济南市",
                                      "area":"",
                                      "create_time":"2017-03-08 15:42:13",
                                      "update_time":"2017-03-08 15:42:13",
                                      "sub_users_all":32,
                                      "sub_users_first_level":1,//一级客户数量
                                      "sub_users_second_level":1,//二级客户数量
                                      "sub_users_third_level":1,//三级客户数量
                                      "sub_users":[{
                                                    "ID":222,
                                                    "super_user_id":32,
                                                    "super_user_name":"zhangsan",
                                                    "nick_name":"王五",
                                                    "icon":""//用户图像
                                                    "province":"山东省",
                                                    "city":"济南市",
                                                    "area":"",
                                                    "create_time":"2017-03-08 15:42:13",
                                                    "update_time":"2017-03-08 15:42:13",
                                                    "sub_users_all":32,
                                                    "sub_users_first_level":1,//一级客户数量
                                                    "sub_users_second_level":1,//二级客户数量
                                                    "sub_users_third_level":1,//三级客户数量
                                                    "sub_users":[{}]
                                                        }]
                                     },
                          }]
                }],
      "message":"",
      "result":"success"
    }
    

    2.天骄自营

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | page | string | 是 |页码|
    | type | string | 是 |商品类型|

    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    goods array 推荐产品信息
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "goods":[{
              "ID":12,
              "title":"第三季七天大草原之旅",
              "price":2980,
              "type_id":0,//产品类型
              "type":"推荐产品",
              "repertory":344,//库存
              "current_price":2980,
              "images":[],
              "collects":34,//收藏数
              "likes":23,//关注数
              "sales_month":43,//月销量
              "address":"中国内蒙赤峰市",
              "longitude":"",//经度
              "latitude":"",//纬度
              "create_time":"2017-03-08 15:42:13",
              "update_time":"2017-03-08 15:42:13",
              "merchant":{
                          "ID":23,//商家id
                          "name":"天骄自营",
                          "create_time":"2017-03-08 15:42:13",
                          "update_time":"2017-03-08 15:42:13",
                          "icon":"",//商家图标
                          "likes":77,//关注人数
                },
              "comments_num":22,
              "comments":[
                          {   "create_time":"2017-03-08 15:42:13",
                              "update_time":"2017-03-08 15:42:13",
                              "content":"评论内容",
                              "images":[],
                              "user":{
                                      "ID":32,
                                      "super_user_id":2,
                                      "super_user_name":"lisi",
                                      "nick_name":"zhangsan",
                                      "icon":""//用户图像
                                      "province":"山东省",
                                      "city":"济南市",
                                      "area":"",
                                      "create_time":"2017-03-08 15:42:13",
                                      "update_time":"2017-03-08 15:42:13",
                                      "sub_users_all":32,
                                      "sub_users_first_level":1,//一级客户数量
                                      "sub_users_second_level":1,//二级客户数量
                                      "sub_users_third_level":1,//三级客户数量
                                      "sub_users":[{
                                                    "ID":222,
                                                    "super_user_id":32,
                                                    "super_user_name":"zhangsan",
                                                    "nick_name":"王五",
                                                    "icon":""//用户图像
                                                    "province":"山东省",
                                                    "city":"济南市",
                                                    "area":"",
                                                    "create_time":"2017-03-08 15:42:13",
                                                    "update_time":"2017-03-08 15:42:13",
                                                    "sub_users_all":32,
                                                    "sub_users_first_level":1,//一级客户数量
                                                    "sub_users_second_level":1,//二级客户数量
                                                    "sub_users_third_level":1,//三级客户数量
                                                    "sub_users":[{}]
                                                        }]
                                     },
                          }]
                }],
      "message":"",
      "result":"success"
    }
    

    3.商品详情

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | ID | string | 是 |商品ID|

    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    data dictionary 产品信息
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "data":{
              "ID":12,
              "title":"第三季七天大草原之旅",
              "price":2980,
              "type_id":0,//产品类型
              "type":"推荐产品",
              "repertory":344,//库存
              "current_price":2980,
              "images":[],
              "collects":34,//收藏数
              "likes":23,//关注数
              "sales_month":43,//月销量
              "address":"中国内蒙赤峰市",
              "longitude":"",//经度
              "latitude":"",//纬度
              "create_time":"2017-03-08 15:42:13",
              "update_time":"2017-03-08 15:42:13",
              "merchant":{
                          "ID":23,//商家id
                          "name":"天骄自营",
                          "create_time":"2017-03-08 15:42:13",
                          "update_time":"2017-03-08 15:42:13",
                          "icon":"",//商家图标
                          "likes":77,//关注人数
                },
              "comments_num":22,
              "comments":[
                          {   "create_time":"2017-03-08 15:42:13",
                              "update_time":"2017-03-08 15:42:13",
                              "content":"评论内容",
                              "score":5.0,
                              "images":[],
                              "user":{
                                      "ID":32,
                                      "super_user_id":2,
                                      "super_user_name":"lisi",
                                      "nick_name":"zhangsan",
                                      "icon":""//用户图像
                                      "province":"山东省",
                                      "city":"济南市",
                                      "area":"",
                                      "create_time":"2017-03-08 15:42:13",
                                      "update_time":"2017-03-08 15:42:13",
                                      "sub_users_all":32,
                                      "sub_users_first_level":1,//一级客户数量
                                      "sub_users_second_level":1,//二级客户数量
                                      "sub_users_third_level":1,//三级客户数量
                                      "sub_users":[{
                                                    "ID":222,
                                                    "super_user_id":32,
                                                    "super_user_name":"zhangsan",
                                                    "nick_name":"王五",
                                                    "icon":""//用户图像
                                                    "province":"山东省",
                                                    "city":"济南市",
                                                    "area":"",
                                                    "create_time":"2017-03-08 15:42:13",
                                                    "update_time":"2017-03-08 15:42:13",
                                                    "sub_users_all":32,
                                                    "sub_users_first_level":1,//一级客户数量
                                                    "sub_users_second_level":1,//二级客户数量
                                                    "sub_users_third_level":1,//三级客户数量
                                                    "sub_users":[{}]
                                                        }]
                                     },
                          }]
                },
      "message":"",
      "result":"success"
    }
    

    5.用户

    1.购物车

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | page | string | 是 |页码|

    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    total int 购物车产品总数
    goods array 推荐产品信息
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "total":3,
      "goods":[{
              "ID":12,
              "title":"第三季七天大草原之旅",
              "price":2980,
              "type_id":0,//产品类型
              "type":"推荐产品",
              "repertory":344,//库存
              "current_price":2980,
              "images":[],
              "collects":34,//收藏数
              "likes":23,//关注数
              "sales_month":43,//月销量
              "address":"中国内蒙赤峰市",
              "longitude":"",//经度
              "latitude":"",//纬度
              "create_time":"2017-03-08 15:42:13",
              "update_time":"2017-03-08 15:42:13",
              "merchant":{
                          "ID":23,//商家id
                          "name":"天骄自营",
                          "create_time":"2017-03-08 15:42:13",
                          "update_time":"2017-03-08 15:42:13",
                          "icon":"",//商家图标
                          "likes":77,//关注人数
                },
              "comments_num":22,
              "comments":[
                          {   "create_time":"2017-03-08 15:42:13",
                              "update_time":"2017-03-08 15:42:13",
                              "content":"评论内容",
                              "score":5.0,
                              "images":[],
                              "user":{
                                      "ID":32,
                                      "super_user_id":2,
                                      "super_user_name":"lisi",
                                      "nick_name":"zhangsan",
                                      "icon":""//用户图像
                                      "province":"山东省",
                                      "city":"济南市",
                                      "area":"",
                                      "create_time":"2017-03-08 15:42:13",
                                      "update_time":"2017-03-08 15:42:13",
                                      "sub_users_all":32,
                                      "sub_users_first_level":1,//一级客户数量
                                      "sub_users_second_level":1,//二级客户数量
                                      "sub_users_third_level":1,//三级客户数量
                                      "sub_users":[{
                                                    "ID":222,
                                                    "super_user_id":32,
                                                    "super_user_name":"zhangsan",
                                                    "nick_name":"王五",
                                                    "icon":""//用户图像
                                                    "province":"山东省",
                                                    "city":"济南市",
                                                    "area":"",
                                                    "create_time":"2017-03-08 15:42:13",
                                                    "update_time":"2017-03-08 15:42:13",
                                                    "sub_users_all":32,
                                                    "sub_users_first_level":1,//一级客户数量
                                                    "sub_users_second_level":1,//二级客户数量
                                                    "sub_users_third_level":1,//三级客户数量
                                                    "sub_users":[{}]
                                                        }]
                                     },
                          }]
                }],
      "message":"",
      "result":"success"
    }
    

    2.我的订单

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | type | string | 是 |订单类型|
    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    total int 订单数量
    data array 推荐产品信息
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "total":3,
      "data":[{
                 "order_id":34,//订单编号
                 "order_price":32454,//订单金额
                 "order_type":0  //0:待支付 1:待发货 2:待收货 3:待评价 
                 "goods":[],//同购物车
                 "consignee" :"张三",//收件人
                 "telephone_num":"15234563556",//收件人电话
                 "address":"xxx市xx路xx号",
                 "charges":8,//运费
             }],
      "message":"",
      "result":"success"
    }
    

    3.提交订单

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | consignee | string | 是 |收货人|
    | telephone_num | string | 是 |收货人电话|
    | address | string | 是 |收货地址|
    | goods_id | string | 是 |商品编号|
    | goods_num | string | 是 |商品数量|
    | order_price | string | 是 |订单金额|
    | charges | string | 是 |运费|

    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "message":"提交成功",
      "result":"success"
    }
    

    4.评价

    1.接口地址:
    2.支持格式:json
    3.请求方式:post
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | goods_id | string | 是 |商品编号|
    | content | string | 是 |评论内容|
    | score | string | 是 |评分|
    | images | array | 否 |图片链接|

    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    message string 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
      "message":"评论成功",
      "result":"success"
    }
    

    4.获取评价信息

    1.接口地址:
    2.支持格式:json
    3.请求方式:get
    4.请求参数:
    4.请求参数:

    | 名称 | 类型 | 必填 |说明|
    | -------- |:------:|: -----:|:--------:|
    | goods_id | string | 是 |商品编号|
    | page | string | 是 |页码|
    5.返回字段说明:

    名称 类型 说明
    code int 返回码
    data array 错误信息
    result string 返回信息

    6.返回JSON实例

    {
      "code":200,
       "comments_num":22,
       "comments":[
                     {"create_time":"2017-03-08 15:42:13",
                      "update_time":"2017-03-08 15:42:13",
                      "content":"评论内容",
                      "score":5.0,
                      "images":[],
                      "user":{
                                      "ID":32,
                                      "super_user_id":2,
                                      "super_user_name":"lisi",
                                      "nick_name":"zhangsan",
                                      "icon":""//用户图像
                                      "province":"山东省",
                                      "city":"济南市",
                                      "area":"",
                                      "create_time":"2017-03-08 15:42:13",
                                      "update_time":"2017-03-08 15:42:13",
                                      "sub_users_all":32,
                                      "sub_users_first_level":1,//一级客户数量
                                      "sub_users_second_level":1,//二级客户数量
                                      "sub_users_third_level":1,//三级客户数量
                                      "sub_users":[{
                                                    "ID":222,
                                                    "super_user_id":32,
                                                    "super_user_name":"zhangsan",
                                                    "nick_name":"王五",
                                                    "icon":""//用户图像
                                                    "province":"山东省",
                                                    "city":"济南市",
                                                    "area":"",
                                                    "create_time":"2017-03-08 15:42:13",
                                                    "update_time":"2017-03-08 15:42:13",
                                                    "sub_users_all":32,
                                                    "sub_users_first_level":1,//一级客户数量
                                                    "sub_users_second_level":1,//二级客户数量
                                                    "sub_users_third_level":1,//三级客户数量
                                                    "sub_users":[{}]
                                                        }]
                                     },
                          }]
      "result":"success"
    }
    

    相关文章

      网友评论

        本文标题:App接口需求文档

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