app接口文档模板.docx
- 文档编号:28400201
- 上传时间:2023-07-13
- 格式:DOCX
- 页数:33
- 大小:19.46KB
app接口文档模板.docx
《app接口文档模板.docx》由会员分享,可在线阅读,更多相关《app接口文档模板.docx(33页珍藏版)》请在冰豆网上搜索。
app接口文档模板
app接口文档模板
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":
"77b872abfe2d91",
"key":
"ldingadmin",
"mdkey":
md5(partner+key)
},
"result":
{
"start":
0,//从第0条数据开始,(首页此项参数只能为0)
"count":
20//总共返回20条数据,(即每页显示数量,由客户端自定)
}
}
输入参数说明:
合作者ID不可空partnerStringa4bf5363f7bd76c5a4975b75f19f63cahead
合作者KEY不可空keyStringldingadmin
MD5加密字符不可空mdkeyStringa4bf5363f7bd76c5a4975b75f19f63ca
md5(partner+key)
分页数据开始标示可空(固startInt0result定为0)id
返回总数据条数可空(为countInt20
空时采用
系统默认
值20)返回码描述:
错误码:
参考头部信息校验统一错误码
正确返回:
{
"head":
{
"code":
"10000",
"msg":
"数据获取成功"
},
"para":
{
"banner":
[
{
"ad_id":
"2",
"ad_name":
"首页轮转2",
"pic":
";,
"link":
";act=products&cid=1312",
"image_size":
{
"width":
1200,
"height":
475
}
},
{
"ad_id":
"3",
"ad_name":
"首页轮转3",
"pic":
";,
"link":
";,
"image_size":
{
"width":
1200,
"height":
475
}
}
……
],
"cate":
[
{
"cate_id":
"1216",
"cate_name":
"女装",
"cate_ename":
"WOMEN",
"cate_banner":
";,
"image_size":
{
"width":
460,
"height":
300
}
},
{
"cate_id":
"1217",
"cate_name":
"男装",
"cate_ename":
"MEN",
"cate_banner":
";,
"image_size":
{
"width":
460,
"height":
300
}
}
……
],
"pic":
[
{
"pic_id":
"311",
"pic_name":
"小女孩?
柠檬汽水",
"price":
"25.00",
"pic_url":
";,
"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":
";,
"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":
";,
"collects":
"1",
"views":
"0",
"sales":
"0",
"image_size":
{
"width":
3000,
"height":
3000
},
"love":
true//是否关注,true已关注,false未关注
},
{
"product_id":
"2066",
"product_name":
"H.Cstudio黑白拼色走秀款真丝缎面",
"price":
"499.00",
"image_url":
";,
"collects":
"0",
"views":
"0",
"sales":
"0",
"image_size":
{
"width":
515,
"height":
774
},
"love":
false
}
……
]
},
"result":
{
"start":
1,
"count":
20
}
}
正确返回码说明:
返回码,10000成"head":
{codeStringhead功,其他值失败"code":
"10000",
"msg":
"恭喜,注册成功~"返回码提示信息msgString
}
首页轮转如上bannerArraypara返回码描述-正确返回一级分类cateArray
热门图片picArray
人气商品productsArray
此次请求,分页数"result":
{startintresult据开始标示id"start":
0,
"count":
20此次请求,返回总countint
数据条数}加载更多商品
URL:
输入参数:
request={
"head":
{
"partner":
"77b872abfe2d91",
"key":
"ldingadmin",
"mdkey":
md5(partner+key)
},
"result":
{
"start":
21,//从第21条数据开始
"count":
20//总共返回20条数据,(即每页显示数量)
}
}
输入参数说明:
合作者ID不可空partnerStringa4bf5363f7bd76c5a4975b75f19f63cahead
合作者KEY不可空keyStringldingadmin
MD5加密字符不可空mdkeyStringa4bf5363f7bd76c5a4975b75f19f63ca
md5(partner+key)
分页数据开始标示不可空startInt21resultid
返回总数据条数可空(为countInt20
空时采用
系统默认
值20)返回码描述:
错误码:
参考头部信息校验统一错误码
正确返回:
{
"head":
{
"code":
"10000",
"msg":
"数据获取成功"
},
"para":
{
"products":
[
{
"product_id":
"176",
"product_name":
"三脚猫原创手工皮革染色单肩包手工定制",
"price":
"400.00",
"image_url":
";,
"collects":
"1",
"views":
"0",
"sales":
"0",
"image_size":
{
"width":
3000,
"height":
3000
},
"love":
true//是否关注,true已关注,false未关注
},
{
"product_id":
"2066",
"product_name":
"H.Cstudio黑白拼色走秀款真丝缎面",
"price":
"499.00",
"image_url":
";,
"collects":
"0",
"views":
"0",
"sales":
"0",
"image_size":
{
"width":
515,
"height":
774
},
"love":
false
}
……
]
},
"result":
{
"start":
21,
"count":
20
}
}
正确返回码说明:
"head":
{返回码,10000成codeStringhead"code":
"10000",功,其他值失败
"msg":
"恭喜,注册成功~"返回码提示信息msgString
}
首页轮转如上bannerArraypara返回码描述-正确返回一级分类cateArray
热门图片picArray
人气商品productsArray
"result":
{此次请求,分页数startintresult据开始标示id"start":
21,
"count":
20此次请求,返回总countint
}数据条数用户注册
注册
URL:
输入参数:
request={
"head":
{
"partner":
"77b872abfe2d91",
"key":
"ldingadmin",
"mdkey":
md5(mobile+pwd+cpwd+sms_captcha+nick_name+partner+key)
},
"para":
{
"mobile":
"注册手机号",
"pwd":
"密码",
"cpwd":
"确认密码",
"sms_captcha":
"手机接收的验证码",
"nick_name":
"昵称"
}
}
输入参数说明:
合作者ID不可空partnerStringa4bf5363f7bd76c5a4975b75f19f63cahead
合作者KEY不可空keyStringldingadmin
MD5加密字符不可空mdkeyStringa4bf5363f7bd76c5a4975b75f19f63ca
md5(mobile+pwd+c
pwd+sms_captcha+
nick_name+partner+
key)
用户名,目前为接不可空user_nameStringuserpara收验证码手机号(mobile)
手机验证码不可空sms_captchaString678459
密码6-20位字符不可空pwdString123456
确认密码6-20位字不可空cpwdString123456
符
昵称可为空nick_nameStringoheyou
返回码描述:
错误码:
{
"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
}
}
正确返回码说明:
"head":
{返回码,10000成codeStringhead功,其他值失败"code":
"10000",
"msg":
"恭喜,注册成功~"返回码提示信息msgString
}
注册用户名"para":
{user_nameString(5-25)para"user_name":
"user",
"phone_mob":
"user",注册手机号phone_moString(11)
"nick_name":
"oheyou",b
"status":
1,昵称nick_namString
"user_id":
263e
}状态statusint
注册用户iduser_idint
发送手机验证码
URL:
输入参数:
request={
"head":
{
"partner":
"77b872abfe2d91",
"key":
"ldingadmin",
"mdkey":
md5(partner+key)
},
"para":
{
"mobile":
"用户手机号"
}
}
输入参数说明:
合作者ID不可空partnerStringa4bf5363f7bd76c5a4975b75f19f63head
合作者KEY不可空keyStringldingadmin
MD5加密字符不可空mdkeyStringa4bf5363f7bd76c5a4975b75f19f63
md5(partner+key)
接收验证码手机号不可空mobileStringuserpara
返回码描述:
错误码:
{
"head":
{
"code":
"E0005",
"msg":
"手机号码不正确"
}
}
正确返回:
{
"head":
{
"code":
"10000",
"msg":
"短信发送成功"
}
}
真确返回码说明:
"head":
{返回码,10000成codeStringhead功,其他值失败"code":
"10000",
"msg":
"短信发送成功"返回码提示信息msgString
}
用户中心
登录
URL:
输入参数:
request={
"head":
{
"partner":
"77b872abfe2d91",
"key":
"ldingadmin",
"mdkey":
md5(user_name+pwd+partner+key)
},
"para":
{
"user_name":
"用户名",
"pwd":
"密码"
}
}
输入参数说明:
合作者ID不可空partnerStringa4bf5363f7bd76c5a4975b75f19f63cahead
合作者KEY不可空keyStringldingadmin
MD5加密字符不可空mdkeyStringa4bf5363f7bd76c5a4975b75f19f63ca
md5(user_name+pw
d+partner+key)
用户名不可空user_nameStringuserpara(mobile)
密码6-20位字符不可空pwdString123456
返回码描述
错误码:
{
"head":
{
"code":
"E0003",
"msg":
"用户名或密码错误~"
}
}
正确返回:
{
"head":
{
"code":
"10000
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- app 接口 文档 模板