沙箱调试 -凯发app官方网站

产品地图

支付产品

私域产品

公域产品

营销产品

资金产品

会员产品

信用产品

安全产品

广告产品

其他通用产品

小程序交易投诉处理

收单资金结算到银行账户的到账消息

蚂蚁门店管理

ccm 插件化能力

学校库

分享到支付宝

商家账单数据查询及下载接口

商户自主监控

网站支付宝登录

支付宝卡包

电子发票

生活缴费

中小学教育缴费

地铁线上购票

车主平台停车在线缴费

口碑开店

私域营销

接入指南

api 列表

相关资料

常见问题

更新日志

支付宝加油

商家费率申请

更新时间：2025-03-12 15:20:55

订阅更新

我的文档

设置

沙箱环境是支付宝开放平台为开发者提供的与生产环境完全隔离的联调测试环境，开发者在沙箱环境中完成的接口调用不会对生产环境中的数据造成任何影响。

沙箱为开放的产品提供有限功能范围的支持（覆盖的功能范围参见下面的业务用例），可以覆盖产品的绝大部分核心链路和对接逻辑，便于开发者快速学习/尝试/开发/调试，推荐开发者遵循业务用例来使用沙箱。

沙箱环境会自动完成或忽略一些场景的业务门槛，例如：开发者无需等待产品签约，即可直接在沙箱环境调用接口，使得开发集成工作可以与商务流程并行，从而提高项目整体的交付效率。

注意

：

●

由于沙箱环境并非 100% 与生产环境一致，接口的实际响应逻辑请以生产环境为准，沙箱环境开发调试完成后，仍然需要在生产环境进行测试验收。

●

沙箱环境拥有完全独立的数据体系，沙箱环境下返回的数据（比如用户 id 等）在生产环境中都是不存在的，开发者不可将沙箱环境返回的数据与生产环境中的数据混淆。

●

本文仅说明如何在沙箱环境中调试私域营销，非沙箱环境调试通用说明。

更多沙箱介绍和沙箱控制台使用说明可参考

沙箱环境说明文档

。

1 私域营销沙箱调试说明

沙箱通过业务用例定义支持的功能范围。业务用例描述了典型业务场景下，开发者可通过先后对接这些接口来实现业务目标，每个业务用例会为开发者提供接口调用时序与参数示例值。

说明

：示例参数值中与沙箱当前账号、图片资源 id、应用上下文相关的参数，需开发者自行参照接入指南调用配套接口获取。

1.1 业务用例 1：查询营销活动

1.1.1 条件查询活动列表

调用 openapi：

说明

：

●

该接口出参值为沙箱固定数据，数据总数为 21 条，支持分页查询。

●

如果入参传递了 merchant_id 或 activity_status，出参中的 belong_merchant_id 或 activity_status 将会被设置为入参值，其他内容不会变化。

入参示例值：

{

"page_num": 1,

"page_size": 4

}

出参示例值：

1.1.2 咨询当前用户是否可参加指定活动

调用 openapi：

alipay.marketing.activity.consult（活动领取咨询接口）

入参示例值：

出参示例值：

1.1.3 查询活动详情

调用 openapi：

入参示例值：

出参示例值：

1.2 业务用例 2：查询活动适用范围

1.2.1 查询活动可用商户

调用 openapi：

说明

：

●

该接口出参值为沙箱固定数据，数据总数为 21 条，支持分页查询。

●

如果入参传递了 activity_id，出参中的 activity_id 将会被设置为入参值。

●

如果入参传递了 merchant_id ，那么数据将只会有一条。

入参示例值：

出参示例值：

1.2.2 查询活动可用小程序

调用 openapi：

说明

：

●

该接口出参值为沙箱固定数据，数据总数为 21 条，支持分页查询。

●

如果入参传递了 activity_id，出参中的 activity_id 将会被设置为入参值，其他内容不会变化。

入参示例值：

出参示例值：

1.2.3 查询活动可用门店

调用 openapi：

说明

：

●

该接口出参值为沙箱固定数据，数据总数为 21 条，支持分页查询。

●

如果入参传递了 activity_id，出参的 activity_id 将会被设置为入参值，其他内容不会变化。

入参示例值：

出参示例值：

1.2.4 查询活动适用商品

调用 openapi：

说明

：

●

该接口出参值为沙箱固定数据，数据总数为 21 条，支持分页查询。

●

如果入参传递了 activity_id，出参中的 activity_id 将会被设置为入参值，其他内容不会变化。

入参示例值：

出参示例值：

1.3 业务用例 3：小程序内领券核销

1.3.1 沙箱模拟用户领券

沙箱模拟用户领券链接拼接规则：

http://render.sx.alipaydev.com/get-coupon.html?activityid=${activityid}&appid=${appid}

说明

：

●

将链接中的

${activityid}

和

${appid}

替换为沙箱环境下创建的商家券活动 id 以及沙箱环境中自己的沙箱应用 appid 后，将此链接转换为二维码图片。使用支付宝沙箱客户端 app，登录沙箱分配的买家账号（注意不是商家账号）后，扫上一步生成的二维码，根据指引完成领券。

●

该拼接链接的方式只适用于

沙箱环境

，生产环境需要按照

开发接入

推广、领取商家券。

1.3.2 接收领券消息

接收 msgapi 消息：

alipay.marketing.activity.message.received（券领取通知接口）

领券消息内容示例值：

1.3.3 同步券核销状态

调用 openapi：alipay.marketing.activity.ordervoucher.use

入参示例值：

出参示例值：

1.4 业务用例 4：小程序内领券过期

1.4.1 沙箱模拟用户领券

沙箱模拟用户领券链接拼接规则：

http://render.sx.alipaydev.com/get-coupon.html?activityid=${activityid}&appid=${appid}

说明

：

●

将链接中的

${activityid}

和

${appid}

●

该拼接链接的方式只适用于

沙箱环境

，生产环境需要按照

开发接入

推广、领取商家券。

1.4.2 接收领券消息

接收 msgapi 消息：

alipay.marketing.activity.message.received（券领取通知接口）

领券消息内容示例值：

1.4.3 使券失效

调用 openapi：alipay.marketing.activity.ordervoucher.invalid

入参示例值：

出参示例值：

相关问题