示例
网关地址 http://39.96.16.242:9999 测试地址 http://192.168.19.147:9999
这句话非常非常重要,先调用授权接口-》验证用户/api/applet/client/ClientExists接口如果返回false,调用授权电话接口-》最后再去调用用户信息接口,注意每次调用login接口要把用户信息带上
对于邀请的人提交凭证,提交凭证的时候先调用此接口拿到openid ...//ClientExists 无论返回true/false 都直接授权个人信息,直接提交凭证,不用登陆
添加平台信息
更新平台信息//2020-12-02新加
{
string OpenId=1;
//openID
string PlatFormName=2;
//平台名称
string PlatFormLink=3;
//平台连接
string PlatFormUserName=4;//平台用户名
}
post:/api/applet/client/UpdatePlatFormInfo
<<<
success
{
"msg": "ok",
"result": {
修改揭开锅
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
订单Tab获取接口//2020-23新加
{
string OpenId="";//
}
post:/api/applet/order/GetCountTab
<<<
success
{
"msg": "ok",
"result": {
活动tab 名称和数量
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
商家审核//2020-23新加
{
int32 Id=2;//
}
post:/api/applet/merchant/RemoveMerchants
<<<
success
{
"msg": "ok",
"result": {
是否操作成功
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
活动置顶//2020-19新加
{
int32 Id=3;//活动id
}
post:/api/applet/active/SetTopActive
<<<
success
{
"msg": "ok",
"result": {
.是否置顶成功
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
查询会员列表//2020-19新加
{
int32 PageIndex=1;
int32 PageMax=10;
string LikeName=6;
//会员模糊搜索
int32 MerchantId=3;//商家id 传0时查所有
}
post:/api/applet/merchantMembers/PageSerachMerchantMember
<<<
success
{
"msg": "ok",
"result": {
.会员列表
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
冻结,解冻会员//2020-19新加
{
int32 MerchantId=1;
int32 OpenId=10;
bool MemberStatus=true/false
}
post:/api/applet/merchantMembers/FreezeMerchantMember
<<<
success
{
"msg": "ok",
"result": {
操作结果
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
用户上传支付二维码接口和修改用户微信接口//2020-18新加
{
"OpenId":"openid",
"PayQCode":"二维码链接",
"RealName":"微信号",
}
post:/api/applet/client/UpdateUserInfo
<<<
success
{
"msg": "ok",
"result": {
....用户信息
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
查询退款凭证,用于修改凭证//2020-18新加
{
"OrderId":"orderid",
"OpenId":"用户openID"
}
post:/api/applet/ordersJoins/SerachOrdersJoinsDetais
<<<
success
{
"msg": "ok",
"result": {
....用户信息
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
查询退款列表//新加 当RefundStatus为0时才可以退款
{
"PageIndex":1,
"PageMax":10,
"LikeName":"123qwe",//退款模糊查询
}
post:/api/applet/refund/PageSerachRefund
<<<
success
{
"msg": "ok",
"result": {
"Id": 1//退款编号
"OrderId": 10//订单id
"OrderNo": 100,//订单号
"OpenId": 10,//
"AvatarUrl": 100,//头像
"RealName": 1,//退款人昵称
"RefundType": 10,//退款类型 1微信/2现金
"RefundMoney": 1,//退款金额
"RefundRemark": "退款备注",
"RefundStatus": 退款状态 -1 拒绝/0退款中 1同意
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
退款审核接口//新加
{
"Id": 1//退款编号
"OrderId": 10//订单id
"RefundMoney": 100,//退款金额
"RefundType": 10,//退款类型 1微信/2现金
"RefundRemark": "退款备注",
"RefundStatus": 退款状态 -1 拒绝/0退款中 1同意
}
post:/api/applet/refund/PageSerachRefund
<<<
success
{
"msg": "ok",
"result": {
"Id": 1//退款编号
"OrderId": 10//订单id
"OrderNo": 100,//订单号
"OpenId": 10,//
"AvatarUrl": 100,//头像
"RealName": 1,//退款人昵称
"RefundType": 10,//退款类型 1微信/2现金
"RefundMoney": 1,//退款金额
"RefundRemark": "退款备注",
"RefundStatus": 退款状态 -1 拒绝/0退款中 1同意
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
新加电话授权接口//新加
{
"OpenId":"****",//ClientExists返回
"Code":"***"/,/login授权码
"ClientType":"123qwe",//小程序名称
"Iv":"***",//授权电话号码参数
"EncryptedData":"***"//授权电话号码参数
}
post:/api/applet/client/UpdatePhone
<<<
success
{
"msg": "ok",
"result": {
"isComplete": true//是否授权成功
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
获取商家管理员首页数据只有商家能用,普通商家查询/api/applet/merchant/SerachMerchantDetais//新加
{
"OpenId":"***",//openid
"UserType":""//小程序名称 (褥了么商家版/褥了么)
}
post:/api/applet/client/GetPageData
<<<
success
{
"msg": "ok",
"result": {
"IsAdmin": true//是否是管理员
"ActiveCount": 10//活动数
"MerchantMemberCount": 100//会员数量
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
1、token获取接口
{
"name":"admin",//授权id
"password":"123qwe"//授权密码
}
post:/auth/token
<<<
success
{
"msg": "ok",
"result": {
"accessToken": "网关授权的提token,需要授权的接口都要在请求",
"userId": 1,
"userName": "admin",
"expired": 7200,
"roleId": 1
},
"code": 0
}
<<<
error
这里填写错误的返回码
以此类推,每个状态使用 <<< 分割,
第一行添加状态名称
2、小程序授权验证接口
{
"Code":"登录授权码",//起始页
"ClientType":"小程序名称"//客户端类型 (褥了么商家版/褥了么)//新加
}
post:/api/applet/client/ClientExists
<<<
success
{
"msg": "ok",
"result": {
"isExist": false//存在为true,不存在为false ,false时候拉授权电话》授权信息
},
"code": 0//返回码,仅仅为0时表示成功,其他全部弹出msg
}
<<<
error
{
"msg": "没有任何地址信息。 (Parameter \'Address\')", //错误消息
"result": null,
"code": 2//错误代码
}
3、小程序授权登录接口
{
"Code":"授权码",
"NickName":"昵称",
"AvatarUrl":"头像",
"Gender":0,//性别
"Province" :"省份",
"City" :"城市",
"Phone" :"用户电话",//新加
"Country" :"区域",
"Language" :"语言",
"ClientType":"小程序名称"
}
post:/api/applet/client/Login
<<<
success
{
"msg": "ok",
"result": {
"clientId": 1,
"openId": "123456789",
"nickName": "昵称",
"gender": 0,
"province": "省份",
"avatarUrl": "头像",
"city": "城市",
"country": "区域",
"language": "语言",
"phone": "00000000000",//电话
"realName": "未设置",
"userType": 0,
"isPass": false,
"joinCount": 0,
"joinMoney": "0",
"blacklistType": 0,
"blacklistContent": "未设置"
},
"code": 0
}
<<<
error
{
"msg": "没有任何地址信息。 (Parameter \'Address\')", //错误消息
"result": null,
"code": 2//错误代码
}
4、添加或编辑企业
{
"Id":0,//添加传0,编辑传Id
"MerchantName":"商家名称",
"MerchantAddress":"商家地址",
"MerchantPosition":"商家坐标",
"MerchantWorkDate":"工作日期 :法定节假日除外/全年",
"MerchantWorkTime":"工作时间 全天/9:00~18:00",
"Province" :"省份",
"City" :"城市",
"Country" :"区域",
"Name":"负责人",
"Phone":"负责人电话",
"IsPass":true,//是否直接通过
"Introduction":"企业简介",
"CategoryId":1//企业分类,1234,首页导航栏的分类
}
post:/api/applet/merchant/CreateOrEditMerchants
<<<
success
{
"msg": "ok",
"result": {
"id": 6,
"merchantName": "商家名称",
"province": "省份",
"city": "城市",
"country": "区域",
"merchantAddress": "商家地址",
"merchantPosition": "商家坐标",
"name": "负责人",
"phone": "负责人电话",
"merchantWorkDate": "工作日期 :法定节假日除外/全年",
"merchantWorkTime": "工作时间 全天/9:00~18:00",
"isPass": true,
"tag": "吃,全部",
"introduction": "企业简介",
"activeCounts": 0,
"active": [],商家活动列表
},
"code": 0
}
<<<
error
{
"msg": "没有任何地址信息。 (Parameter \'Address\')", //错误消息
"result": null,
"code": 2//错误代码
}
5、商家分类查询接口,导航栏也使用
{
"CategoryName":"吃"//分类名称
}
post:/api/applet/activesCategory/SerachActivesCategory
<<<
success
{
"msg": "ok",
"result":
[
{
"id": 5,
"pid": 99999,
"icon": "folder-o",//分类图标
"categoryName": "乐"//分类名称
},
{
"id": 4,
"pid": 99999,
"icon": "folder-o",
"categoryName": "玩"
}
]
"code": 0//返回码,仅仅为0时表示成功,其他全部弹出msg
}
<<<
error
{
"msg": "没有任何地址信息。 (Parameter \'Address\')", //错误消息
"result": null,
"code": 2//错误代码
}
6、商家平台查询
{
"platform/SerachPlatform":"美团"//平台名称
}
post:/api/applet/platform/SerachPlatform
<<<
success
{
"msg": "ok",
"result":
[
{
"id": 4,
"platformName": "京东",//平台名称
"platformIcon": "folder-o"//图标
},
{
"id": 4,
"platformName": "京东",//平台名称
"platformIcon": "folder-o"//图标
}
]
"code": 0//返回码,仅仅为0时表示成功,其他全部弹出msg
}
<<<
error
{
"msg": "没有任何地址信息。 (Parameter \'Address\')", //错误消息
"result": null,
"code": 2//错误代码
}
7、管理员发布活动 返回结果需要更新页面
{
"id": 0,//0为插入数据
"platformId": 1,//平台id
"merchantId": 1,//商家id
"categoryId": 1,//分类id
"activeName": "添加营销活动",
"activeDate": "\[{\\"id\\":0,\\"activesId\\":2,\\"date\\":\\"2020-11-03 13:49:45\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1},{\\"id\\":0,\\"activesId\\":1,\\"date\\":\\"2020-11-04 13:50:38\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1},{\\"id\\":0,\\"activesId\\":1,\\"date\\":\\"2020-11-05 13:50:38\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1}\]",//日历库存json字符串
"allowCount": 2,//允许参加次数/人 默认1
"allowPeople": 3,//一次参加人数
"activeMoney": "100",//奖励金
"activeRequire": "2",//活动要求 ,作业个数
"isBookMoney": false,//是否需要预约金
"bookMoney": "0.00",//预约金
"introduction": ""//活动描述
}
post:/api/applet/platform/SerachPlatform
<<<
success
{
"msg": "ok",
"result": {
"id": 7,
"platformId": 1,
"platformName": "大众点评",
"platformIcon": "http://113.125.82.241:8082///File//1006//product//richtext//ed87b97d-12fd-4020-ac2b-67d7169b7977.jpg",
"merchantId": 1,
"merchantName": "北京易去旅行社",
"categoryId": 1,
"categoryName": "全部",
"activeName": "添加营销活动",
"activeDate": "\[{\\"Id\\":13,\\"ActivesId\\":7,\\"Date\\":\\"2020-11-03 13:49:45\\",\\"Stock\\":1,\\"StockPrice\\":\\"200.00\\",\\"BuyNumMax\\":1,\\"BuyNumMin\\":1,\\"StockStatus\\":1},{\\"Id\\":14,\\"ActivesId\\":7,\\"Date\\":\\"2020-11-04 13:50:38\\",\\"Stock\\":1,\\"StockPrice\\":\\"200.00\\",\\"BuyNumMax\\":1,\\"BuyNumMin\\":1,\\"StockStatus\\":1},{\\"Id\\":15,\\"ActivesId\\":7,\\"Date\\":\\"2020-11-05 13:50:38\\",\\"Stock\\":1,\\"StockPrice\\":\\"200.00\\",\\"BuyNumMax\\":1,\\"BuyNumMin\\":1,\\"StockStatus\\":1}\]",
"allowCount": 2,
"allowPeople": 3,
"activeMoney": "100.00",
"activeRequire": "2",
"isBookMoney": false,
"bookMoney": "0.00",
"introduction": "",
"city": "四川成都-武侯区",
"address": "四川大学-科研综合楼414",
"position": "104.077167294,30.630182986",
"tag": "\[\\"温泉\\",\\"酒店\\"\]",
"stock": \[
{
"id": 13,
"activesId": 7,
"date": "2020-11-03 13:49:45",
"stock": 1,
"stockPrice": "200.00",
"buyNumMax": 1,
"buyNumMin": 1,
"stockStatus": 1
},
{
"id": 14,
"activesId": 7,
"date": "2020-11-04 13:50:38",
"stock": 1,
"stockPrice": "200.00",
"buyNumMax": 1,
"buyNumMin": 1,
"stockStatus": 1
}
]
},
"code": 0
}
<<<
error
{
"msg": "没有任何地址信息。 (Parameter \'Address\')", //错误消息
"result": null,
"code": 2//错误代码
}
8、查询活动列表
{
"PageIndex":1,
"PageMax":10,
"PlatformId":1,//平台id
"MerchantId":1,//商家id
"CategoryId":1,//分类id
"LikeName":"",//模糊字段
"Area":""//区域 成都市,武侯区、四川省都行
}
post:/api/applet/active/PageSerachActives
<<<
success
{
"msg": "ok",
"result": {
"datas": [
{
"id": 9,
"platformId": 1,
"platformName": "美团",
"platformIcon": "folder-o",
"merchantId": 1,
"merchantName": "北京易去旅行社",
"categoryId": 2,
"categoryName": "吃",
"activeName": "添加营销活动2222",
"activeDate": "\[{\\"id\\":0,\\"activesId\\":2,\\"date\\":\\"2020-11-03 13:49:45\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1},{\\"id\\":0,\\"activesId\\":1,\\"date\\":\\"2020-11-04 13:50:38\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1},{\\"id\\":0,\\"activesId\\":1,\\"date\\":\\"2020-11-05 13:50:38\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1}\]",
"allowCount": 2,
"allowPeople": 3,
"activeMoney": "100.00",
"activeRequire": "2",
"isBookMoney": false,
"bookMoney": "0.00",
"introduction": "",
"city": "四川成都-武侯区",
"address": "四川大学-科研综合楼414",
"position": "104.077167294,30.630182986",
"tag": "吃" //分类标签
}
],
"total": 1
},
"code": 0
}
<<<
error
{
"msg": "没有任何地址信息。 (Parameter \'Address\')", //错误消息
"result": null,
"code": 2//错误代码
}
9、查询活动详情
{
"platform/SerachPlatform":"美团"//平台名称
}
post:/api/applet/platform/SerachPlatform
<<<
success
{
"msg": "ok",
"result": {
"id": 9,
"platformId": 1,
"platformName": "美团",
"platformIcon": "folder-o",
"merchantId": 1,
"merchantName": "北京易去旅行社",
"categoryId": 2,
"categoryName": "吃",
"activeName": "添加营销活动2222",
"activeDate": "\[{\\"id\\":0,\\"activesId\\":2,\\"date\\":\\"2020-11-03 13:49:45\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1},{\\"id\\":0,\\"activesId\\":1,\\"date\\":\\"2020-11-04 13:50:38\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1},{\\"id\\":0,\\"activesId\\":1,\\"date\\":\\"2020-11-05 13:50:38\\",\\"stock\\":1,\\"stockPrice\\":\\"200.00\\",\\"buyNumMax\\":1,\\"buyNumMin\\":1,\\"stockStatus\\":1}\]",
"allowCount": 2,
"allowPeople": 3,
"activeMoney": "100.00",
"activeRequire": "2",
"isBookMoney": false,
"bookMoney": "0.00",
"introduction": "",
"city": "四川成都-武侯区",
"address": "四川大学-科研综合楼414",
"position": "104.077167294,30.630182986",
"tag": "吃",
"stock": [//库存
{
"id": 34,
"activesId": 9,
"date": "2020-11-03 13:49:45",
"stock": 1,
"stockPrice": "200.00",
"buyNumMax": 1,
"buyNumMin": 1,
"stockStatus": 1
}
]
},
"code": 0
}
<<<
error
{
"msg": "没有任何地址信息。 (Parameter \'Address\')", //错误消息
"result": null,
"code": 2//错误代码
}
10、商家列表查询
{
"PageIndex":1,
"PageMax":10,
"CategoryId":1,//分类id
"MerchantName":"",//商家名称
}
post:/api/applet/merchant/PageSerachMerchant
11、商家详情查询
{
"Id":1,//商家id
}
post:/api/applet/merchant/SerachMerchantDetais
12、编辑更新商家
{
"Id":0,//添加传0,编辑传Id
"MerchantName":"商家名称",
"MerchantAddress":"商家地址",
"MerchantPosition":"商家坐标",
"MerchantWorkDate":"工作日期 :法定节假日除外/全年",
"MerchantWorkTime":"工作时间 全天/9:00~18:00",
"Province" :"省份",
"City" :"城市",
"Country" :"区域",
"Name":"负责人",
"Phone":"负责人电话",
"IsPass":true,//是否直接通过
"Introduction":"企业简介",
"CategoryId":1//企业分类,1234,首页导航栏的分类
}
post:/api/applet/merchant/CreateOrEditMerchants
13、订单分页查询 不知道什么意思的传 0或者 ""
{
"PageIndex":1,//商家id
"PageMax":10,
"OpenId":"",
"MerchantId":0,
"ActiveId":0,
"OrderStatus":0,
"RefundStatus ":0,
"StartTime":"",
"EndTime":"",
"PayType":""
}
post:/api/applet/order/PageSerachOrders
14、订单详情查询
{
"Id":1,//订单id
}
post:/api/applet/order/SerachOrderDetais
15、创建订单
{
"Id":0,//订单id 创建传0 ,修改传订单id
"PlatformId ":10,
"MerchantId":"",
"ActiveId ":0,
"OpenId ":0,
"ClientType":"",
"BookingTime":"",//预约到店时间
"PayType":""
}
post:/api/applet/order/CreateOrEditOrder
16、文件上传接口 --无需授权
在body中添加 form-data数据 一个文件,一个模块
{
"file":"文件",
"model":"order/merchant/client...."//其中之一
}
post:/api/UploadImage
17、文件删除接口 --无需授权
在body中添加 form-data数据 一个文件,一个模块
{
"file":"文件名,不带传输路径",
"model":"order/merchant/client...."//其中之一
}
post:/api/DeleteImage