| | 1 | [[TOC]] |
| | 2 | |
| | 3 | = 聚超值2.2.0接口文档 = |
| | 4 | |
| | 5 | == 一.基本约定 == |
| | 6 | |
| | 7 | {{{ |
| | 8 | 1.开发机、测试机代理地址: |
| | 9 | mrobot开发机代理:192.168.10.199 端口:1080 |
| | 10 | mrobot测试机代理:192.168.10.198 端口:1080 |
| | 11 | 电脑网应用端测试环境域名 v72.pconline.com.cn:8002 |
| | 12 | 电脑网应用端线上环境域名 best.pconline.com.cn |
| | 13 | mrobot线上环境域名:mrobot.pconline.com.cn |
| | 14 | mrobot测试环境域名:v80.pconline.com.cn |
| | 15 | mrobot开发环境域名:dev40.pconline.com.cn |
| | 16 | |
| | 17 | 2.当接口处理正常时,HTTP STATUS CODE 返回给200。包括有正常的业务数据和数据为空的情况。 |
| | 18 | |
| | 19 | 3.当接口处理异常时,HTTP STATUS CODE 返回非200,并且给出具体的错误信息。 |
| | 20 | { |
| | 21 | "desc":"给用户的提示放在这里" |
| | 22 | } |
| | 23 | |
| | 24 | 4.接口默认的字符编码是UTF-8,接口需要实现对req-enc和resp-enc参数的支持。 |
| | 25 | |
| | 26 | 5.所有有写操作的数据接口,必须用POST方式提交,在接口里需要判断提交方式,拒绝GET的调用请求。 |
| | 27 | |
| | 28 | 6.接口中的JSON字符串,key都用双引号("")包裹,value是字符串类型时,也用双引号("")包裹;是数字类型时,不用引号 |
| | 29 | |
| | 30 | 7.需要分页的接口,统一返回以下字段: pageNo,pageSize,total |
| | 31 | |
| | 32 | }}} |
| | 33 | |
| | 34 | |
| | 35 | == 二.接口列表 == |
| | 36 | |
| | 37 | ---------- |
| | 38 | |
| | 39 | == 备注 == |
| | 40 | == 1 跳转协议 == |
| | 41 | |
| | 42 | {{{ |
| | 43 | |
| | 44 | 聚超值V2.3.0跳转协议 |
| | 45 | |
| | 46 | 说明:花括号代表参数值位置,使用时记得去掉花括号并填上对应值。 |
| | 47 | |
| | 48 | 跳转协议—————————————————————————— |
| | 49 | |
| | 50 | ---跳至 爆料终端 |
| | 51 | pconlinebestbuy://best-buy-article/{topicId}?type={type}&isOfficialPurchasing={isOfficialPurchasing} |
| | 52 | 跳转参数说明: |
| | 53 | topicId:爆料id |
| | 54 | type:爆料类型 //0优惠,1海淘,2 发现,3 晒物,4经验 |
| | 55 | isOfficialPurchasing:是否支持官方代购 //0不支持,1支持 |
| | 56 | |
| | 57 | |
| | 58 | ---跳至 优惠券详情 |
| | 59 | pconlinebestbuy://best-coupon-detail/{giftId} |
| | 60 | 跳转参数说明: |
| | 61 | giftId:礼品id(注意,这里是礼品id而不是优惠券id) |
| | 62 | |
| | 63 | ---跳至 代购商家 |
| | 64 | pconlinebestbuy://best-shop-list/{topicId} |
| | 65 | 跳转参数说明: |
| | 66 | topicId:爆料id |
| | 67 | |
| | 68 | ---跳至 公共webView |
| | 69 | pconlinebestbuy://best-outer-web/?url={url} |
| | 70 | 跳转参数说明: |
| | 71 | url:外链链接 |
| | 72 | |
| | 73 | ---跳至 大图浏览 |
| | 74 | pconlinebestbuy://best-big-photo/{topicId}?curIndex={curIndex}&imgUrl={imgUrl} |
| | 75 | 跳转参数说明: |
| | 76 | topicId:爆料id |
| | 77 | curIndex:所点击图片的序号(从0算起) |
| | 78 | imgUrl:所点击图片的地址链接 |
| | 79 | |
| | 80 | |
| | 81 | 操作协议—————————————————————— |
| | 82 | ---关闭页面 |
| | 83 | pcaction://close |
| | 84 | |
| | 85 | ---确认商品 |
| | 86 | pcaction://finish-choosing?outerId={outerId} |
| | 87 | 参数说明: |
| | 88 | outerId:商品编号 |
| | 89 | |
| | 90 | -—-立即付款 |
| | 91 | pcaction://buy-now?orderId={orderId}&amountPrice={amountPrice} |
| | 92 | 参数说明: |
| | 93 | orderId:订单id |
| | 94 | totalPrice:订单总价 |
| | 95 | |
| | 96 | ---取消订单 |
| | 97 | pcaction://cancel-order?orderId={orderId}&status={status} |
| | 98 | 参数说明: |
| | 99 | orderId:订单id |
| | 100 | status:订单状态 |
| | 101 | |
| | 102 | ---确认收货 |
| | 103 | pcaction://confirm-receipt?orderId={orderId} |
| | 104 | 参数说明: |
| | 105 | orderId:订单id |
| | 106 | |
| | 107 | ---退款详情 |
| | 108 | pcaction://see-refund?orderId={orderId} |
| | 109 | 参数说明: |
| | 110 | orderId:订单id |
| | 111 | |
| | 112 | ---查看税单 |
| | 113 | pcaction://see-taxBill?taxBillImageUrl={taxBillImageUrl} |
| | 114 | 参数说明: |
| | 115 | taxBillImageUrl:税单图片链接 |
| | 116 | |
| | 117 | ---查看 订单详情 |
| | 118 | pcaction://see-indent-detail?orderId={orderId} |
| | 119 | 跳转参数说明: |
| | 120 | orderId:订单id |
| | 121 | |
| | 122 | ---查看 物流详情 |
| | 123 | pcaction://see-transfer-detail?orderId={orderId} |
| | 124 | 参数说明: |
| | 125 | orderId:订单id |
| | 126 | |
| | 127 | ---查看 全部订单 |
| | 128 | pcaction://see-my-indents?type={type} |
| | 129 | 参数说明: |
| | 130 | type:订单类型 //0全部订单;1待付款订单;2待发货订单;3待收货订单;4已完成订单 |
| | 131 | |
| | 132 | ---查看 关于关税 |
| | 133 | pcaction://about-tariff?text={text} |
| | 134 | 参数说明: |
| | 135 | text:关税提示文案 |
| | 136 | |
| | 137 | --- 弹窗 |
| | 138 | pcaction://show-alert?title={title}&msg={msg} |
| | 139 | 参数说明: |
| | 140 | title:弹窗标题(可选) |
| | 141 | msg:弹窗内容(必填) |
| | 142 | |
| | 143 | --- 查看 搜索结果 |
| | 144 | pcaction://search-result?searchType={searchType}&searchCondition={searchCondition}§ionId={sectionId} |
| | 145 | 参数说明: |
| | 146 | searchType:搜索类型。1 按分类搜索, 2 按电商搜索, 3 按标签搜索, 4 按关键词搜索 |
| | 147 | searchCondition:搜索条件。1(分类id), 2(电商名称),3(标签名称),4(关键词) |
| | 148 | sectionId:默认选择的列表类型。 0优惠,1海淘,2 发现,3 晒物,4经验 |
| | 149 | |
| | 150 | --- 查看 爆料相关优惠券 |
| | 151 | pcaction://show-topic-coupons?topicId={topicId} |
| | 152 | 参数说明: |
| | 153 | topicId:爆料id |
| | 154 | |
| | 155 | |
| | 156 | }}} |