美团API接口.docx
《美团API接口.docx》由会员分享,可在线阅读,更多相关《美团API接口.docx(10页珍藏版)》请在冰豆网上搜索。
美团API接口
美团API接口概念
文档历史
版本
时间
状态
作者
备注
2014年4月26日
初稿
李冬冬
创建
一.模板表
1.CATEGORY表---大分类
category字段
定义
父级
描述
category_id
category
大分类id
merchart_id
merchart
商家id
category_title
category
大分类标题
2.CITY表---城市
city字段
定义
父级
描述
city_id
city
城市id
city_name
city
城市名称
city_lon
city
城市经度
city_lan
city
城市纬度
3.COLLECTS表---场次
collects字段
定义
父级
描述
collects_id
collects
收藏id
user_id
users
用户id
collects_type
collects
收藏类型
collects_product_merchart_id
collects
收藏商品或者商家的id
4.COMMENT表---评论
comment字段
定义
父级
描述
comment_id
comment
评论id
comment_starSum
comment
评论数目
user_id
users
用户id
merchart_id
merchart
商家id
product_id
product
商品id
comment_content
comment
评论内容
comment_time
comment
评论时间
5.MERCHART表---商家
merchart字段
定义
父级
描述
merchart_id
merchart
商家id
merchart_information
merchart
商家信息
merchart_photo
merchart
商家相册
category_id
category
大分类id
city_id
city
城市id
merchart_title
merchart
商家标题
merchart_tele
merchart
商家电话
merchart_address
merchart
商家地址
merchart_lon
merchart
商家经度
merchart_lat
merchart
商家纬度
merchart_isGroupBuy
merchart
商家是否团购
subCategory_id
subcategory
小分类id
price_you
merchart
商家商品价格
merchart_price_youhui
merchart
商家商品优惠价格
merchart_images
merchart
商家图片
merchart_wify
merchart
商家是否有wify
merchart_jieshao
merchart
商家介绍
6.ORDERS表---定单
orders字段
定义
父级
描述
order_id
orders
订单id
user_id
users
用户id
product_id
product
商品id
order_number
orders
订单数目
order_pay_time
orders
下单时间
order_total
orders
order_deadline
orders
订单截止日期
7.RODUCT表---应用软件
product字段
定义
父级
描述
product_id
prouct
商品id
product_userGuize
prouct
product_useTime
prouct
product_guoqiBack
prouct
product_suishiBack
prouct
product_time
prouct
merchart_id
merchart
商家id
product_oldprice
prouct
商品原来价格
product_yuyue
prouct
商品是否预约
category_id
category
大分类id
order_id
orders
订单id
subCategory_id
subcategory
小分类id
product_title
prouct
商品标题
product_price
prouct
商品价格
product_num
prouct
商品数目
product_notify
prouct
商品通知
product_new_notify
prouct
商品最新通知
product_images
prouct
商品图片
product_isGroupBuy
prouct
商品是否团购
product_valid_time
prouct
商品有效期时间
product_isToday
prouct
商品是否是今天的
product_freedate
prouct
8.SUBCATEGORY表---关注
subcategory字段
定义
父级
描述
subCategory_id
subcategory
小分类id
category_id
category
大分类id
subCategory_title
subcategory
小分类标题
9.UERS表---用户
users字段
定义
父级
描述
user_id
users
用户id
user_collect_num
users
用户收藏数量
user_name
users
用户名称
user_nickname
users
用户昵称
user_password
users
用户密码
user_tele
users
用户电话
10.VOUCHER表---优惠券
voucher字段
定义
父级
描述
voucher_id
voucher
优惠券id
user_id
users
用户id
voucher_password
voucher
优惠券密码
voucher_deadline
voucher
优惠券截止日期
二.接口详细概念
1.获取已注册用户信息(登录时返回的用户信息)
1)API格式:
POST
2)URL入口参数说明:
Key
Value值
含义
是否必须
user_name
String
用户名称
是
user_password
String
用户密码
是
type
Int
操作类型
是
3)返回类型:
JSON
4)返回参数说明:
Key
上级Key
Value类型
含义
addSuccess
boolean
用户是否注册成功
user_collect_num
int
用户收藏数量
user_id
int
用户id
user_name
String
用户名称
user_nickname
String
用户昵称
user_password
String
用户密码
user_tele
String
用户电话
5)例:
请求
true,
user_collect_num:
0,
user_id:
6,
user_name:
"zhoubibi",
user_nickname:
"",
user_password:
"123",
user_tele:
""
}
]
2.获取某用户的所有收藏
1)API格式:
POST
2)URL入口参数说明:
Key
Value值
含义
是否必须
user_id
Int
用户id
是
type
Int
操作类型
是
3)返回类型:
JSON
4)返回参数说明:
Key
上级Key
Value类型
含义
collects_id
Int
收藏id
collects_product_merchart_id
Int
收藏商品或者商家的id
collects_type
Int
收藏类型
user_id
Int
用户id
5)例:
请求
1,
collects_product_merchart_id:
2,
collects_type:
1,
user_id:
1
},
{
collects_id:
2,
collects_product_merchart_id:
1,
collects_type:
1,
user_id:
1
}
]
三.错误代码对照表
错误返回格式
成功的话'status':
200
{'respond':
{'status':
500,'code':
0,'msg':
'success'}
错误的话'status':
500,'code'为错误代码
{'respond':
{'status':
500,'code':
10008,'msg':
'参数错误'}}
{'respond':
{'status':
500,'code':
20101,'msg':
'暂时没有数据'}}
系统级错误代码
错误代码
错误信息
详细描述
10001
Systemerror
系统错误
10002
Serviceunavailable
服务暂停
10003
Remoteserviceerror
远程服务错误
10004
IPlimit
IP限制不能请求该资源
10005
Permissiondenied,needahighlevelappkey
该资源需要appkey拥有授权
10006
Sourceparamter(appkey)ismissing
缺少source(appkey)参数
10007
Unsupportmediatype(%s)
不支持的MediaType(%s)
10008
Paramerror,seedocformoreinfo
参数错误,请参考API文档
10009
Toomanypendingtasks,systemisbusy
任务过多,系统繁忙
10010
Jobexpired
任务超时
10011
RPCerror
RPC错误
10012
Illegalrequest
非法请求
10013
Invalidweibouser
不合法用户
10014
Insufficientapppermissions
应用的接口访问权限受限
10016
Missrequiredparameter(%s),seedocformoreinfo
缺失必选参数(%s),请参考API文档
10017
Parameter(%s)'svalueinvalid,expect(%s),butget(%s),seedocformoreinfo
参数值非法,需为(%s),实际为(%s),请参考API文档
10018
Requestbodylengthoverlimit
请求长度超过限制
10020
Requestapinotfound
接口不存在
10021
HTTPmethodisnotsuportedforthisrequest
请求的HTTP方法不支持
10022
IPrequestsoutofratelimit
IP请求频次超过上限
10023
Userrequestsoutofratelimit
用户请求频次超过上限
10024
Userrequestsfor(%s)outofratelimit
用户请求特殊接口(%s)频次超过上限
服务级错误代码
错误代码
错误信息
详细描述
20001
deviceosmustbenotnull
手机的操作系统平台不能为空
20101
暂时没有数据
20102
签到过于频繁
四.API用例列表
API参数说明
API参数中String类型的参数能够=’’,等效于不传该参数。
API参数中Int类型的参数能够=-1,等效于不传该参数。
API用例列表
API名称
API用例
基础信息接口
获取影片信息
按照城市id获取影片列表
活动接口
XX接口