用于流量方接入口碑广告平台后,通过渠道和地理位置查询券列表的接口。该接口是授权页面接口,流量方首先完成用户的授权操作,然后通过SDK接口获取查询的URL地址,并引导用户跳转口碑。用户在口碑页面查询并领券。
环境 | HTTPS请求地址 |
---|---|
正式环境 | https://openapi.alipay.com/gateway.do |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
app_id | String | 是 | 32 | 支付宝分配给开发者的应用ID | 2014072300007148 |
method | String | 是 | 128 | 接口名称 | koubei.advert.delivery.discount.authweb.batchquery |
format | String | 否 | 40 | 仅支持JSON | JSON |
return_url | String | 否 | 256 | HTTP/HTTPS开头字符串 | https://m.alipay.com/Gk8NF23 |
charset | String | 是 | 10 | 请求使用的编码格式,如utf-8,gbk,gb2312等 | utf-8 |
sign_type | String | 是 | 10 | 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 | RSA2 |
sign | String | 是 | 344 | 商户请求参数的签名串,详见签名 | 详见示例 |
timestamp | String | 是 | 19 | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" | 2014-07-24 03:07:50 |
version | String | 是 | 3 | 调用的接口版本,固定为:1.0 | 1.0 |
auth_token | String | 是 | 40 | 针对用户授权接口,获取用户相关数据时,用于标识用户授权关系。详见用户信息授权 | |
app_auth_token | String | 否 | 40 | 详见应用授权概述 | |
biz_content | String | 是 | - | 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档 |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
shop_id | String | 可选 | 32 | 门店ID,如果设置门店,则查询门店下发行的券 | 2015072900077000000001362202 |
latitude | String | 可选 | 32 | 纬度,根据经纬度查询附近的券 | 31.22967 |
longitude | String | 可选 | 32 | 经度,根据经纬度查询附近的券 | 121.4762 |
channel | String | 可选 | 32 | 分配的固定的渠道CODE,需要找运营申请 | yufabu |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|---|---|---|---|---|
code | String | 是 | - | 网关返回码,详见文档 | 40004 |
msg | String | 是 | - | 网关返回码描述,详见文档 | Business Failed |
sub_code | String | 否 | - | 业务返回码,详见文档 | ACQ.TRADE_HAS_SUCCESS |
sub_msg | String | 否 | - | 业务返回码描述,详见文档 | 交易已被支付 |
sign | String | 是 | - | 签名,详见文档 | DZXh8eeTuAHoYE3w1J+POiPhfDxOYBfUNn1lkeT/V7P4zJdyojWEa6IZs6Hz0yDW5Cp/viufUb5I0/V5WENS3OYR8zRedqo6D+fUTdLHdc+EFyCkiQhBxIzgngPdPdfp1PIS7BdhhzrsZHbRqb7o4k3Dxc+AAnFauu4V6Zdwczo= |
参数 | 类型 | 是否必填 | 最大长度 | 描述 | 示例值 |
---|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | AlipayClient alipayClient = new DefaultAlipayClient( "https://openapi.alipay.com/gateway.do" , "app_id" , "your private_key" , "json" , "GBK" , "alipay_public_key" , "RSA2" ); KoubeiAdvertDeliveryDiscountAuthwebBatchqueryRequest request = new KoubeiAdvertDeliveryDiscountAuthwebBatchqueryRequest(); request.setBizContent( "{" + "\"shop_id\":\"2015072900077000000001362202\"," + "\"latitude\":\"31.22967\"," + "\"longitude\":\"121.4762\"," + "\"channel\":\"yufabu\"" + " }" ); KoubeiAdvertDeliveryDiscountAuthwebBatchqueryResponse response = alipayClient.pageExecute(request,accessToken); if (response.isSuccess()){ System.out.println( "调用成功" ); } else { System.out.println( "调用失败" ); } |
1 2 3 4 5 6 7 | { "koubei_advert_delivery_discount_authweb_batchquery_response" :{ "msg" : "Success" , "code" : "10000" }, "sign" : "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" } |
1 2 3 4 5 6 7 8 9 | { "koubei_advert_delivery_discount_authweb_batchquery_response" :{ "msg" : "Service Currently Unavailable" , "code" : "20000" , "sub_msg" : "系统繁忙" , "sub_code" : "isp.unknow-error" }, "sign" : "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE" } |
错误码 | 错误描述 | 解决方案 |
---|---|---|
INVALID_PARAMETER | 参数有误 | 根据提示处理 |
SYSTEM_ERROR | 系统繁忙 | 重试 |