App接口需求文档

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"
}
最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 194,088评论 5赞 459
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 81,715评论 2赞 371
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 141,361评论 0赞 319
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,099评论 1赞 263
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 60,987评论 4赞 355
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,063评论 1赞 272
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,486评论 3赞 381
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,175评论 0赞 253
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,440评论 1赞 290
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2赞 309
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,190评论 3赞 312
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,550评论 3赞 298
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0赞 17
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1赞 250
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2赞 341
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2赞 335

推荐阅读更多精彩内容

  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,490评论 18赞 139
  • 网易云Web SDK 开发手册
    点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 13,588评论 0赞 15
  • 面向对象的用电信息数据交换协议
    国家电网公司企业标准（Q/GDW）- 面向对象的用电信息数据交换协议 - 报批稿：20170802 前言： 排版 ...
    庭说阅读 10,800评论 6赞 13
  • 接口需求文档示例
    1.注册接口 1.接口地址：http://www.51qingyuan.com/register.php2.支持格...
    睡雨阅读 32,093评论 5赞 51
  • 风紧的日子里
    文/归海无期 风紧的日子里去看海 踩湿湿的沙 你说 美好的景色里 我总是碍眼 一种极不自然的落魄 只是一个替身 ...
    归海无期阅读 106评论 0赞 0