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

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

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

注意：

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

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

本文仅说明如何在沙箱环境中调试小程序服务，非沙箱环境调试通用说明。

更多沙箱介绍和沙箱控制台使用说明可查看沙箱环境。

小程序服务沙箱调试说明

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

推荐开发者遵循业务用例来使用沙箱。

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

业务用例

小程序服务

服务 schema 查询

调用 OpenAPI：alipay.open.app.service.schema.query（服务schema下发）

入参示例值：

说明：目前 category_id 只支持 C100917863。

出参示例值：

{
 "category_id":"c11111",
 "schema_version":"v1.0",
 "schema_xml":"<serviceSchema><attribute id=\"serviceName\" name=\"服务名称\" type=\"single\" valueType=\"text\"><rules><rule type=\"valid\" code=\"maxLength\" name=\"最大长度\" value=\"10\"/><rule type=\"valid\" code=\"reg\" name=\"正则表达式\" value=\"[^A-Za-z0-9一-龥]\"/><rule type=\"tips\" code=\"inputTip\" name=\"底纹提示文案\" value=\"请输入服务名称,不超过8个字符,不含特殊字符\"/></rules></attribute></serviceSchema>",
 "template_type":"DEFAULT"
}

服务提报/服务编辑

调用 OpenAPI：alipay.open.app.service.apply（服务提报申请）

入参示例值：

出参示例值：

说明：沙箱环境下服务提报审批会自动通过。

{
 "service_code": "2023010921000700006779"
}

接收推广计划审核通过通知

接收 MsgAPI 消息：alipay.open.app.service.audit.notify（服务消息审核通知）
消息业务参数示例值：

查询服务详情

调用 OpenAPI：alipay.open.app.service.query（服务查询）

入参示例值：

出参示例值：

{
 "service_code":"2023010921000700006779",
 "service_xml":"<?xml version=\"1.0\" encoding=\"utf-8\"?</serviceSchema>...<serviceSchema>",
 "status":"AUDITING",
 "reject_reason":"不符合运营规范",
 "template_type":"DEFAULT"
}

服务批量查询

调用 OpenAPI：alipay.open.app.service.list.query （服务批量查询）

入参示例值：

出参示例值：

{
 "page_size":10,
 "page_num":2,
 "total":500,
 "records": [
      {
        "service_code": "2023010921000700006779",
        "service_name": "沙箱测试服务名称 001",
        "biz_status": "PROMOTION",
        "category_id": "C100917863"
      },
      {
        "service_code": "2023010921000300006777",
        "service_name": "沙箱测试服务名称 001",
        "biz_status": "PROMOTION",
        "category_id": "C100917863"
      },
      {
        "service_code": "2023010921000000006679",
        "service_name": "沙箱测试服务名称 001",
        "biz_status": "PROMOTION",
        "category_id": "C100917863"
      }
  ]
}

服务失效

调用 OpenAPI：alipay.open.app.service.delete（服务失效接口）

入参示例值：

出参示例值：

{}

沙箱调试

小程序服务沙箱调试说明#

业务用例#

小程序服务#

服务 schema 查询#

服务提报/服务编辑#

接收推广计划审核通过通知#

查询服务详情#

服务批量查询#

服务失效#

小程序服务沙箱调试说明

业务用例

小程序服务

服务 schema 查询

服务提报/服务编辑

接收推广计划审核通过通知

查询服务详情

服务批量查询

服务失效