wiki:buygo_jiekou
Last modified 13 years ago

接口列表

百购项目接口文档

1.百购首页

  • 首页数据接口:/buygo/home/homeConfig.jsp
    接口类型:配置接口
    数据格式:JSON
    请求方式:GET
    要求登录:否
    参数：无
    返回数据： 
    {
    "focus": [
        {
            "image": "",
            "id": "店铺或商品ID",
            "url": "商品URL",
            "type": ""(1为店铺，0为IT商场商品)
        }
    ],
    "recommands": [
        {
            "typename": "手机数码",//分类名称
            "typeid": 123,//分类ID
            "shopList": [//店铺列表
                {
                    "id": 124,//店铺ID
                    "image": "http://..."//店铺图标
                }
            ]
        }
    ]
}

2.店铺接口

  • 店铺搜索:/buygo/searchShop.jsp
    接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    要求登录:否
    参数：

[stype]:搜索方式
[cpId]:店铺的Id
[pageNo]:页码（从1开始算起）
[pageSize]：页面显示条数（默认为30）
[words]:搜索关键词
说明：当stype=0,根据Id搜索店铺，需传入cpId的值;当stype=1，根据关键词搜索，需传入pageNo,pageSize，words;搜索所有店铺，需传入pageNo,pageSize。

返回数据： 

{
"flag":标记（flag=1,返回具体数据；flag=0,返回空串）
"total":返回记录总条数,
"dlist":
[
	{
    	"id": "店铺Id",
    	"tile": "店铺标题",
    	"rate": "店铺信誉",
    	"star": "是否为旗舰店" (star=1,为旗舰店；star=0,非旗舰店),
        "city":所在地，
        "logo":店铺logo
    	"focusList": 
 	    	{
            	"pic1": "焦点图1"
                "pic2": "焦点图2"
                "pic3": "焦点图3"
        	}
		
	}
]
}
  • 店铺介绍:/buygo/shopInfo.jsp
    接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    要求登录:否
    参数：cpId:店铺的Id
    返回数据: 
    {
    "id": "店铺id",
    "name": "店铺名",
    "title": "店铺简称",
    "addr": "地址",
    "mapflag": 0|1(经纬度标记，0表示没有设置经纬度；反之，则为1),
    "long": "经度",
    "lat": "纬度",
    "logo": "店铺logo",
    "credit": "老板信用",
    "contact": "联系人",
    "phone": "客服电话"
}
  • 店铺大类小类接口:buygo/shclassify.jsp
    接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    要求登录:否
    参数：[companyId]:店铺Id
    返回数据：（如果大类没有数据，返回{"classify":[]}；如果小类没数据，则小类列表为："subtypes":[]） 
    {
"classify":
  [{"subtypes":[
        {"smallId": 小类Id，
        "smallName":"小类名"
        }
        ]
  "bigId":大类ID，
  "bigName"："大类名"
  }]
}
  • 店铺商品搜索接口:/buygo/searchShopProduct.jsp
    接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    要求登录:否
    参数：

[cpId]:店铺的Id
[bigId]:大类Id
[smallId]:小类Id
[pageNo]:页码（从1开始算起）
[pageSize]：页面显示条数（默认为30）

返回数据： 

{
"flag":标记（flag=1,返回具体数据；flag=0,返回空串）
"total":100,
"dlist":
[{
	"id": "商品id",
	"name": "商品标题",
	"price": "价格",
	"url": "商品详情URL",
	"type": "0|1(1为淘宝商品，0为IT商场商品)",
	"thumb": "商品缩略图",
	"shopid": "店铺Id",
	"shoptitle": "店铺标题",
	"shoprate": "店铺信誉"
}]
}
  • 商品筛选所属类别接口:/buygo/home/productType.jsp?flag=list
    接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    要求登录:否
    参数： 返回数据： 
[
   {
     "Id": 产品类别ID，
     "name":"产品类别名称"
    }
]
  • 商品筛选接口:/buygo/searchFilter.jsp
    接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    要求登录:否
    参数：parentId:产品类别ID（必选）；筛选条件 params ：{id:[vidm,v2,v3],id:[vidm,v2,v3]};没有筛选条件，设stype=0,params为空,返回筛选棋谱;当stype=1,params不为空,返回筛选棋谱;

当stype=2,params不为空,pageNo(页码，从0开始),返回商品结果集（数据格式：参考商品搜索格式）；

返回数据： 

{
	"total": total(符合检索结果的总数),
	"chessManual":   (筛选棋谱)
	[
		{
			"fieldId": id(属性字段Id)，
			"name":"属性名",
			"values":[    
				{
					"vid": vid(属性值唯一标记),
					"value":"属性值名称",
					"status":0|1（0表示"不可选项"，1表示"可选项"）,
					"vtotal": vtotal(只选择该属性值时的检索结果总数),
                                        "seq":排列顺序
				}
			]
		}

	]
}[[BR]]
  • 商品搜索:/buygo/searchProduct.jsp
    接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    要求登录:否
    参数：

[stype]:搜索方式（必选）
[cpId]:店铺的Id （可选）
[pageNo]:页码（从1开始算起，可选）
[pageSize]：页面显示条数（默认为30，可选）
[words]:搜索关键词（可选）
说明：当stype=0,根据店铺cpId搜索店铺，需传入cpId(店铺)、pageNo、pageSize;当stype=1，根据关键词搜索，需传入pageNo,pageSize，words;当stype=2时,根据商品Id搜索商品，需传入pid（商品Id）

返回数据： 

{
"flag":标记（flag=1,返回具体数据；flag=0,返回空串）
"total":100,
"dlist":
[{
	"id": "商品id",
	"name": "商品标题",
	"price": "价格",
	"url": "商品详情URL",
	"type": "0|1(1为淘宝商品，0为IT商场商品)",
	"thumb": "商品缩略图",
	"shopid": "店铺Id",
	"shoptitle": "店铺标题",
	"shoprate": "店铺信誉"
}]
}

3.商品接口

  • 商品详情:/buygo/pdetail/pdetail.jsp
    接口类型:web页面
    数据格式:HTML
    请求方式:GET
    要求登录:否
    参数：productId:商品的ID，shopId:店铺ID,commonSessionId,uid:用户Id

4.精准搜索接口

  • 热门搜索词:/buygo/home/shot.jsp

接口类型:配置接口
数据格式:JSON
请求方式:GET
要求登录:否
参数：无
返回数据： 

[
    {
        "id": "热点类型id",
        "name": "类型名"
    }
]



5.个人中心

  • 买家收货地址列表:/buygo/addrs.jsp

接口类型:数据接口
数据格式:JSON
请求方式:GET
要求登录:否
参数：byId(买家Id)
返回数据： 

{
"flag":标记（flag=1,返回具体数据；flag=0,返回空串）
"total":100,
"dlist":
[
    {
        "id": "买家Id",
        "addrid": "收货地址id",
        "name": "收货人",
        "addr": "收货地址",
        "postcode": "邮编",
        "phone": "联系电话 "
    }
]
}



  • 添加收货地址:/buygo/addAddrs.jsp

接口类型:数据接口
数据格式:JSON
请求方式:GET
要求登录:否
参数： 

userId:用户Id
name:收货人
province:省
city：市
district:区
street:街道
zip:邮编
phone:电话
mobile：手机

返回数据： 

{
"code":1//1成功,0失败
}



  • 删除收货地址:/buygo/delAddrs.jsp

接口类型:数据接口
数据格式:JSON
请求方式:GET
要求登录:否
参数： 

            "addrId":收货地址id

返回数据： 

{
"code":1//1成功,0失败
}




{   status : 处理状态(0 为成功,其他为失败)
   message : 相关状态信息
   登录成功时还会返回
   session : common_session_id值
   common_session_id : common_session_id值
   userId: 当前登录用户id
} [[BR]]



  • 获取用户信息接口:/buygo/login.jsp 接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    请求参数：uid(用户Id)
    返回数据： 
{   code: 请求状态(1 为成功,0为失败)
   请求成功时还会返回
   "uid": uid(用户Id)
   "image": "用户logo图url"
} [[BR]]



  • 用户注册接口:/buygo/register.jsp 接口类型:数据接口
    数据格式:JSON
    请求方式:GET
    请求参数：username(用户名)，passwd(密码)， email
    返回数据：

{"code": 1 }(1：注册成功；2：用户名被占用；3：邮箱被占用；4：注册失败)