文档中心 > 开放平台

该文档主要面向需要入驻蚂蚁开放平台的产品、架构、开发等相关人员, 需要有基本的程序开发背景。通过该文档能够快速集成(商家详情页广告)功能,接入前需要入驻开放平台并创建了应用,应用已申请该接口权限并配置RSA密钥。

第一步:创建应用并获取APPID

要在您的应用中使用支付宝开放产品的接口能力,您需要先去蚂蚁金服开放平台(open.alipay.com),在管理中心中创建登记您的应用,并提交审核,审核通过后会为您生成应用唯一标识(APPID),并且可以申请开通开放产品使用权限,通过APPID您的应用才能调用开放产品的接口能力。需要详细了解开放平台创建应用步骤请参考《开放平台应用创建指南》。

第二步:配置密钥

开发者调用接口前需要先生成RSA密钥,RSA密钥包含应用私钥(APP_PRIVATE_KEY)、应用公钥(APP_PUBLIC_KEY)。生成密钥后在开放平台管理中心进行密钥配置,配置完成后可以获取支付宝公钥(ALIPAY_PUBLIC_KEY)。详情请参考《配置应用环境》。

第三步:搭建和配置开发环境

1. 下载服务端SDK

为了帮助开发者调用开放接口,我们提供了开放平台服务端SDK,包含JAVA、PHP和.NET三个语言版本,封装了签名&验签、HTTP接口请求等基础功能。请先下载对应语言版本的SDK并引入您的开发工程。

2. 接口调用配置

各语言版本服务端SDK详细使用说明,请参考《服务端SDK说明

在SDK调用前需要进行初始化,以Java代码为示例如下:

AlipayClient alipayClient = new DefaultAlipayClient(URL, APP_ID, APP_PRIVATE_KEY, FORMAT, CHARSET, ALIPAY_PUBLIC_KEY, SIGN_TYPE);
关键参数说明:
配置参数 示例值解释 获取方式/示例值
URL 支付宝网关(固定) https://openapi.alipay.com/gateway.do
APPID APPID 即创建应用后生成 获取见上面创建应用并获取APPID
APP_PRIVATE_KEY 开发者私钥,由开发者自己生成 获取详见上面配置密钥
FORMAT 参数返回格式,只支持json json(固定)
CHARSET 编码集,支持GBK/UTF-8 开发者根据实际工程编码配置
ALIPAY_PUBLIC_KEY 支付宝公钥,由支付宝生成 获取详见上面配置密钥
SIGN_TYPE 商户生成签名字符串所使用的签名算法类型,目前支持RSA2和RSA,推荐使用RSA2 RSA2

 

第四步:接口调用

支付宝详情页广告产品包含以下接口:

接口名称 接口描述

创建广告接口
alipay.marketing.cdp.advertise.create

在口碑店铺页中,增加商家自定义区域。可由商家通过接口自定义上传带外链的图片广告,或者H5页面。这时广告处于初始化状态,用户不能在钱包APP上看到。

修改广告接口
alipay.marketing.cdp.advertise.modify

对于已经创建的模板,如果需要修改模板内容,可通过该开发者帮助线下商家修改广告内容,如修改的是线上的广告内容,需要先将线上广告内容下架,再修改,修改后操作上架,才能在支付宝钱包APP看到修改后的广告内容。运营位类型可以选择图片或H5。

操作广告接口
alipay.marketing.cdp.advertise.operate

开发者帮助线下商家上线/下线广告内容,上线后用户可以在钱包APP上看到广告,下线后用户不能看到广告且该广告内容失效。

查询广告接口
alipay.marketing.cdp.advertise.query

开发者可查询广告内容和状态。

支付宝详情页广告整体接口调用流程:

接口调用示例大致分为3步:

  1. 拼装业务参数
  2. 将参数发送给开放平台服务端
  3. 获取开放平台服务端返回值,并进行具体业务处理

1.创建广告

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
AlipayMarketingCdpAdvertiseCreateRequest request = new AlipayMarketingCdpAdvertiseCreateRequest();
request.setBizContent("{" +
"    \"ad_code\":\"CDP_OPEN_MERCHANT\"," +
"    \"content_type\":\"h5\"," +
"    \"content\":\"http://m.alipay.com/J/fdfd\"," +
"    \"action_url\":\"http://m.alipay.com/J/dfdf\"," +
"    \"ad_rules\":\"{\"shop_id\":[\"2015090800077000000002549828\"]}\"," +
"    \"height\":\"100\"," +
"    \"start_time\":\"2016-02-24 12:12:12\"," +
"    \"end_time\":\"2017-02-24 12:12:12\"" +
"  }");
AlipayMarketingCdpAdvertiseCreateResponse response = alipayClient.execute(request);

2.修改广告

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
AlipayMarketingCdpAdvertiseModifyRequest request = new AlipayMarketingCdpAdvertiseModifyRequest();
request.setBizContent("{\"action_url\":\"https://b.alipay.com/newIndex.htm\",\"ad_id\":\"1999\",\"content\":\"https://www.alipay.com/\",\"height\":\"120\"}");
AlipayMarketingCdpAdvertiseModifyResponse response = alipayClient.execute(request);

3.操作广告

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
AlipayMarketingCdpAdvertiseOperateRequest request = new AlipayMarketingCdpAdvertiseOperateRequest();
request.setBizContent("{\"ad_id\":\"1999\",\"operate_type\":\"online\"}");
AlipayMarketingCdpAdvertiseOperateResponse response = alipayClient.execute(request);

4.查询广告

AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
AlipayMarketingCdpAdvertiseQueryRequest request = new AlipayMarketingCdpAdvertiseQueryRequest();
request.setBizContent("{\"ad_id\":\"1999\"}");
AlipayMarketingCdpAdvertiseQueryResponse response = alipayClient.execute(request);

接口调用结果码说明

同步返回结果码 含义 说明

10000

业务处理成功  
40001~40006 业务处理失败 具体失败原因请参考公共错误码。其它请参考API文档。
20000 业务出现未知错误或者系统异常 业务出现未知错误或者系统异常(请一定在确定本次调用结果后,发起重试),可调用查询接口发起查询确定结果。

关于沙箱

如何接入沙箱

      沙箱是开放平台提供给开发者用户调试接口的环境,具体操作步骤见 沙箱接入指南

商家详情页广告沙箱接入注意点

      1、商家详情页广告支持沙箱接入;在沙箱调通接口后,必须在线上进行测试与验收,所有返回码及业务逻辑以线上为准;
      2、可使用 门店二维码生成器,通过沙箱钱包的扫一扫功能,进入商家详情页,查看广告效果;

FAQ

关于此文档暂时还没有FAQ
返回
顶部