便利猫接口文档V1 20

文档版本更新日期密级V1.202017-12-11高便丽猫自动自动贩卖机平台OpenAPI V1.20北京便丽猫网络科技有限公司修订记录版本内容V1.00反扫支付接口初始版本V1.10下单支付接口拆分成下单&支付接口V1.11反扫下单接口更新，糖奶值范围更新；增加饮品温度字段V1.12更新反扫支付流程图V1.20增加提货码功能目录1概述42单机-反扫支付场景41.1反扫支付API基本信息41.2反扫支付流程图51.3反扫支付下单接口51.4反扫支付接口61.5同步发货状态接口73集中-自提场景83.1自提API基本信息83.2自提流程图93.3提货码验证接口92.4同步发货状态接口101 概述便利猫目前支持单机模式-反扫支付(详见章节2)和集中模式-自提（详见章节3）两种交易方式，如下图所示：2 单机-反扫支付场景自助贩卖设备扫码器读取用户“付款码”后，将二维码或条码信息上送至便丽猫平台生成订单并发起支付，支持成功后自助贩卖机开始出货并将出货结果同步至便丽猫平台。1.1 反扫支付API基本信息以下接口通信都采用json格式传输数据,只支持http post请求.编码为UTF-8接口访问地址同/异步返回内容1. 下单/http/mc/createorder同步返回下单结果2. 支付/http/mc/payorder同步返回支付结果3. 通知发货结果/http/mc/deliveryresult同步返回接收成功1.2 反扫支付流程图1.3 反扫支付下单接口用户选择商品后下单,返回待支付金额。接口格式JSON,HTTP,POST访问地址/http/mc/createorder请求参数必选签名类型及范围说明appIdtrue参与string身份标识，便利猫平台为自动贩卖机平台分配唯一身份标识assetIdtrue参与string产生交易的自动贩卖机编号(自动贩卖机平台自己管理的编号)orderNotrue参与string订单编号(自动贩卖机平台上的订单编号)goodsDetailtrue参与object商品信息,解析成json时,按照字段名排序payStyletrue参与string支付方式(参数范围由咖啡机平台提供)counttrue参与string数量,应该等于goods_detail数组的长度totalPricetrue参与string订单总支付金额,整数,以分为单位createTimetrue参与string订单创建时间(毫秒长数字,例: 1510909952561)nonce_strtrue参与string签名的随机数signtruestring签名，签名规则见签名文档数据结构:goodsDetail itemIdtruestring商品ID(自动贩卖机平台上配置的商品id)itemNametruestring商品名称(自动贩卖机平台上的商品名)sugartruestring糖(传数值)：0 无 ,1 一份糖，2 两份糖 3三份糖 以此类推/咖啡机适用milktruestring奶(传数值)：0 无 ,1 一份奶，2 两份奶 3三份奶 以此类推/咖啡机适用pricetruestring商品价格，整数,以分为单位temperaturetruestring温度(传数值):1热,0冷,-1冰;/咖啡机适用响应参数必选类型及范围说明codetruestring状态码:1表示执行成功,其它情况都是0;msgtruestring状态信息,文字actual_feetruestring应付金额(最后付款的时候以这个金额为准)coupon_feetruestring优惠券金额promotion_feetruestring优惠金额total_feetruestring订单总金额1.4 反扫支付接口订单生成后，贩卖机向便丽猫平台提交用户付款码进行付款。接口格式JSON,HTTP,POST访问地址/http/mc/payorder请求参数必选签名类型及范围说明appIdtrue参与string身份标识，便利猫平台为自动贩卖机平台分配唯一身份标识assetIdtrue参与string产生交易的自动贩卖机编号(自动贩卖机平台自己管理的编号)orderNotrue参与string订单编号(自动贩卖机平台上的订单编号)tempcodetrue参与string扫码得到的信息payStyletrue参与string支付方式(参数范围由咖啡机平台提供)totalPricetrue参与string订单总支付金额,整数,以分为单位nonce_strtrue参与string签名的随机数signtruestring签名，签名规则见签名文档返回结果必选类型及范围说明codetruestring状态码:1表示执行成功,其它情况都是0;msgtruestring状态信息,文字1.5 同步发货状态接口自助贩卖机收到出货指令后，将执行结果同步给便利猫平台。接口格式JSON,HTTP,POST访问地址/http/mc/synchdeliveryinfo请求参数必选类型及范围说明appIdtruestring身份标识，便利猫平台为自动贩卖机平台分配唯一身份标识assetIdtruestring产生交易的自动贩卖机编号(自动贩卖机平台自己管理的编号)orderNotruestring订单编号(自动贩卖机平台上的订单编号)deliverytruestring发货结果(传数值):1已发货,-1发货失败;deliveryMsgfalsestring发货结果相关的其它文字描述,比如发货失败的原因可以写在这里deliveryTimetruestring发货时间(毫秒长数字,例: 1510909952561)nonce_strtruestring签名的随机数signtruestring签名，签名规则见签名文档返回结果必选类型及范围说明codetruestring状态码:1表示已成功接收信息,其它情况都是0;goodsDetailtrueobject商品信息,解析成json时,按照字段名排序msgtruestring状态信息,文字3 集中-自提场景用户通过线上APP下单并支付自动成功后获得提货码后，通过自动贩卖机扫描或输入提货码，获得商品。3.1 自提API基本信息以下接口通信都采用json格式传输数据,只支持http post请求.编码为UTF-8接口访问地址同/异步返回内容1. 提货码验证/http/mc/checkcode同步返回验证结果2. 通知发货结果/http/mc/deliveryresult同步返回接收成功3.2 自提流程图3.3 提货码验证接口贩卖机向便丽猫平台提交用户输入的提货码进行验证。接口格式JSON,HTTP,POST访问地址/http/mc/checkcode请求参数必选签名类型及范围说明appIdtrue参与string身份标识，便利猫平台为自动贩卖机平台分配唯一身份标识assetIdtrue参与string生交易的自动贩卖机编号(自动贩卖机平台自己管理的编号)orderNotrue参与string订单编号(自动贩卖机平台上的订单编号)tempcodetrue参与string扫码器或者用户输入获取到的提货码信息nonce_strtrue参与string签名的随机数signtruestring签名，签名规则见签名文档返回结果必选类型及范围说明codetruestring取货码状态 1：提货码可以使用；2:输入的提货码不存在3：提货码已使用；4：提货码已过期 /只有1的时候验证通过可以出货，其他情况验证不通过goodsDetailtrueobject商品信息,解析成json时,按照字段名排序msgtruestring状态信息,文字数据结构:goodsDetail itemIdtruestring商品ID(自动贩卖机平台上配置的商品id)itemNametruestring商品名称(自动贩卖机平台上的商品名)pricetruestring商品价格，整数,以分为单位sugarfalsestring糖(传数值)：0 无 ,1 一份糖，2 两份糖 3三份糖 以此类推/咖啡机适用，如果咖啡机支持milkfalsestring奶(传数值)：0 无 ,1 一份奶，2 两份奶 3三份奶 以此类推/咖啡机适用，如果咖啡机支持temperaturefalsestring温度(传数值):1热,0冷,-1冰;/咖啡机适用，如果咖啡机支持3.4 同步发货状态接口【同1.5发货接口】自助贩卖机收到出货指令后，将执行结果同步给便利猫平台。接口格式JSON,HTTP,POST访问地址/http/mc/synchdeliveryinfo请求参数必选类型及范围说明appIdtruestring身份标识，便利猫平台为自动贩卖机平台分配唯一身份标识assetIdtruestring产生交易的自动贩卖机编号(自动贩卖机平台自己管理的编号)orderNotruestring订单编号(自动贩卖机平台上的订单编号)deliverytruestring发货结果(传数值):1已发货,-1发货失败;deliveryMsgfalsestring发