[[TOC]] = 聚超值2.4.0接口文档 = == 一.基本约定 == {{{ 1.开发机、测试机代理地址： mrobot开发机代理：192.168.10.199 端口：1080 mrobot测试机代理：192.168.10.198 端口：1080 电脑网应用端测试环境域名 v72.pconline.com.cn:80 电脑网应用端线上环境域名 best.pconline.com.cn mrobot线上环境域名：mrobot.pconline.com.cn mrobot测试环境域名：v80.pconline.com.cn mrobot开发环境域名：dev40.pconline.com.cn 2.当接口处理正常时，HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 3.当接口处理异常时，HTTP STATUS CODE 返回非200，并且给出具体的错误信息。 { "desc":"给用户的提示放在这里" } 4.接口默认的字符编码是UTF-8，接口需要实现对req-enc和resp-enc参数的支持。 5.所有有写操作的数据接口，必须用POST方式提交，在接口里需要判断提交方式，拒绝GET的调用请求。 6.接口中的JSON字符串，key都用双引号("")包裹，value是字符串类型时，也用双引号("")包裹；是数字类型时，不用引号 7.需要分页的接口，统一返回以下字段: pageNo,pageSize,total 8.wap页的附加信息（JSON格式），用注释的方式放到html代码里，以/*@_HTML_META_START_开头, _HTML_META_END_@*/结尾 9.接口名称以（M）结尾的代表接口经mrobot处理或转发 10.请求数据时，在url上添加3个控制参数（无论是get请求还是post请求，都在url上加） 1）platform：平台，传”ios”或”android”；（PS：为了兼容，爆料详情页iPhone端传的是iOS，注意大小写） 2）v：app版本号，如v2.4.0版本传2.4.0； 3）inReview：苹果审核状态，审核中传1，已发布传0（Android端不传） }}} == 二.接口列表 == == 1 订单管理 == === 1.1订单列表（M） === '''（接口已完成，请连开发机进行调试）'''[[BR]] 需求 {{{ 每个订单新增赔付id字段refundId。 }}} **mrobot接口** > http://mrobot.pconline.com.cn/s/best/buy/orderList.xsp?type=0&pageNo=1&pageSize=10 **后端接口** > http://best.pconline.com.cn/buy/appIntf/order/orderList.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app2.2.0/order#用户订单列表 用户订单列表] **说明** > 请求用户的订单列表 **缓存时间** > 无 **提交方式** > GET **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || pageNo || 第几页 || int || 1 || 是 || || || pageSize || 一页的数据量 || int || 10 || 是 || || || type || 0全部订单；1待付款订单；2待发货订单；3待收货订单；4已完成订单 || int || 0 || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || ||v（写在url上）||版本号||int||0||是||2.4.0版本传v=2.4.0|| ||platform（写在url上）||平台标识||string||”ios”||是||传”ios”或”android”|| ||inReview（写在url上）||审核状态||int||0||iOS必填，Android不填||1-是，0-不是|| **返回格式** > json **返回数据** {{{#!java { status: 1, msg: "请求成功" pageNo: 1, pageSize: 10, total: 20, pageTotal: 2, serviceDate: 111111111111111111 //系统时间毫秒数 data: [ { orderId: 123456, //订单id orderNo: "20151111123321", //订单编号 enName: "ECCO Men's Dress Moccasin Penny Loafer", //商品标题 property: "Size: 42 M EU / 8-8.5 D(M) US|Color: Black", //商品参数 有些商品没有参数 此项为"" imgUrl: "xxx.xxxx...", //商品图片 cnPrice: 123.00, //人民币单价 frPrice: 20.00, //美元单价 itemCnPrice: 123.00 //商品总价 单价*数量 tariffAmountprice: 120.00, //关税 expAmountprice: 123.00, //运费 amountPrice: 100000.00, //订单总价 status: 1, //订单状态 statusDesc: "已取消", //订单状态描述 pastDate: 111111111111111111111, //付款过期时间毫秒数 quantity: 1, //商品数量 mallId: 123, //电商id mallName: "美国亚马逊" //电商名称 refundId: 0 //0未申请赔付 不为0则标示已申请赔付的ID 2.4.0新增 } ] } }}} ---------- === 1.2 订单详情wap页（M） === '''（接口已完成，请连开发机进行调试）'''[[BR]] 需求 {{{ 正文内容增加： 1、增加订单关闭的时间信息； 2、增加关闭订单的原因说明； 3、①如果订单处于待收货，a、未申请赔付，增加申请赔付按钮，协议见备注；b、已申请赔付的，增加赔付详情按钮，协议见备注； ②已收货、等待退税、已退税、等待退款、已退款这几种订单状态，如果订单申请了赔付，则增加跳转赔付详情入口（操作协议：pcaction://see-compensateDetail?orderId={orderId}&refundId={refundId} ）； }}} **mrobot接口** > http://mrobot.pconline.com.cn/x/best-best/buy/appIntf/order/orderDetail.jsp?orderId=1504 **后端接口** > http://best.pconline.com.cn/buy/appIntf/order/orderDetail.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app2.2.0/order#订单详情 订单详情] **说明** > 订单详情 **缓存时间** > 无 **提交方式** > GET **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || orderId || 订单id || int || 0 || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || ||v（写在url上）||版本号||int||0||是||2.4.0版本传v=2.4.0|| ||platform（写在url上）||平台标识||string||”ios”||是||传”ios”或”android”|| ||inReview（写在url上）||审核状态||int||0||iOS必填，Android不填||1-是，0-不是|| **返回格式** > html **返回数据** html页面 ---------- == 2 赔付 == === 2.1 赔付列表（M） === '''（接口已经完成，请连开发机进行调试）'''[[BR]] **mrobot接口** > http://mrobot.pconline.com.cn/s/best/buy/refundList.xsp?pageNo=1&pageSize=20 **后端接口** > http://best.pconline.com.cn/buy/appIntf/refund/refundList.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app/refund#赔付列表 赔付列表] **说明** > 请求用户的赔付列表 **缓存时间** > 无 **提交方式** > GET **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || pageNo || 第几页 || int || 1 || 是 || || || pageSize || 一页的数据量 || int || 10 || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || ||v（写在url上）||版本号||int||0||是||2.4.0版本传v=2.4.0|| ||platform（写在url上）||平台标识||string||”ios”||是||传”ios”或”android”|| ||inReview（写在url上）||审核状态||int||0||iOS必填，Android不填||1-是，0-不是|| **返回格式** > json **返回数据** {{{#!java { status: 1, msg: "请求成功" pageNo: 1, pageSize: 10, total: 20, pageTotal: 2, serviceDate: 111111111111111111 //系统时间毫秒数 data: [ { orderId: 123456 //订单id refundId: 123456 //赔付id refundNo: 1482817 //赔付编号 status: '1' //赔付状态 imgUrl: "xxx.xxxx...", //商品图片 enName: 'ECCO Men's Dress Moccasin Penny Loafer' //商品标题 property: "Size: 42 M EU / 8-8.5 D(M) US|Color: Black" //商品参数 } ] } }}} ---------- === 2.2 申请赔付 === [[BR]] **需求：**[[BR]] 1、新接口；[[BR]] **mrobot接口** > 无 **后端接口** > http://best.pconline.com.cn/buy/appIntf/refund/submitRefund.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app/refund#提交赔付申请 提交赔付申请] **说明** > 提交赔付申请 **缓存时间** > 无 **提交方式** > POST **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || orderId || 订单outerId || int || "" || 是 || || || causeType || 赔付原因 || int || "" || 是 || || || cause || 赔付说明 || string || "" || 是 || || || proofs || 凭证图片，多张图片用","隔开 || string || "" || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || ||v（写在url上）||版本号||int||0||是||2.4.0版本传v=2.4.0|| ||platform（写在url上）||平台标识||string||”ios”||是||传”ios”或”android”|| ||inReview（写在url上）||审核状态||int||0||iOS必填，Android不填||1-是，0-不是|| **返回格式** > json **返回数据** {{{#!java { status: 1, msg: "请求成功" } }}} ---------- === 2.3 取消赔付申请 === [[BR]] **需求：**[[BR]] 1、新接口；[[BR]] **mrobot接口** > 无 **后端接口** > http://best.pconline.com.cn/buy/appIntf/refund/cancelRefund.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app/refund#取消赔付申请 取消赔付申请] **说明** > 取消赔付申请 **缓存时间** > 无 **提交方式** > POST **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || orderId || 订单outerId || int || "" || 是 || || || refundId || 赔付申请id || int || "" || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || ||v（写在url上）||版本号||int||0||是||2.4.0版本传v=2.4.0|| ||platform（写在url上）||平台标识||string||”ios”||是||传”ios”或”android”|| ||inReview（写在url上）||审核状态||int||0||iOS必填，Android不填||1-是，0-不是|| **返回格式** > json **返回数据** {{{#!java { status: 1, msg: "请求成功" } }}} ---------- === 2.4 赔付详情（M） === '''（接口已经完成，请连开发机进行调试）'''[[BR]] **mrobot接口** > http://mrobot.pconline.com.cn/s/best/buy/getRefund.xsp?orderId=1&refundId=2 **后端接口** > http://best.pconline.com.cn/buy/appIntf/refund/getRefund.jsp **后端接口文档** > [http://rdtrac.pc.com.cn/pc_best/wiki/app/refund#获取赔付详情 获取赔付详情] **说明** > 获取赔付详情 **缓存时间** > 无 **提交方式** > GET **是否需要登录** > 是 **参数** ||= 参数名 =||= 参数含义 =||= 类型 =||= 默认值 =||= 是否必须 =||= 备注 =|| || orderId || 订单outerId || int || "" || 是 || || || refundId || 赔付申请id || int || "" || 是 || || || common_session_id(cookie参数) || 登录sessionId || string || "" || 是 || || ||v（写在url上）||版本号||int||0||是||2.4.0版本传v=2.4.0|| ||platform（写在url上）||平台标识||string||”ios”||是||传”ios”或”android”|| ||inReview（写在url上）||审核状态||int||0||iOS必填，Android不填||1-是，0-不是|| **返回格式** > json **返回数据** {{{#!java { result { status: 1, msg: '请求成功', data: { refundId:123456, //赔付申请id orderId:123456, //订单的id refundNo: "1111111111", //赔付编号 status: 1, //赔付状态 statusDesc: "申请审核中", //赔付状态描述 refundRecord:{ //包括多个处理流程的数组 [ refundStatus: 1, //赔付记录状态 refundStatusDesc: '审核赔付中，请耐心等待' //赔付记录状态描述 aduitcustomer: 'rico', //处理人 processingDate: '111111111111' //处理时间（毫秒） processingReason: 'laalla' //处理说明 causeType: 1, //赔付原因 causeTypeDesc: "商品损坏", //赔付说明（退款说明） proofs: "http://url,http://url", //凭证照片,多条以逗号分开 ], ... } } } } }}} ---------- == 备注 == == 1 跳转协议 == {{{ 聚超值HTML页面协议 说明：花括号代表参数值位置，使用时记得去掉花括号并填上对应值。 跳转协议—————————————————————————— ---跳至 爆料终端 pconlinebestbuy://best-buy-article/{topicId}?type={type}&isOfficialPurchasing={isOfficialPurchasing}&isRecommendedTopic={isRecommendedTopic} 跳转参数说明： topicId：爆料id type：爆料类型 //0优惠，1海淘，2 发现，3 晒物，4经验 isOfficialPurchasing：是否支持官方代购 //0不支持，1支持（推送时非必填） isRecommendedTopic：是否推荐爆料（猜你喜欢） //0不是，1是（推送时非必填） ---跳至 优惠券详情 pconlinebestbuy://best-coupon-detail/{giftId} 跳转参数说明： giftId:礼品id（注意，这里是礼品id而不是优惠券id） ---跳至 代购商家 pconlinebestbuy://best-shop-list/{topicId} 跳转参数说明： topicId：爆料id ---跳至 公共webView pconlinebestbuy://best-outer-web/?url={url} 跳转参数说明： url：外链链接 ---跳至 大图浏览 pconlinebestbuy://best-big-photo/{topicId}?curIndex={curIndex} 跳转参数说明： topicId：爆料id curIndex：所点击图片的序号（从0算起） 操作协议—————————————————————— ---关闭页面 pcaction://close ---确认商品 pcaction://finish-choosing?outerId={outerId} 参数说明： outerId：商品编号 -—-立即付款 pcaction://buy-now?orderId={orderId}&amountPrice={amountPrice} 参数说明： orderId：订单id totalPrice：订单总价 ---取消订单 pcaction://cancel-order?orderId={orderId}&status={status} 参数说明： orderId：订单id status：订单状态 ---确认收货 pcaction://confirm-receipt?orderId={orderId} 参数说明： orderId：订单id ---退款详情 pcaction://see-refund?orderId={orderId} 参数说明： orderId：订单id ---查看税单 pcaction://see-taxBill?taxBillImageUrl={taxBillImageUrl} 参数说明： taxBillImageUrl：税单图片链接 ---去申请赔付 v2.4.0新增 pcaction://ask-for-compensate?orderId={orderId} 参数说明： orderId：订单id ---取消赔付 v2.4.0新增 pcaction://cancel-compensate?orderId={orderId}&refundId={refundId} 参数说明： orderId：订单id refundId：赔付id --查看赔付详情 v2.4.0新增 pcaction://see-compensateDetail?orderId={orderId}&refundId={refundId} 参数说明： orderId：订单id refundId：赔付id ---查看 订单详情 pcaction://see-indent-detail?orderId={orderId} 跳转参数说明： orderId：订单id ---查看 物流详情 pcaction://see-transfer-detail?orderId={orderId} 参数说明： orderId：订单id ---查看 全部订单 pcaction://see-my-indents?type={type} 参数说明： type：订单类型 //0全部订单；1待付款订单；2待发货订单；3待收货订单；4已完成订单 ---查看 关于关税 pcaction://about-tariff?text={text} 参数说明： text：关税提示文案 --- 弹窗 pcaction://show-alert?title={title}&msg={msg} 参数说明： title：弹窗标题（可选） msg：弹窗内容（必填） --- 查看 搜索结果 pcaction://search-result?searchViewType={searchViewType}&searchCondition={searchCondition}&title={title} 参数说明： searchViewType：页面类型。0 分类, 1 标签, 2 国内电商, 3 国外电商, 4 关键词 searchCondition：搜索条件。1(分类id), 2(电商名称),3(标签名称),4（关键词） title：标题。 --- 查看 爆料相关优惠券 pcaction://show-topic-coupons?topicId={topicId} 参数说明： topicId：爆料id }}}