PageRenderTime 45ms CodeModel.GetById 18ms RepoModel.GetById 0ms app.codeStats 0ms

/tuangou-api.md

https://github.com/yzpower/zhejie.github.com
Markdown | 317 lines | 254 code | 63 blank | 0 comment | 0 complexity | cb779cc4e6a0503fc547154ab2342362 MD5 | raw file
    

  1. 团购API接口
    2. 

  2. ======================
    3. 

  3. 

  4. 

  5. 数据格式为[JSON][json]，一般JSON库会将中文内容转换成unicode，可以忽略编码问题。未经unicode转换的，请采用utf8编码
    6. 

  6. 

  7. api参考[GroupOnAPIv2](https://sites.google.com/site/grouponapiv2)
    8. 

  8. 

  9. ###Login认证
    10. 

  10. 

  11. 登录认证是为了团购购买，购买暂通过手机网页版购买，如果认证页与购买页面不同域，登录认证成功后请将用户相关的cookie设定在跟域名上，以便手机网版本共享cookie。例如美团通过m.meituan.com购买，将cookie设置在 .meituan.com 并且将过期时间设置到了2041年
    12. 

  12. 	
    13. 

  13. 	POST: /login.json
    14. 

  14. 	username hidden
    15. 

  15. 	password ******
    16. 

  16. 

  17. ####失败
    18. 

  18. 

  19. 	{"error":{"httpCode":"400","message":"该用户不存在"}}
    20. 

  20. 

  21. ####成功
    22. 

  22. 

  23. 	{"user":{"id":123456,"username":"jack","email":"jack@test.com","mobile":1871234567}}
    24. 

  24. 

  25. 

  26. ###Divisions 
    27. 

  27. 

  28. 团购区域列表
    29. 

  29. 

  30. 	GET /divisions.json
    31. 

  31. 

  32. 

  33. ####返回失败数据示例
    34. 

  34. 

  35. 	{"error":{"httpCode":"400","message":"服务故障"}}
    36. 

  36. 

  37. ####返回成功数据示例[查看字段描述](#divisiondesc)
    38. 

  38. 

  39. 	{
    40. 

  40. 	  "divisions": [{
    41. 

  41. 			"id": "bj",
    42. 

  42. 			"name": "北京",
    43. 

  43. 			"enName": "beijing",
    44. 

  44. 			"lat": 39.904667,
    45. 

  45. 			"lng": 116.408198,
    46. 

  46. 			"timezoneOffsetInSeconds": 288000
    47. 

  47. 		}]
    48. 

  48. 	}
    49. 

  49. 	
    50. 

  50. <div name="divisiondesc" id="divisiondesc"></div>
    51. 

  51. ####Division字段说明
    52. 

  52. 

  53. 属性			|类型		|描述	
    54. 

  54. ------------------------|---------------|-----------
    55. 

  55. id			|String		|必需，区域ID
    56. 

  56. name			|String		|必需，区域名称
    57. 

  57. enName			|String		|英文名称，用于排序和查询
    58. 

  58. lat			|Number		|纬度
    59. 

  59. lng			|Number		|经度
    60. 

  60. timezoneOffsetInSeconds	|Number		|标准时差偏移
    61. 

  61. 

  62. ###Categories 
    63. 

  63. 

  64. 团购分类
    65. 

  65. 

  66. 按照分类过滤当前商品
    67. 

  67. 

  68. 	GET /categories.json?division=beijing
    69. 

  69. 

  70. 

  71. ####返回失败数据示例
    72. 

  72. 

  73. 	{"error":{"httpCode":"400","message":"服务故障"}}
    74. 

  74. 

  75. ####返回成功数据示例[查看字段描述](#catedesc)
    76. 

  76. 

  77. 	{
    78. 

  78. 	  "categories": [{
    79. 

  79. 			"group": "分类",
    80. 

  80. 			"id": "餐饮美食",
    81. 

  81. 			"name": "餐饮美食",
    82. 

  82. 			"count": 20
    83. 

  83. 		},{
    84. 

  84. 			"group": "分类",
    85. 

  85. 			"id": "休闲娱乐",
    86. 

  86. 			"name": "休闲娱乐",
    87. 

  87. 			"count": 18,
    88. 

  88. 			"sub": [{
    89. 

  89. 				"id": "ktv",
    90. 

  90. 				"name": "ktv",
    91. 

  91. 				"count": 2
    92. 

  92. 			}]
    93. 

  93. 		},{
    94. 

  94. 			"group": "频道",
    95. 

  95. 			"id": "户外旅游",
    96. 

  96. 			"name": "户外旅游",
    97. 

  97. 			"count": 5
    98. 

  98. 		}]
    99. 

  99. 	}
    100. 

  100. 	
    101. 

  101. <div name="catedesc" id="catedesc"></div>
    102. 

  102. ####Division字段说明
    103. 

  103. 

  104. 属性			|类型		|描述	
    105. 

  105. ------------------------|---------------|-----------
    106. 

  106. id			|String		|必需，分类ID
    107. 

  107. name			|String		|必需，分类名称
    108. 

  108. count			|Number		|数量
    109. 

  109. sub			|Array		|子分类
    110. 

  110. group			|String		|分类分组
    111. 

  111. 

  112. 

  113. ###Deals 
    114. 

  114. 

  115. 某区域团购列表
    116. 

  116. 

  117. 仅仅显示可购买的团购
    118. 

  118. 

  119. 	GET /deals/${id}.json //单个团购信息
    120. 

  120. 	GET /deals.json?division=bj&cate=美食&perPage=10&page=1
    121. 

  121. 	division: 团购区域，自动定位，可能有如下几种情况，需自行判断：beijing,Beijing,北京,北京市
    122. 

  122. 

  123. ####返回失败数据示例
    124. 

  124. 

  125. 	{"error":{"httpCode":"400","message":"该区域不存在"}}
    126. 

  126. 

  127. ####返回成功数据示例[查看字段描述](#dealdesc)
    128. 

  128. 

  129. 	
    130. 

  130. 	//deal
    131. 

  131. 	{
    132. 

  132. 		"deal": {}
    133. 

  133. 	}
    134. 

  134. 	//deals
    135. 

  135. 	
    136. 

  136. 	{
    137. 

  137. 	  "perPage":10,"currentPage":1,"totalEntries":102,"totalPages":11,
    138. 

  138. 	  "deals": [{
    139. 

  139. 			"id": "bjwe",
    140. 

  140. 			"division": {
    141. 

  141. 				"id": "bj",
    142. 

  142. 				"name": "北京",
    143. 

  143. 				"lat": 39.904667,
    144. 

  144. 				"lng": 116.408198
    145. 

  145. 			},
    146. 

  146. 			"announcementTitle": "仅售58元！原价130元的嘉佳羊蝎子双人套餐",
    147. 

  147. 			"title": "仅售58元！原价130元的嘉佳羊蝎子双人套餐（小锅羊蝎子+香菇+面片+多种菜品任选5份+自制酸梅汤）。蒲安里/刘家窑两店通用。和美味的羊蝎子相比，吃相又算什么？",
    148. 

  148. 			"category": "餐饮美食",
    149. 

  149. 			"isSoldOut": false,
    150. 

  150. 			"soldQuantity": 120,
    151. 

  151. 			"quantity": 0,
    152. 

  152. 			"url": "http://bj.meituan.com/deal/253724.html",
    153. 

  153. 			"buyUrl": "http://m.meituan.com/deal/buy/253724",
    154. 

  154. 			"siteName": "美团北京站",
    155. 

  155. 			"siteUrl": "http://bj.meituan.com",
    156. 

  156. 			"smallImageUrl": "http://p1.meituan.com/deal/201012/30/lthbxj00.jpg", //5:3 120x72
    157. 

  157. 			"mediumImageUrl": "http://p1.meituan.com/deal/201012/30/lthbxj00.jpg",//200x120 
    158. 

  158. 			"largeImageUrl": "http://p1.meituan.com/deal/201012/30/lthbxj00.jpg",//440x264
    159. 

  159. 			"tippedAt": 1301147806,
    160. 

  160. 			"tippingPoint": 400,
    161. 

  161. 			"isTipped": true,
    162. 

  162. 			"startAt": 1301149806,
    163. 

  163. 			"endAt": 1301147806,
    164. 

  164. 			"expiresAt": 1301157806,
    165. 

  165. 			"price": 200,
    166. 

  166. 			"value": 500,
    167. 

  167. 			"discountPercent": 30,
    168. 

  168. 			"highlightsHtml": "",
    169. 

  169. 			"details": "有效期3个月， 2011.3.22 至 2011.6.22;营业时间：10:30-22:00;请至少提前1天致电预约",
    170. 

  170. 			"pitchHtml": "",
    171. 

  171. 			"merchant": {
    172. 

  172. 				"id": "234",
    173. 

  173. 				"name": "嘉佳羊蝎子",
    174. 

  174. 				"websiteUrl": "http://www.jjyxz.com"
    175. 

  175. 			},
    176. 

  176. 			"range": "东铁营",
    177. 

  177. 			"locations":[
    178. 

  178. 				{
    179. 

  179. 					"name": "嘉佳羊蝎子(刘家窑店)", 
    180. 

  180. 					"address": "北京市丰台区东铁营215号", 
    181. 

  181. 					"lat": 39.904667, 
    182. 

  182. 					"lng": 116.408198, 
    183. 

  183. 					"dpShopId": "4562008",
    184. 

  184. 					"phoneNumber": "010-12345678,13912345678" 
    185. 

  185. 				},
    186. 

  186. 				{
    187. 

  187. 					"name": "嘉佳羊蝎子(蒲安里店)", 
    188. 

  188. 					"address": "北京市丰台区蒲安里4号楼", 
    189. 

  189. 					"lat": 39.904667, 
    190. 

  190. 					"lng": 116.408198, 
    191. 

  191. 					"dpShopId": "3632377",
    192. 

  192. 					"phoneNumber": "010-12345678"
    193. 

  193. 				}
    194. 

  194. 			]
    195. 

  195. 		}]
    196. 

  196. 	}
    197. 

  197. 

  198. 

  199. ####翻页字段说明
    200. 

  200. 属性			|类型		|描述	
    201. 

  201. ------------------------|---------------|-----------
    202. 

  202. perPage			|Number		|必需，每页数量
    203. 

  203. totalPages		|Number		|必需，总页数
    204. 

  204. totalEntries		|Number		|必需，总数量
    205. 

  205. currentPage		|Number		|必需，当前页码
    206. 

  206. 

  207. <div name="dealdesc" id="dealdesc"></div>
    208. 

  208. ####Deal字段说明
    209. 

  209. 

  210. 属性			|类型		|描述	
    211. 

  211. ------------------------|---------------|-----------
    212. 

  212. id			|String		|必需，团购唯一ID
    213. 

  213. division		|Division	|必需，团购区域
    214. 

  214. title			|String		|必需，团购显示标题
    215. 

  215. announcementTitle	|String		|短标题
    216. 

  216. category		|String		|分类(ios暂时用不上) 
    217. 

  217. isSoldOut		|Boolean	|必需，是否已售完	
    218. 

  218. soldQuantity		|Number		|必需，卖出数量	
    219. 

  219. quantity		|Number		|必需，商品总量，无限量为0	
    220. 

  220. url			|String		|必需，此商品链接，采用商品唯一链接
    221. 

  221. buyUrl			|String		|购买页面地址(手机版)
    222. 

  222. siteName		|String		|该商品所链接的分站名称，没有则默认为网站名称
    223. 

  223. siteUrl			|String		|该商品所链接的分站地址，没有则默认为网站首页地址
    224. 

  224. smallImageUrl		|String		|小图片地址(约120x72像素)
    225. 

  225. mediumImageUrl		|String		|必需，一般图片地址(约200x120像素，供iphone等手机设备显示)
    226. 

  226. largeImageUrl		|String		|必需，大图片地址(约440x264像素，供电脑,iPad显示)
    227. 

  227. isTipped		|Boolean	|是否超过最低团购数
    228. 

  228. tippedAt		|Number		|超过最低团购数时间
    229. 

  229. tippingPoint		|Number		|最低团购数量
    230. 

  230. startAt			|Number		|必需，团购开始时间
    231. 

  231. endAt			|Number		|必需，团购结束时间
    232. 

  232. expiresAt		|Number		|团购的商品过期
    233. 

  233. price			|Number		|必需，团购价格	
    234. 

  234. value			|Number		|必需，商品实际价格	
    235. 

  235. discountPercent		|Number		|必需，折扣率(price\*100/value)	
    236. 

  236. details			|String		|提示资料(html)
    237. 

  237. highlightsHtml		|String		|产品亮点特色(html)
    238. 

  238. pitchHtml		|String		|产品详情内容(html)
    239. 

  239. merchant		|Merchant	|团购提供商
    240. 

  240. range			|String		|地区热点
    241. 

  241. locations		|Array		|重要，各分店位置，可有多个
    242. 

  242. 

  243. ####Location参数说明
    244. 

  244. 

  245. 

  246. 属性			|类型		|描述	
    247. 

  247. ------------------------|---------------|-----------
    248. 

  248. name			|String		|店铺名称(分店名称)，名称可参考[点评网](http://www.dianping.com)
    249. 

  249. address			|String		|Google地图标准地址
    250. 

  250. lat			|Number		|纬度，为了用户直接查看地图，本地团购请填写
    251. 

  251. lng			|Number		|经度
    252. 

  252. dpShopId		|String		|后期可能支持直接查看点评，团购商家的大众点评shopid
    253. 

  253. phoneNumber		|String		|固定电话 填写有效电话，方便手机直接拨打，多个逗号分隔
    254. 

  254. 

  255. 

  256. ###Coupons 
    257. 

  257. 

  258. 团购券
    259. 

  259. 

  260. 	GET /coupons.json?perPage=10&page=1&filter=used&sort=createdAt&lat=35.1124234&lng=117.34243
    261. 

  261. 	params
    262. 

  262. 		filter: used|unused
    263. 

  263. 		sort:	createdAt|expiresAt|distance
    264. 

  264. 

  265. ####返回失败数据示例
    266. 

  266. 

  267. 	{"error":{"httpCode":"400","message":"未登录"}}
    268. 

  268. 

  269. ####返回成功数据示例[查看字段描述](#coupondesc)
    270. 

  270. 

  271. 	{
    272. 

  272. 	  "perPage":10,"currentPage":1,"totalEntries":102,"totalPages":11,
    273. 

  273. 	  "coupons": [{
    274. 

  274. 			"id": "12323",
    275. 

  275. 			"title": "鸟巢旁CGV星星国际影城单人观影套餐",
    276. 

  276. 			"code": "023131231",
    277. 

  277. 			"orderId": "23424242424",
    278. 

  278. 			"purchaseStatus": "已付款",
    279. 

  279. 			"purchaseAt": 1301149806,
    280. 

  280. 			"expiresAt": 1301149806,
    281. 

  281. 			"isUsed": true,
    282. 

  282. 			"usedAt": 1301149806,
    283. 

  283. 			"dealId": "223424",
    284. 

  284. 			"smallImageUrl": "http://p0.meituan.net/120.76/deal/201105/31/1_0531185216.jpg",
    285. 

  285. 			"mediumImageUrl": "http://p0.meituan.net/120.76/deal/201105/31/1_0531185216.jpg",
    286. 

  286. 			"largeImageUrl": "http://p0.meituan.net/120.76/deal/201105/31/1_0531185216.jpg",
    287. 

  287. 			"distance": 0.3,
    288. 

  288. 			"range": "朝阳区",
    289. 

  289. 			"locations": []
    290. 

  290. 		}]
    291. 

  291. 	}
    292. 

  292. 	
    293. 

  293. <div name="coupondesc" id="coupondesc"></div>
    294. 

  294. ####Coupon字段说明
    295. 

  295. 

  296. 属性			|类型		|描述	
    297. 

  297. ------------------------|---------------|-----------
    298. 

  298. id			|String		|必需，团购卷id
    299. 

  299. title			|String		|必需，团购卷标题
    300. 

  300. code			|String		|团购券密码
    301. 

  301. orderId			|String		|订单id
    302. 

  302. purchaseStatus		|String		|购买状态
    303. 

  303. purchaseAt		|Number		|购买时间
    304. 

  304. isUsed			|Boolean	|是否已使用
    305. 

  305. usedAt			|Number		|使用时间
    306. 

  306. dealId			|String		|团购id
    307. 

  307. smallImageUrl		|String
    308. 

  308. mediumImageUrl		|String
    309. 

  309. largeImageUrl		|String
    310. 

  310. distance		|Number		|距离，无距离时为null
    311. 

  311. range			|String		|地区热点
    312. 

  312. locations		|Array		|位置
    313. 

  313. 

  314. 

  315. [ISO_8601]: http://zh.wikipedia.org/zh-cn/ISO_8601
    316. 

  316. [json]: http://json.org
    317. 

  317. 

  318.