admin 管理员组文章数量: 1087139
2024年4月13日发(作者：银联安全控件下载安装官方)
XXX项目APP接口文档
首页 ......................................................................................................................................................................................................... 3
首页 ................................................................................................................................................................................................. 3
加载更多商品 ................................................................................................................................................................................. 7
用户注册 ................................................................................................................................................................................................. 9
注册 ................................................................................................................................................................................................. 9
发送手机验证码 ........................................................................................................................................................................... 11
用户中心 ............................................................................................................................................................................................... 12
登录 ............................................................................................................................................................................................... 12
登出 ............................................................................................................................................................................................... 14
原产品 ................................................................................................................................................................................................... 15
产品列表 ....................................................................................................................................................................................... 15
产品详情 ....................................................................................................................................................................................... 18
分类树 ........................................................................................................................................................................................... 22
备注： ................................................................................................................................................................................................... 23
注：
传参一律用post方式，key=request, value为一串json格式字符串，格式如：
request={
"head": {
"partner": "xxxxxxxxxxxxxxxxxxxxxxx",
"key": "xxxxxxxxx",
"mdkey": "xxxxxxxxxxx"
},
"para": {
"user_name": "user_name",
"pwd": "123456"
},
"result": {
"start": 0,
"count": 10
}
}
head：头信息，用于安全校验，参数固定为partner、key、mdkey 三项，mdkey随不同接口而变，partner和key为常量
头部信息校验错误统一返回，错误码分三种：
1：PARTNER有误
{
"head": {
"code": "C0004",
"msg": "PARTNER验证失败！"
}
}
2：KEY有误
{
"head": {
"code": "C0005",
"msg": "KEY验证失败！"
}
}
3：MD5加密错误
{
"head": {
"code": "C0001",
"msg": "请求验证失败！"
}
}
para：请求体，客户端请求所需要传入的参数，依据不同接口而定
result：结果集，主要用于分页
首页
首页
URL：
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(partner+key)
},
"result": {
"start": 0, //从第0条数据开始，（首页此项参数只能为0）
"count": 20 //总共返回20条数据，（即每页显示数量，由客户端自定）
}
}
输入参数说明：
参数 参数明细
partner
key
mdkey
start
count
类型（长度范围）
String
String
String
Int
Int
参数说明
合作者ID
合作者KEY
MD5加密字符
md5(partner+key)
分页数据开始标示
id
返回总数据条数
是否可空
不可空
不可空
不可空
可空（固
定为0）
可空（为
空时采用
系统默认
值20）
样例
a4bf5363f7bd76c5a4975b75f19f63ca
ldingadmin
a4bf5363f7bd76c5a4975b75f19f63ca
0
20
head
result
返回码描述：
错误码：
参考头部信息校验统一错误码
正确返回：
{
"head": {
"code": "10000",
"msg": "数据获取成功"
},
"para": {
"banner": [
{
"ad_id": "2",
"ad_name": "首页轮转2",
"pic": "/data/files/mall/ad/",
"link": "/?app=search&act=products&cid=1312",
"image_size": {
"width": 1200,
"height": 475
}
},
{
"ad_id": "3",
"ad_name": "首页轮转3",
"pic": "/data/files/mall/ad/",
"link": "/joinus/",
"image_size": {
"width": 1200,
"height": 475
}
}
……
],
"cate": [
{
"cate_id": "1216",
"cate_name": "女装",
"cate_ename": "WOMEN",
"cate_banner": "/data/files/mall/category/2015/06/",
"image_size": {
"width": 460,
"height": 300
}
},
{
"cate_id": "1217",
"cate_name": "男装",
"cate_ename": "MEN",
"cate_banner": "/data/files/mall/category/2015/06/",
"image_size": {
"width": 460,
"height": 300
}
}
……
],
"pic": [
{
"pic_id": "311",
"pic_name": "小女孩·柠檬汽水",
"price": "25.00",
"pic_url": "/data/files/store_238/pic/2015/06/",
"collects": "1",
"views": "0",
"sales": "0",
"image_size": {
"width": 2063,
"height": 2063
},
"love": true //是否关注，true已关注，false未关注
},
{
"pic_id": "314",
"pic_name": "小女孩·漫漫花事",
"price": "35.00",
"pic_url": "/data/files/store_238/pic/2015/06/",
"collects": "1",
"views": "0",
"sales": "0",
"image_size": {
"width": 2244,
"height": 3488
},
"love": false
}
……
],
"products": [
{
"product_id": "176",
"product_name": "三脚猫原创手工皮革 染色单肩包 手工定制",
"price": "400.00",
"image_url": "/data/files/store_90/openshop/product_",
"collects": "1",
"views": "0",
"sales": "0",
"image_size": {
"width": 3000,
"height": 3000
},
"love": true //是否关注，true已关注，false未关注
},
{
"product_id": "2066",
"product_name": "o 黑白拼色走秀款真丝缎面",
"price": "499.00",
"image_url": "/data/files/store_79/product/2015/06/",
"collects": "0",
"views": "0",
"sales": "0",
"image_size": {
"width": 515,
"height": 774
},
"love": false
}
……
]
},
"result": {
"start": 1,
"count": 20
}
}
正确返回码说明：
参数 参数名称 类型（长度范围）
code
msg
banner
cate
pic
products
String
String
Array
Array
Array
Array
int
参数说明
返回码，10000成
功，其他值失败
返回码提示信息
首页轮转
一级分类
热门图片
人气商品
此次请求，分页数
据开始标示id
"result": {
"start": 0,
"head": {
"code": "10000",
"msg": "恭喜，注册成功！"
}
样例
head
para
如上
返回码描述 -
正确返回
result
start
count int 此次请求，返回总
数据条数
"count": 20
}
加载更多商品
URL：//index/load_more
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(partner+key)
},
"result": {
"start": 21, //从第21条数据开始
"count": 20 //总共返回20条数据，（即每页显示数量）
}
}
输入参数说明：
参数 参数明细
partner
key
mdkey
start
count
类型（长度范围）
String
String
String
Int
Int
参数说明
合作者ID
合作者KEY
MD5加密字符
md5(partner+key)
分页数据开始标示
id
返回总数据条数
是否可空
不可空
不可空
不可空
不可空
可空（为
空时采用
系统默认
值20）
样例
a4bf5363f7bd76c5a4975b75f19f63ca
ldingadmin
a4bf5363f7bd76c5a4975b75f19f63ca
21
20
head
result
返回码描述：
错误码：
参考头部信息校验统一错误码
正确返回：
{
"head": {
"code": "10000",
"msg": "数据获取成功"
},
"para": {
"products": [
{
"product_id": "176",
"product_name": "三脚猫原创手工皮革 染色单肩包 手工定制",
"price": "400.00",
"image_url": "/data/files/store_90/openshop/product_",
"collects": "1",
"views": "0",
"sales": "0",
"image_size": {
"width": 3000,
"height": 3000
},
"love": true //是否关注，true已关注，false未关注
},
{
"product_id": "2066",
"product_name": "o 黑白拼色走秀款真丝缎面",
"price": "499.00",
"image_url": "/data/files/store_79/product/2015/06/",
"collects": "0",
"views": "0",
"sales": "0",
"image_size": {
"width": 515,
"height": 774
},
"love": false
}
……
]
},
"result": {
"start": 21,
"count": 20
}
}
正确返回码说明：
参数 参数名称 类型（长度范围）
code String
参数说明
返回码，10000成
功，其他值失败
"head": {
"code": "10000",
样例
head
msg
banner
cate
pic
products
String
Array
Array
Array
Array
int
int
返回码提示信息
首页轮转
一级分类
热门图片
人气商品
此次请求，分页数
据开始标示id
此次请求，返回总
数据条数
"msg": "恭喜，注册成功！"
}
para
如上
返回码描述 -
正确返回
result
start
count
"result": {
"start": 21,
"count": 20
}
用户注册
注册
URL：//register/reg
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(mobile+pwd+cpwd+sms_captcha+nick_name+partner+key)
},
"para": {
"mobile": "注册手机号",
"pwd": "密码",
"cpwd": "确认密码",
"sms_captcha": "手机接收的验证码",
"nick_name": "昵称"
}
}
输入参数说明：
参数 参数明细
partner
key
类型（长度范围）
String
String
参数说明
合作者ID
合作者KEY
是否可空
不可空
不可空
样例
a4bf5363f7bd76c5a4975b75f19f63ca
ldingadmin
head
mdkey String MD5加密字符
md5(mobile+pwd+c
pwd+sms_captcha+
nick_name+partner+
key)
用户名，目前为接
收验证码手机号
手机验证码
密码6-20位字符
确认密码6-20位字
符
昵称
不可空 a4bf5363f7bd76c5a4975b75f19f63ca
para
user_name
(mobile)
sms_captcha
pwd
cpwd
nick_name
String
String
String
String
String
不可空
不可空
不可空
不可空
可为空
user
678459
123456
123456
oheyou
返回码描述：
错误码：
{
"head": {
"code": "E0003",
"msg": "注册验证失败"
}
}
{
"head": {
"code": "E0001",
"msg": "用户名已存在！"
}
}
{
"head": {
"code": "E0001",
"msg": "两次密码不一致"
}
}
正确返回：
{
"head": {
"code": "10000",
"msg": "恭喜，注册成功！"
},
"para": {
"user_name": "user",
"phone_mob": "user",
"nick_name": "oheyou",
"status": 1,
"user_id": 263
}
}
正确返回码说明：
参数 参数名称 类型（长度范围）
code
msg
String
String
参数说明
返回码，10000成
功，其他值失败
返回码提示信息
注册用户名
注册手机号
昵称
状态
注册用户id
"head": {
"code": "10000",
"msg": "恭喜，注册成功！"
}
"para": {
"user_name": "user",
"phone_mob": "user",
"nick_name": "oheyou",
"status": 1,
"user_id": 263
}
样例
head
para
user_name String(5-25)
phone_mo
b
nick_nam
e
status
user_id
String(11)
String
int
int
发送手机验证码
URL：//register/send_sms_captcha
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(partner+key)
},
"para": {
"mobile": "用户手机号"
}
}
输入参数说明：
参数 参数明细
partner
类型（长度范围）
String
参数说明
合作者ID
是否可空
不可空
样例
a4bf5363f7bd76c5a4975b75f19f63
head
key
mdkey
mobile
String
String
String
合作者KEY
MD5加密字符
md5(partner+key)
接收验证码手机号
不可空
不可空
不可空
ldingadmin
a4bf5363f7bd76c5a4975b75f19f63
user
para
返回码描述：
错误码：
{
"head": {
"code": "E0005",
"msg": "手机号码不正确"
}
}
正确返回：
{
"head": {
"code": "10000",
"msg": "短信发送成功"
}
}
真确返回码说明：
参数 参数名称 类型（长度范围）
code
msg
String
String
参数说明
返回码，10000成
功，其他值失败
返回码提示信息
"head": {
"code": "10000",
"msg": "短信发送成功"
}
样例
head
用户中心
登录
URL：//user/login
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(user_name+pwd+partner+key)
},
"para": {
"user_name": "用户名",
"pwd": "密码"
}
}
输入参数说明：
参数 参数明细
partner
key
mdkey
类型（长度范围）
String
String
String
参数说明
合作者ID
合作者KEY
MD5加密字符
md5(user_name+pw
d+partner+key)
用户名
密码6-20位字符
是否可空
不可空
不可空
不可空
样例
a4bf5363f7bd76c5a4975b75f19f63ca
ldingadmin
a4bf5363f7bd76c5a4975b75f19f63ca
head
para
user_name
(mobile)
pwd
String
String
不可空
不可空
user
123456
返回码描述
错误码：
{
"head": {
"code": "E0003",
"msg": "用户名或密码错误！"
}
}
正确返回：
{
"head": {
"code": "10000",
"msg": "登录成功"
},
"para": {
"user_id": "76",
"user_name": "user",
"nick_name": "oheyou",
"gender": "0",
"im_qq": "0",
"email":"****************",
"points": "0",
"portrait": "/data/files/usr/76/2015/05/",
"logins": "0",
"last_login": "1435226105",
"follow": "4", //关注数量
"fans": "1", //粉丝数量
"loves": "12", //喜欢数量（产品，图片，商品）
"collects": "0" //店铺收藏数量
}
}
正确返回码说明：
参数 参数名称 类型（长度范围）
code
msg
user_id
User_nam
e
nick_nam
e
gender
im_qq
points
portrait
logins
last_login
follow
fans
loves
collects
String
String
int
String(5-25)
String
int
String
String
int
String
int
String
关注数量
粉丝数量
参数说明
返回码，10000成
功，其他值失败
返回码提示信息
用户id
用户名
昵称
性别
用户QQ号
用户邮箱
积分
头像地址
登录次数
最后一次登录时
间戳
1
2
"head": {
"code": "10000",
"msg": "登录成功！"
}
"para": {
"user_id": "76",
"user_name": "user",
"nick_name": "oheyou",
"gender": "0",
"im_qq": "0",
"email":"****************",
"points": "0",
"portrait":
"/data/files/usr/76/2015/05/2
",
"logins": "0",
"last_login": "1435226105",
"follow": "4", //关注数量
"fans": "1", //粉丝数量
"loves": "12", //喜欢数量（产品，图片，商品）
"collects": "0" //店铺收藏数量
}
样例
head
para
喜欢（产品，图片，3
商品）数量
店铺收藏数量 4
登出
URL：//user/login_out
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(partner+key)
}
}
输入参数说明：
参数 参数明细
partner
key
mdkey
返回码描述
错误码：
无
正确返回：
{
"head": {
"code": "10000",
"msg": "登出成功！"
}
}
类型（长度范围）
String
String
String
参数说明
合作者ID
合作者KEY
MD5加密字符
md5(partner+key)
是否可空
不可空
不可空
不可空
样例
a4bf5363f7bd76c5a4975b75f19f63ca
ldingadmin
a4bf5363f7bd76c5a4975b75f19f63ca
head
正确返回码说明：
参数 参数名称 类型（长度范围）
code
msg
String
String
参数说明
返回码，10000成
功，其他值失败
返回码提示信息
"head": {
"code": "10000",
"msg": "登出成功！"
}
样例
head
原产品
产品列表
URL：//product
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(cid+order+partner+key)
},
"para": {
"cid": "分类id",
"order": "排序",
},
"result": {
"start": "0",
"count": "20",
}
}
输入参数说明：
参数 参数明细
partner
key
mdkey
类型（长度范围）
String
String
String
参数说明
合作者ID
合作者KEY
MD5加密字符
md5(cid+order+part
ner+key)
分类id
排序：
1：添加时间倒序
2：添加时间顺序
3：销量倒序
4：销量顺序
5：价格倒序
6：价格顺序
7：人气倒序
8：人气顺序
数据起始id
返回总数据条数
是否可空
不可空
不可空
不可空
样例
a4bf5363f7bd76c5a4975b75f19f63ca
ldingadmin
a4bf5363f7bd76c5a4975b75f19f63ca
head
para
cid
order
int
int
不可空 1216
可空 1
（为空时
默认为
1）
result
start
count
int
int
不可空
可空
（为空时
采用默认
值20）
0
20
返回码描述
错误码：
参考头部信息校验统一错误码
正确返回：
{
"head": {
"code": "10000",
"msg": "数据获取成功"
},
"para": [
{
"product_id": "2073",
"product_name": "HC STUDIO 黑色羊毛 西装裤",
"add_time": "1434346771",
"price": "219.00",
"min_price": "219.00",
"max_price": "219.00",
"store_id": "79",
"store_name": "HC 定制工作室",
"image_url": "/data/files/store_79/product/2015/06/",
"view": "0", //浏览量
"collects": "2", //收藏量
"carts": "0", //加入购物车量
"orders": "0", //下单量
"sales": "0", //销售量
"comments": "0", //评论量
"love": false //是否喜欢
},
{
"product_id": "2071",
"product_name": "HC STUDIO 优雅锦缎提花褶半身裙",
"add_time": "1434346569",
"price": "249.00",
"min_price": "249.00",
"max_price": "249.00",
"store_id": "79",
"store_name": "HC 定制工作室",
"image_url": "/data/files/store_79/product/2015/06/",
"view": "0",
"collects": "0",
"carts": "0",
"orders": "0",
"sales": "0",
"comments": "0",
"love": false
},
……
],
"result": {
"start": 0,
"count": 20
}
}
正确返回码说明：
参数 参数名称 类型（长度范围）
code
msg
String
String
参数说明
返回码，10000成
功，其他值失败
返回码提示信息
产品id
产品名称
添加时间
价格
最小价格
最大价格
店铺id
店铺名称
登录次数
……
"head": {
"code": "10000",
"msg": "登录成功！"
}
"para": {
"product_id": "2073",
"product_name": "HC STUDIO 黑色羊毛 西装
裤",
"add_time": "1434346771",
"price": "219.00",
"min_price": "219.00",
"max_price": "219.00",
"store_id": "79",
"store_name": "HC 定制工作室",
"image_url":
"/data/files/store_79/product/2015/06/2015
",
"view": "0", //浏览量
"collects": "2", //收藏量
"carts": "0", //加入购物车量
"orders": "0", //下单量
"sales": "0", //销售量
"comments": "0", //评论量
"love": false //是否喜欢
}
样例
head
para
product_id int
product_n
ame
add_time
String(5-25)
String
int
String
int
String
int
……
price
min_price
max_price String
store_id
store_nam
e
Image_url
……
产品详情
URL：//product/detail
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(product_id+partner+key)
},
"para": {
"product_id": "产品id"
},
"result": { //用于评价和咨询
"start": "0",
"count": "20",
}
}
输入参数说明：
参数 参数明细
partner
key
mdkey
类型（长度范围）
String
String
String
参数说明
合作者ID
合作者KEY
MD5加密字符
md5(product_id+par
tner+key)
产品id
数据起始id
返回总数据条数
是否可空
不可空
不可空
不可空
样例
a4bf5363f7bd76c5a4975b75f19f63ca
ldingadmin
a4bf5363f7bd76c5a4975b75f19f63ca
head
para
result
product_id
start
count
int
int
int
不可空
可空
可空
（为空时
采用默认
值20）
134
0
20
返回码描述
错误码：
参考头部信息校验统一错误码
正确返回：
{
"head": {
"code": "10000",
"msg": "数据获取成功"
},
"para": {
"product_id": "134",
"product_name": "poly~(测试专用)",
"price": "0.01",
"default_image_id": "616", //商品主图id
"image_url": "/data/files/store_76/openshop/product_", //商品主图地址
"content": "啦啦啦啦啦啦", //商品详情
"tags": [ //商品标签
"连衣裙",
"雪纺",
"真丝",
"飘逸"
],
"brand_id": null, //商品品牌id
"brand_name": null, //商品品牌名称
"brand_logo": null,//商品品牌logo
"store_id": "75", //店铺id
"store_name": "awesome", //店铺名称
"store_type": "1", //店铺类别 1：个人 2：公司
"apply_type": "seller", //店铺申请类型 seller：供应商 designer：设计师
"description": null, //店铺简介
"store_collects": "0", //店铺收藏量
"store_sales": "5", //店铺销售量
"views": "0", //商品浏览量
"carts": "7", //商品加入购物车量
"collects": "2", //商品喜欢量
"sales": "6", //商品销售量
"comments": "0", //商品评论量
"orders": "8", //商品下单量
"product_loved": false, //是否喜欢过此商品（用户未登录一律返回false）
"store_collected": false,//是否收藏过此店铺（用户未登录一律返回false）
"spec_text": [ //商品规格描述
{
"spec_id": "80",
"spec_name": "颜色",
"is_color": "0",
"values": [
{
"spec_val_id": "23",
"sval_text": "白色",
"spec_val_text": "白色"
},
{
"spec_val_id": "24",
"sval_text": "红色",
"spec_val_text": "红色"
}
]
},
{
"spec_id": "77",
"spec_name": "尺码",
"is_color": "0",
"values": [
{
"spec_val_id": "15",
"sval_text": "M",
"spec_val_text": "M"
},
{
"spec_val_id": "16",
"sval_text": "L",
"spec_val_text": "L"
}
]
}
],
"sku": { //商品sku
";80:23;77:15;": {
"sku_id": "541",
"price": "0.01",
"is_show": "1"
},
";80:23;77:16;": {
"sku_id": "542",
"price": "0.01",
"is_show": "1"
},
";80:24;77:15;": {
"sku_id": "543",
"price": "0.01",
"is_show": "1"
},
";80:24;77:16;": {
"sku_id": "544",
"price": "0.01",
"is_show": "1"
}
},
"images_datas": [ //商品其他部位图片地址
{
"image_url": "/data/files/store_75/product/2015/05/"
},
{
"image_url": "/data/files/store_75/product/2015/05/"
}
],
"qa": [ //商品咨询数据
{
"reply_content": " hahahaha ",
"time_post": "1435200728",
"nick_name": "oheyou",
"portrait": "/data/files/usr/76/2015/05/"
}
],
"comment": "" //商品评论数据（格式如咨询）
},
"result": {
"start": 0,
"count": 20
}
}
正确返回码说明：
参数 参数名称 类型（长度范围）
code
msg
...
String
String
...
参数说明
返回码，10000成
功，其他值失败
返回码提示信息
...
"head": {
"code": "10000",
"msg": "登录成功！"
}
样例
head
para
参见以上正确返回描述
分类树
URL：//product/cate
输入参数：
request={
"head": {
"partner": "77b872abfe1264882d91",
"key": "ldingadmin",
"mdkey": md5(partner+key)
}
}
输入参数说明：
参数 参数明细
partner
key
mdkey
返回码描述
错误码：
无
正确返回：
Json格式分类树
类型（长度范围）
String
String
String
参数说明
合作者ID
合作者KEY
MD5加密字符
md5(partner+key)
是否可空
不可空
不可空
不可空
样例
a4bf5363f7bd76c5a4975b75f19f63ca
ldingadmin
a4bf5363f7bd76c5a4975b75f19f63ca
head
正确返回码说明：
参数 参数名称 类型（长度范围）
code
msg
String
String
参数说明
返回码，10000成
功，其他值失败
返回码提示信息
"head": {
"code": "10000",
"msg": "登出成功！"
}
样例
head
备注：
1000 操作成功
版权声明：本文标题：app接口文档模板 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://roclinux.cn/p/1713008411a616929.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。
发表评论