活动报名开发接入 -凯发app官方网站更新时间：2023-11-29 11:43:30收藏我的文档设置返回文档完成 接入准备 后，商家/服务商可根据本文指引快速接入 活动报名 能力。商家或服务商可根据实际情况通过以下方式接入该产品：●商家自研：商家自助完成产品开通与接口调用。●服务商代开发：服务商需获取商家应用的代开发授权，再协助商家开通产品，然后通过第三方应用调用接口。产品基本概念接入 活动报名 需要知道两个概念 活动方案、活动报名记录：●活动方案：商家实际参与报名的目标活动方案。一个活动方案代表了支付宝平台对商户参与具体活动的基本要求、提报内容的准入要求。可以理解为，商家的任何一个报名，都是对一个指定的活动方案的报名。一个活动方案可以对应多个报名记录。●活动报名记录：商家实际参与报名时，一次性提交的报名数据的记录。商家按照活动方案要求提交符合要求的报名数据，支付宝平台侧会生成一条活动报名记录，待审核通过后，活动报名记录包含的内容会透出到对应的活动场；若审核驳回，商家也能从接口获取到驳回原因。活动报名 产品提供了 创建活动报名 和 下线活动报名 两个业务能力。每个业务能力都包含若干步骤，每个业务步骤都涉及 0 到多个接口。具体如下表所示。业务能力业务步骤涉及的接口前置准备：准备报名数据每个活动方案对报名数据的要求不同，请按照活动方案的要求来准备报名数据。具体活动报名数据请联系 bd。 创建活动报名第一步：创建活动报名第二步：等待支付宝审核无接口。创建活动报名后，支付宝会对商家提交的权益、素材等信息进行审核（审核内容包括：权益是否可领取成功、权益是否可核销成功、素材主体内容是否清晰、小程序是否可正常跳转等，具体审核规则以每个活动要求为准）。第三步：得知报名结果下线活动报名第一步：下线活动报名第二步：等待支付宝审核无接口。申请下线活动报名后，支付宝会对商家下线操作进行审核。第三步：得知下线结果前置准备：准备报名数据接口依赖关系在创建活动报名前，需要根据活动方案的要求，准备不同的报名内容数据。具体需要准备的报名内容数据请联系 bd。 比如：假设活动方案（id：2022050901000100000000448437）要求的数据是 券活动、小程序、素材、城市范围，那么在进行活动报名创建之前，需要先准备好 券活动、小程序、素材、城市范围 这些数据。活动报名 目前支持的报名提交数据有 小程序商品、券活动、小程序、活动素材、定向城市，每种数据的准备方式见下表：数据种类数据准备方式小程序商品详情参见 小程序商品接入指南。券活动活动报名 目前支持的券活动（优惠券）产品有 商家券、支付券。接入商家券，详情参见 商家券接入指南。接入支付券，详情参见 支付券接入指南。小程序详情参见 小程序接入指南。活动素材详情参见 。定向城市如果活动方案允许定向指定城市，那么可以在创建活动报名时指定目标城市的城市码。城市码取值来源：。 请选择区域类型 =3 的地区码，比如：呼和浩特，150100。创建活动报名接口时序图状态机活动报名记录的状态有5个：审核中: auditing通过: enabled不通过: rejected下线审核中: close_auditing已下线: closed但创建活动报名链路只涉及3个活动报名记录状态：审核中: auditing通过: enabled不通过: rejected第一步：创建活动报名商家/服务商准备好创建活动报名的数据后，可调用 ，对指定的活动方案创建活动报名记录（每个活动报名都是面向指定活动方案 id 创建的，不同的活动方案 id 代表不同的活动目标）。创建活动报名传参注意事项●接口中 enroll_content 里的 app_items、voucher_activities、mini_apps，以及 enroll_material 里的materials、serving_target 里的city 参数，需根据活动方案的实际要求来传入。示例假设活动方案要求的数据如下：目标活动方案id（plan_id）：2022050901000100000000448437创建活动报名传参数据要求示例值一个券活动activity_id：2022120100826004846607700400一个小程序mini_app_id：2018122962700019一个素材idmaterial_id：2023041900903002544841071418指定城市范围全国创建活动报名接口请求示例接口核心请求参数（biz_content）：创建活动报名接口响应示例：调用成功-创建活动报名被受理：调用成功-创建活动报名不被受理（列举一种不被受理情况）：调用失败（列举一种失败情况）：调用失败时的错误码说明，参见 文档中的错误码章节。创建活动报名内容传参差异说明不同的活动方案有不同的活动报名参数要求，此处例举出参数要求和对应传参的部分示例，提供给开发者理解不同活动方案要求下的传参差异：报名内容要求种类创建活动报名接口请求示例-核心请求参数（biz_content）一个券活动 一个小程序 一个素材 城市范围一个券活动 一个小程序 一个素材一个券活动 一个小程序 城市范围一个券活动 一个素材 城市范围一个券活动 一个小程序一个券活动 一个素材一个券活动 两个素材一个券活动 城市范围一个券活动一个小程序 一个素材 城市范围一个小程序 一个素材一个小程序 城市范围一个小程序一个小程序商品 一个素材 城市范围一个小程序商品 一个素材一个小程序商品 城市范围一个小程序商品第二步：等待支付宝审核提交报名后，支付宝会对商家提交的权益、素材进行审核（审核内容包括：权益是否可领取成功、权益是否可核销成功、素材主体内容是否清晰、小程序是否可正常跳转等，具体审核规则以单个活动的规则为准）。正常情况下的审核周期是2天～3天，但需以实际活动报名的审核时间为准。第三步：得知报名结果得知报名结果的方式有两种：1方式一（推荐方式）：通过接入 被动得知 创建报名结果。2方式二：通过调用 主动得知 创建报名结果。方式一：监听变更活动报名消息接口消息示例：方式二：调用查询活动报名详情接口查询活动报名详情接口请求示例：查询活动报名详情接口响应示例：调用成功：调用失败（列举一种失败情况）：下线活动报名接口时序图状态机活动报名记录的状态有5个：审核中: auditing通过: enabled不通过: rejected下线审核中: close_auditing已下线: closed下线活动报名链路涉及全部5个活动报名记录状态：审核中: auditing通过: enabled不通过: rejected（如果活动报名记录状态是 rejected，则说明目标活动报名审核未通过，无需操作下线报名）下线审核中: close_auditing已下线: closed第一步：下线活动报名商家/服务商需要下线创建的活动报名时，可调用 ，指定活动报名记录下线。调用下线活动报名接口下线活动报名接口请求示例：下线活动报名接口响应示例：调用成功：调用失败（列举一种失败情况）：第二步：等待支付宝审核调用下线活动报名接口后，支付宝会对商家提交的权益、是否满足下线条件等信息进行审核（具体审核规则以单个活动的规则为准）。正常情况下的审核周期是2天～3天，但需以实际活动报名的审核时间为准。第三步：得知下线结果得知下线活动报名结果的方式与创建活动报名是同样的两种途径：1方式一（推荐方式）：通过接入 ）被动得知 下线报名结果。2方式二：通过调用 主动得知 下线报名结果。方式一：监听变更活动报名消息接口消息示例：方式二：调用查询活动报名详情接口查询活动报名详情接口请求示例：查询活动报名详情接口响应示例：调用成功：调用失败（列举一种失败情况）：调试验收沙箱环境是支付宝开放平台为开发者提供的与生产环境完全隔离的联调测试环境，开发者在沙箱环境中完成的调用不会对生产环境中的数据造成任何影响。活动报名 已支持沙箱环境调试，配置详情可查看 。
