文档中心
> 开放平台
开放平台
该文档主要面向需要入驻蚂蚁金服开放平台的产品、架构、开发等相关人员， 需要有基本的程序开发背景。通过该文档能够快速集成（经营报表）功能，接入前需要入驻开放平台并创建了应用，应用已申请该接口权限并配置RSA密钥。
第一步：创建应用
要在您的应用中使用支付宝开放产品的接口能力，您需要先去蚂蚁金服开放平台（open.alipay.com），在管理中心中创建登记您的应用，并提交审核，审核通过后会为您生成应用唯一标识（APPID），并且可以申请开通开放产品使用权限，通过APPID您的应用才能调用开放产品的接口能力。需要详细了解开放平台创建应用步骤请参考《开放平台应用创建指南》。
第二步：配置密钥
开发者调用接口前需要先生成RSA密钥，RSA密钥包含应用私钥(APP_PRIVATE_KEY)、应用公钥(APP_PUBLIC_KEY）。生成密钥后在开放平台管理中心进行密钥配置，配置完成后可以获取支付宝公钥(ALIPAY_PUBLIC_KEY)。详情请参考《配置应用环境》。
第三步：搭建和配置开发环境
1. 下载服务端SDK
为了帮助开发者调用开放接口，我们提供了开放平台服务端SDK，包含JAVA、PHP和.NET三个语言版本，封装了签名&验签、HTTP接口请求等基础功能。请先下载对应语言版本的SDK并引入您的开发工程。
各语言版本服务端SDK详细使用说明，请参考《服务端SDK说明》。
2. 接口调用配置
在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 |
第四步：调用接口
商家经营数据查询包含如下接口：
| 接口中文名 | 接口英文名 | 接口描述 |
|---|---|---|
| 口碑商户经营数据查询接口 |
koubei.marketing.data.indicator.query |
查询商家经营数据 |
接口调用示例大致分为3步：
- 拼装业务参数
- 将参数发送给开放平台服务端
- 获取开放平台服务端返回值，并进行具体业务处理
1. 口碑商户经营数据查询接口
代码调用示例：
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
KoubeiMarketingDataIndicatorQueryRequest request = new KoubeiMarketingDataIndicatorQueryRequest();
request.setBizContent("{\"begin_date\":\"20160501\",\"end_date\":\"20160616\",\"page_num\":\"1\", \"page_size\":\"20\",\"biz_type\":\"MemberQuery\"}");
KoubeiMarketingDataIndicatorQueryResponse response = alipayClient.execute(request);
System.out.println(response.getBody());
2.商户会员交易习惯查询接口
AlipayClient alipayClient = new DefaultAlipayClient("https://openapi.alipay.com/gateway.do", APP_ID, APP_PRIVATE_KEY, "json", CHARSET, ALIPAY_PUBLIC_KEY, "RSA2");
KoubeiMarketingDataTradeHabbitQueryRequest request = new KoubeiMarketingDataTradeHabbitQueryRequest();
request.setBizContent("{" +
" \"biz_date\":\"20161025\"," +
" \"store_ids\":\"2016070500077000000016190907,2016070500077000000016190908,2016070500077000000016190909\"" +
" }");
KoubeiMarketingDataTradeHabbitQueryResponse response = alipayClient.execute(request);
if(response.isSuccess()){
System.out.println("调用成功");
} else {
System.out.println("调用失败");
}
接口调用结果码说明
| 同步返回结果码 | 含义 | 说明 |
|---|---|---|
| 10000 |
业务处理成功 | |
| 40001～40006 | 业务处理失败 | 具体失败原因请参考公共错误码。其它请参考API文档。 |
| 20000 | 业务出现未知错误或者系统异常 | 业务出现未知错误或者系统异常(请一定在确定本次调用结果后，发起重试)，可调用查询接口发起查询确定结果。 |
关于沙箱
如何接入沙箱
沙箱是开放平台提供给开发者用户调试接口的环境，具体操作步骤见
沙箱接入指南。
经营报表沙箱接入注意点
1、经营报表支持沙箱接入；在沙箱调通接口后，必须在线上进行测试与验收，所有返回码及业务逻辑以线上为准；
2、经营报表所有接口，当前沙箱返回的均为固定的模拟数据，仅供接口联通调试使用。
