基础说明
业务流程
1、用户安装App后首次打开App,需执行安装统计请求接口进行统计安装情况:http(https)://{域名}/api/Statis/Anstall
2、在游客模式下,除了登录相关接口可以访问外,其他接口都需要token才能访问,所以,当用户没有登录的情况下需静默请求一个匿名登录token,以便访问授权接口,当用户登录后再将其替换,接口地址:
http(https)://{域名}/api/login/Guest
请求头Headers
【参数名:app_id】App应用唯一Id,生成规则,如果能获取设备唯一Id那就有限取设备唯一Id,如果不能,则生成一个GUID(去掉“-”短横线),用于标记客户端应用的唯一标识
【参数名:app_ver】App版本号,用于记录当前用户所安装使用的应用版本
【参数名:app_pack】App包名,用于上报当前客户端应用类型
【参数名:app_deviceid】设备Id号,获取代表设备的唯一Id,如果没有获取到,则为空
【参数名:app_channel】App来源渠道,用于区分不同的应用市场和推广链接下下载的应用
【参数名:app_model】设备型号,用于记录当前用户所使用的设备型号
响应Json格式
普通数据响应:
{
"state":0, //返回状态码,0表示执行成功
"msg":"ok",
"data":object //返回数据,根据请求的结果返回不同类型
}
分页列表数据响应:
{
"state":0, //返回状态码,0表示执行成功
"msg":"ok",
"data":{
"pageIndex":1, //当先页号
"pageSize":20, //每页获取数据量
"totalCount":100, //数据总量
"items":[ object1, object2 ....] //返回的数据列表
}
}
{
"state":500, //返回状态码,大于 0 表示执行失败,详细状态码说明查阅【返回状态码】
"msg":"执行失败原因",
}
状态码
| 状态码(state) | 说明 | 备注 |
|---|---|---|
| 0 | 执行成功 | |
| 401 | 未登录或登录失效 | |
| 407 | 没有权限 | |
| 500 | 系统异常 | |
| 5000 | 业务异常 | |
| > 5000 | 大于5000的状态码都属于业务异常状态码,msg可以直接弹出显示 |
文件上传
目前我们使用的是七牛云的云存储,所以客户端需要使用七牛云的SDK进行上传
SDK地址
上传流程:
1、获取七牛云的授权token,获取接口【/api/Files/GetToken】 ,返回值当中包含token有效期字段,需要注意根据有效期来编写相关逻辑
2、上传文件命名规则:{用户Id}_{自定义}.{扩展名},如果没有用户Id,则生成6位随机数,注意:最好不要使用中文文件名
3、上传至云端文件夹(云端存储文件夹名),默认情况下客户端为“user”+/日期,也就是七牛中的key:user/yyyyMMdd/文件名,也可直接使用获取token接口中返回的前缀信息
4、扩展参数:k:userid - 用户id号(如果存在),k:func - 所属功能(如:在线咨询、上报评估等)
5、文件域名,在获取token接口中有返回
6、七牛文件域名:http://apg.file.loveclip.cn
1、获取七牛云的授权token,获取接口【/api/Files/GetToken】 ,返回值当中包含token有效期字段,需要注意根据有效期来编写相关逻辑
2、上传文件命名规则:{用户Id}_{自定义}.{扩展名},如果没有用户Id,则生成6位随机数,注意:最好不要使用中文文件名
3、上传至云端文件夹(云端存储文件夹名),默认情况下客户端为“user”+/日期,也就是七牛中的key:user/yyyyMMdd/文件名,也可直接使用获取token接口中返回的前缀信息
4、扩展参数:k:userid - 用户id号(如果存在),k:func - 所属功能(如:在线咨询、上报评估等)
5、文件域名,在获取token接口中有返回
6、七牛文件域名:http://apg.file.loveclip.cn
APP页面
首页

获取首页类目列表:
http://{域名}/api/Categorys/HomeList
http://{域名}/api/Categorys/HomeList
获取首页商品列表:
http://{域名}/api/Goods/GetHomeList
http://{域名}/api/Goods/GetHomeList
品牌类目

搜索框通过关键词搜索产品的接口尚未规划....
获取类目列表接口:
http://{域名}/api/Categorys/List
http://{域名}/api/Categorys/List
根据类目获取获取品牌列表接口:
http://{域名}/api/Brands/GetCateList
http://{域名}/api/Brands/GetCateList
在线咨询

咨询自动应答接口:
http://{域名}/api/Consults/Answer
请求参数:
响应参数:
http://{域名}/api/Consults/Answer
请求参数:
{
"orderId": 0, // 订单id,非必传,如果有则传
"question": "",//咨询问题
"quesType": 0,//问题内容类型:1-文本内容,2-文件地址
"matchType": 0 //自动应答匹配方式,1-智能,2-精准(特殊情况下后台会根据问题精准完整匹配问答库关键词)
}
"orderId": 0, // 订单id,非必传,如果有则传
"question": "",//咨询问题
"quesType": 0,//问题内容类型:1-文本内容,2-文件地址
"matchType": 0 //自动应答匹配方式,1-智能,2-精准(特殊情况下后台会根据问题精准完整匹配问答库关键词)
}
响应参数:
{"answers": //回答列表,有时候自动应答可能存在多条应答消息
[ {
"data": "", //消息内容
"dtype": 0,//消息内容类型,(1:文本,2:图片,3:视频,4:文件,5:二维码,6:电话号码),客户端可根据该类型使用不同的呈现方式
"act": 0,//行为动作,100以内预留,暂定固定行为:101:呈现加微信引导gif动图
"actdata": ""//行为动作所需要的参数,如:101行为的参数值为一个gif图片地址
} ]}
[ {
"data": "", //消息内容
"dtype": 0,//消息内容类型,(1:文本,2:图片,3:视频,4:文件,5:二维码,6:电话号码),客户端可根据该类型使用不同的呈现方式
"act": 0,//行为动作,100以内预留,暂定固定行为:101:呈现加微信引导gif动图
"actdata": ""//行为动作所需要的参数,如:101行为的参数值为一个gif图片地址
} ]}
登录注册

通过手机号验证码登录接口:
http://{域名}/api/login/PhoneSms
http://{域名}/api/login/PhoneSms
获取验证码接口:
http://{域名}/api/Sms/SendCode
http://{域名}/api/Sms/SendCode
注意:频繁测试的时候会有发送量限制,所以可以使用测试发送验证码接口进行获取验证码:
http://{域名}/api/Sms/TestSendCode
http://{域名}/api/Sms/TestSendCode
通过手机号一键快捷登录接口:
http://{域名}/api/login/PhoneQuick
http://{域名}/api/login/PhoneQuick



