koubei.marketing.data.nearmall.query(周边商圈查询) 在线调试(沙箱环境)

用户周边商圈查询

公共参数

请求地址

环境HTTPS请求地址
正式环境 https://openapi.alipay.com/gateway.do

公共请求参数

参数 类型 是否必填最大长度描述示例值
app_id String 32 支付宝分配给开发者的应用ID 2014072300007148
method String 128 接口名称 koubei.marketing.data.nearmall.query
format String 40 仅支持JSON JSON
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
app_auth_token String 40 详见应用授权概述
biz_content String 请求参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递,具体参照各产品快速接入文档

请求参数

参数 类型 是否必填 最大长度 描述 示例值
radius String 可选 10 半径,单位【米】 5000
user_id String 可选 32 蚂蚁统一会员ID 2018123123123123
city_id String 可选 20 城市编码 200123
app_channel String 可选 20 说明来源 TAOBAO
x Number 必选 10 地理位置经度 56.23
y Number 必选 10 地理位置纬度 45.23232
page_no Number 可选 10 开始标记 0
page_size Number 可选 10 数量标记 10
product_version String 可选 20 设备版本号 12.2324
product_id String 可选 20 设备id 123123123

响应参数

参数 类型 是否必填 最大长度 描述 示例值
near_mall_bos NearMallBo 必填 商圈信息
attribute String 必填 2000 json字符串表示额外信息 {"url":"xxx"}
mall_id String 必填 32 商圈id 123123
mall_name String 必填 200 商圈名字 蚂蚁z空间
mall_logo String 必填 300 商圈图片 http://image.com/123123
distance String 必填 100 距离 1000
latitude String 必填 10 经度 123.232
longitude String 必填 10 纬度 12.2323

请求示例

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do","app_id","your private_key","json","GBK","alipay_public_key","RSA2");
KoubeiMarketingDataNearmallQueryRequest request = new KoubeiMarketingDataNearmallQueryRequest();
request.setBizContent("{" +
"\"radius\":\"5000\"," +
"\"user_id\":\"2018123123123123\"," +
"\"city_id\":\"200123\"," +
"\"app_channel\":\"TAOBAO\"," +
"\"x\":56.23," +
"\"y\":45.23232," +
"\"page_no\":0," +
"\"page_size\":10," +
"\"product_version\":\"12.2324\"," +
"\"product_id\":\"123123123\"" +
"  }");
KoubeiMarketingDataNearmallQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}

响应示例

{
    "koubei_marketing_data_nearmall_query_response": {
        "code": "10000",
        "msg": "Success",
        "near_mall_bos": [
            {
                "attribute": "{\"url\":\"xxx\"}",
                "mall_id": "123123",
                "mall_name": "蚂蚁z空间",
                "mall_logo": "http://image.com/123123",
                "distance": "1000",
                "latitude": "123.232",
                "longitude": "12.2323"
            }
        ]
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

异常示例

{
    "koubei_marketing_data_nearmall_query_response": {
        "code": "20000",
        "msg": "Service Currently Unavailable",
        "sub_code": "isp.unknow-error",
        "sub_msg": "系统繁忙"
    },
    "sign": "ERITJKEIJKJHKKKKKKKHJEREEEEEEEEEEE"
}

业务错误码

公共错误码

错误码错误描述解决方案
BIZ_ERROR 业务异常 联系口碑开发
INVALID_PARAMETER 参数有误 请检查参数
SYSTEM_ERROR 系统繁忙 请联系口碑开发
onlineServer