# 小程序 > 通过丰富,稳定的框架及工具,为开发者提供创建小程序的基础条件支撑。 ## 开发 ### 指南 #### 开始使用 - [开发者账号注册](https://opendocs.alipay.com/mini/03lwrm.md): 文档介绍了支付宝开放平台的三种核心身份:开发者负责应用创建与开发,商家拥有小程序并负责运营,服务商提供代开发或代运营服务。注册流程支持两种方式:已有支付宝账号的用户可直接登录并补充信息;无账号用户可使用手机号注册,系统将同步创建未实名认证的支付宝账号。注册成功后即可进入控制台开发应用。此外,开发者可在账户中心修改联系人信息。需注意小程序提审前必须绑定商家账号。 - [创建小程序](https://opendocs.alipay.com/mini/03m091.md): 本文档介绍了在支付宝开放平台创建小程序的流程及相关管理规则。创建前需完成账号注册与入驻。创建步骤包括登录控制台、填写名称、绑定商家账号及确认申请,特定情况下可免确认直接创建。文档明确了小程序数量限制:个人及个体工商户上限为5个,企业上限为10个。此外,文档还说明了APPID的查看路径,以及基础信息修改规则:上架前无限制;上架后名称每年限改2次,简介等每月限改5次,Logo等无限制。同时强调了绑定不可解绑及名称占用处理方式。 - [成员管理](https://opendocs.alipay.com/mini/03m092.md): 本文档主要介绍支付宝小程序的成员角色管理、权限分配及操作流程。小程序设有管理员、应用管理员、开发成员和体验成员四种角色,各角色在基础设置、开发、提审发布及运维等方面拥有不同层级的权限。管理员权限最高,体验成员仅限预览且无控制台访问权。文档详细说明了添加各类成员的具体路径与操作步骤,区分了需邀请确认和直接添加的模式。此外,还介绍了针对特定操作的临时权限申请流程,即通过扫码确认获取有效期60分钟的操作权限,以及成员备注修改和消息通知渠道。 - [开发设置](https://opendocs.alipay.com/mini/03m2a7.md): 本文档主要介绍了支付宝小程序创建后的开发设置流程及关键配置项。首先,开发者需在开放平台控制台完成基础设置。核心配置包括:接口加签方式,必须配置公私钥或证书以保障交互安全,且密钥需与AppID一一对应;接口内容加密方式,支持AES加密提升传输安全,使用获取会员手机号等能力时此项必填;IP白名单,用于校验请求来源IP,保障资金操作安全;应用网关,用于接收支付宝异步通知,设置前需完成加签;OpenID配置管理及服务器域名白名单,分别用于身份标识配置及限制小程序网络请求范围。此外,开发者还可在“可调用产品”页面查看或申请产品调用权限。 ##### 基础设置 - [小程序隐私政策](https://opendocs.alipay.com/mini/03lwro.md): 支付宝开放平台为规范个人信息处理行为,于2025年4月优化小程序隐私政策配置产品,新增第三方插件/SDK信息及补充文档功能,并重申自2023年11月起对未完成隐私政策配置的模板实例化小程序实施提审限制。依据《个人信息保护法》,小程序无论调用官方接口还是自行收集信息,均需在提审前完成配置,否则将面临处罚。配置流程区分普通小程序与模板小程序,填写内容涵盖用户信息收集使用情况(涉及地理位置、相册、摄像头等多种隐私字段)、第三方插件/SDK信息、信息存储地点(境外存储需完成安全评估)、联系方式及补充文档。配置完成后,隐私政策将在授权弹窗及小程序菜单中展示。 - [服务异常设置](https://opendocs.alipay.com/mini/03m095.md): 该文档介绍了小程序“服务异常设置”(黄条提示)功能。该功能适用于小程序部分功能维护或故障场景,旨在提示用户当前异常,但不阻止用户使用其他正常功能。开发者可在开放平台控制台开启此设置,系统提供“系统更新维护”、“系统访问人数过多”和“系统故障”三种预设提示类型。设置生效后,用户访问小程序时页面顶部将显示黄条提示。操作上,开发者需在控制台基础设置中选择异常原因及预计恢复时间进行设置。取消异常支持两种方式:若设定了恢复时间,系统届时自动取消;若未设定,则需开发者手动操作取消。 - [详解 Todo 示例](https://opendocs.alipay.com/mini/03m096.md): 本文档以Todo示例详细讲解支付宝小程序的开发流程。前端部分介绍了小程序开发者工具的下载安装、项目的创建与关联,以及如何在模拟器和真机上预览。核心内容深入解析了小程序的文件结构,包括全局配置文件(app.json、app.acss、app.js)的作用,以及页面文件(.json、.axml、.js、.acss)的具体功能与优先级规则,重点阐述了todos和add-todo两个页面的实现细节。后端部分指出Demo默认状态为静态数据,阐述了接入自行搭建后端服务或小程序云以实现数据持久化的必要性,并强调了配置服务器域名白名单的关键步骤。 - [小程序提审、发布与运营](https://opendocs.alipay.com/mini/03lwrr.md): 本文主要介绍小程序全生命周期的版本管理与操作流程。核心环节包括:开发完成后使用开发者工具上传生成开发版本;可设置体验版供最多50名体验成员测试;提交审核需通过准入与营销规范双重审核,时长约2个工作日,审核结果通过多渠道通知;审核通过后可进行灰度测试,比例仅支持上调且最高50%;随后执行上架操作变为线上版本,若出现重大缺陷支持回滚;最后可对线上版本执行下架操作,下架后无法恢复需重新提审。此外,上线后可通过商家自运营中心进行营销与数据分析。 - [一站式研发平台接入流程](https://opendocs.alipay.com/mini/0i2kxt.md): 该文档介绍了支付宝小程序“迭代开发模式”的操作指南。该模式将研发流程拆解为开发、审核、发布三个阶段,通过流程引导、节点提醒及自动化功能,帮助开发者提升效率并减少返工,目前仅面向新入驻账号的新建小程序开放。操作流程包括:基本准备(下载IDE、创建应用与迭代)、开发测试(前后端开发、配置与质量检测、版本构建)、审核(预校验、信息填写、平台审核)及发布(灰度验证、策略选择、回滚)。此外,文档还说明了回退旧版模式的条件与限制,以及该平台以开发者视角重塑流程、提升效率的核心理念。 #### AMPE ##### AMPE 介绍 - [产品概述](https://opendocs.alipay.com/mini/00uney.md): AMPE(支付宝小程序引擎)是支付宝小程序生态针对智能硬件设备的投放平台,旨在实现终端设备、人与服务场景的高效链接。其核心能力包括海量生态互通、情景智能服务及权益服务,支持设备端与支付宝账号双向互通及主动服务触达。产品具备研发投入少、运维成本低的优势,开发者一次开发即可双端运行,并能共享阿里经济体丰富的商业生态。目前主要应用于车载、智能家居等安卓带屏设备,接入需满足企业账号及特定硬件配置要求。 - [开发流程指引](https://opendocs.alipay.com/mini/00v23a.md): 该文档详细介绍了硬件厂商接入支付宝小程序引擎(AMPE)的完整流程与指引。通过集成AMPE,硬件设备可接入支付宝小程序生态,为用户提供丰富服务。核心流程包括厂商入驻、设备注册、小程序绑定及硬件集成四个阶段。厂商需使用认证的企业账户提交资质与产品资料,审核通过后进行产品与机型注册,定义产品、机型及设备编号。随后,厂商需关联移动应用以绑定小程序服务,并配置调用应用APPID用于OpenAPI调用与设备激活。最终,下载SDK整合包并依据开发指南完成终端集成,实现小程序在硬件设备上的运行。 - [术语库](https://opendocs.alipay.com/mini/03rq2h.md): 文档详细定义了支付宝小程序引擎(AMPE)的核心概念与架构体系。AMPE是支持小程序在移动应用及智能硬件上运行的整体解决方案。核心架构包含管理身份的“移动应用”与“调用应用”,以及层级化的“产品”、“机型”与“设备”实体,三者共同构建了业务隔离与设备管理机制。此外,文档还介绍了“情景智能服务”与“子服务”两大高级能力,前者实现服务主动找人,后者支持直达小程序特定功能页,共同赋能端外设备的场景化服务体验。 ##### AMPE 入驻 - [企业入驻](https://opendocs.alipay.com/mini/00uto0.md): 本文档主要介绍了支付宝AMPE平台的入驻流程,涵盖准备、申请与审核三个阶段。入驻前需注册企业支付宝账号,并准备企业基本资质、营业执照、硬件产品介绍及联系人信息等材料。审核重点关注企业资质、产品线介绍及实际应用案例。支持企业主账号及管理员子账号申请。用户需通过服务引擎页面提交工单,系统将自动判断入驻状态并引导后续操作。审核通过即开通权限,未通过者可通过指定邮箱进行申诉说明。 - [账号管理](https://opendocs.alipay.com/mini/037duu.md): 本文档介绍了支付宝AMPE平台企业员工管理权限的分配操作流程。旨在帮助企业通过添加管理员子账号,支持员工协助进行平台的日常管理与开发。核心流程包括六个步骤:首先,企业主账号登录AMPE平台并进入账户中心;其次,在角色管理中选择添加账号,填写员工实名认证的支付宝账号及姓名;需注意仅有“管理员账号”具备AMPE配置权限,云客服与应用管理员无此权限。随后,主账号可在员工列表中管理子账号权限。最后,员工使用管理员子账号登录并选择对应商家主账号,即可操作企业AMPE功能。 - [快速体验](https://opendocs.alipay.com/mini/00vdmw.md): 本文档旨在指导接入方使用AMPE快速体验包在硬件设备上运行小程序。主要流程包括:完成企业准入并下载解压体验包;在设备上安装AMPE_service_release.apk和AMPE_demo.apk,启动服务并保持demo在前台;在AMPE平台通过小程序信息生成有效期为24小时的token;最后在demo应用中输入token及appId即可开启体验,此外还可参考通用适配规则调整小程序样式。 ##### 产品管理 - [设备管理](https://opendocs.alipay.com/mini/00v5pt.md): 本文档规定了硬件厂商在平台审核通过后注册设备信息以集成AMPE服务的流程。设备管理分为设备、机型和硬件设备号三个维度。操作步骤包括:首先进入设备管理页面,每个厂商限增10款设备;其次新增设备,选择类型并填写信息,系统分配Product_id,类型提交后不可修改,智能车机需按特定颗粒度填写;接着新增机型,需详细填写硬件参数以供兼容性判断,系统分配Model_id;最后新增硬件设备号,支持对量产设备的唯一编码进行添加、删除和查询管理。 - [移动应用管理](https://opendocs.alipay.com/mini/01kvfb.md): 本文档介绍了在支付宝小程序引擎服务中绑定小程序以供终端硬件设备运行的完整流程。首先需在应用管理页面添加移动应用,每个账户限创10个,且须使用已上线APPID及已审核通过的产品。一个移动应用可关联多个产品,更改关联会影响设备小程序列表。随后进入管理页面进行小程序绑定,支持搜索或通过AMPE市场绑定,单个应用最多关联100个小程序,且支持版本锁定功能。最后,用户可在列表中查看已绑定小程序并执行解绑、版本设置等管理操作。 - [调用应用管理](https://opendocs.alipay.com/mini/03rz3c.md): 本文档介绍了支付宝小程序引擎服务中“调用应用”的概念、作用及配置步骤。“调用应用”用于实现关联功能的OpenAPI调用及设备激活加签,建议与“移动应用”使用不同APPID以分离客户端与服务端业务,降低风险。配置步骤包括:进入“接口调用管理”页面、添加调用应用及查看绑定结果。关键限制包括:每个账户最多创建10个移动应用;只能添加名下创建的应用APPID;一个调用应用可关联多个设备产品,但一个设备产品仅能关联一个调用应用。 - [设备加签](https://opendocs.alipay.com/mini/00v5pu.md): 本文档主要阐述了硬件设备厂商生成设备唯一签名以进行设备激活的操作流程。在完成厂商入驻、产品注册、设备及应用关联等前期准备后,厂商需使用“调用应用”的RSA2私钥对设备ID进行加签。签名内容格式规定为“productId_deviceId”,字符集采用UTF-8。文档推荐使用支付宝开放平台SDK进行开发,并提供了Java语言的Maven依赖、工具类说明及具体的代码实现示例,供开发者参考。 ##### 硬件接入 - [硬件框架说明](https://opendocs.alipay.com/mini/00v71z.md): AMPE(支付宝小程序引擎)是一种让硬件在脱离支付宝客户端情况下运行小程序的运行环境,目前支持Android平台。其架构包含两个核心APK:AMPE Service(由支付宝发布,作为宿主环境)和AMPE Client(由厂商开发,作为用户入口)。两者通过IPC通信,Client SDK封装了通信协议,并支持硬件能力扩展。启动流程分为四步:Client SDK初始化预热、设备激活(必须步骤)、可选的支付宝登录请求以及启动小程序。若未前置登录,小程序需要登录态时会自动提示扫码。 - [硬件框架下载](https://opendocs.alipay.com/mini/00vcpw.md): 该文档详细记录了AMPE(支付宝小程序引擎)客户端SDK从2020年12月至2024年6月的版本更新日志。核心更新内容包括:一是能力扩展,新增支持支付宝小游戏、音视频、扫一扫、硬件能力(拨打电话、地图定位)及小程序跳转,并适配了Android 11/12系统及全屏与自由窗口模式。二是架构与性能优化,完成了底层架构重构与浏览器内核替换,优化了冷启动速度、内存管理及包体积。三是体验提升,重构了授权登录流程,增加了启动页与Loading页,优化了大屏适配及UI交互。此外,文档还详细记录了针对支付失败、内存泄漏、闪退及UI显示异常等问题的修复情况。 - [硬件开发指南](https://opendocs.alipay.com/mini/04hdxz.md): 本文档详细介绍了支付宝小程序硬件引擎(AMPE)的集成与使用指南。首先说明了下载整合包及其包含的引擎包、SDK和Demo文件。用户可通过安装引擎包和Demo应用快速体验Mock数据演示。客户端定制开发需遵循三个核心步骤:在Application中进行硬件引擎初始化配置;根据注册指引传入参数完成设备激活,这是调用后续接口的前提;调用接口实现启动小程序或唤起登录页面功能。此外,文档还提供了通过隐藏入口或adb命令获取并上传实时日志的方法,建议开发者在客户端集成日志上传功能以便于排查线上问题。 ###### 适配规则 - [小程序通用适配规则](https://opendocs.alipay.com/mini/0191v4.md): 本文档规定了小程序在横屏与竖屏设备上的布局适配及UI自定义能力。首先,小程序主体可拓展为“最近使用+主体+信息展示”三模块,并根据屏幕方向设定宽度阈值:横屏主体宽度小于400建议隐藏辅助模块,竖屏宽度小于750不建议展示最近使用。其次,支持容器形状、Logo容器形状及面板背景色的定制,背景色支持多套风格切换。此外,允许配置统一字体及三种文字颜色。最后,针对导航适配问题,支持单独调整小程序主体宽度,并根据宽度变化动态调整布局与区域显示。 - [AMPE 如何加载自定义 TitleBar 布局](https://opendocs.alipay.com/mini/01xa81.md): 本文档介绍了AMPE加载外部资源以自定义小程序TitleBar布局的完整方案。核心流程包括四个步骤:首先,制作包含特定命名布局文件(arome_custom_titlebar.xml)及必须控件ID的Android资源包,并遵循图片资源命名规则;其次,利用FileProvider生成Uri路径,在AMPE初始化时配置资源包路径与包名进行加载;再次,在启动小程序时通过配置参数开启自定义标题栏显示开关;最后,支持通过代码注册监听器来处理自定义TitleBar上的点击交互事件。 - [Client SDK 接入](https://opendocs.alipay.com/mini/00v8et.md): 本文档是AMPE(蚂蚁移动开放平台引擎)的Android端集成指南,主要涵盖环境初始化、API调用及硬件能力扩展。初始化阶段需依次调用`attachApplicationContext`和`initAndActivate`,配置设备信息、主题样式及分屏显示模式,并确保设备已在开放平台注册激活。API部分详细介绍了设备激活、用户登录登出、小程序的启动与退出、预加载、状态查询、日志上传及调试包拉取等功能。硬件扩展章节阐述了原生端注册与实现自定义API供小程序调用,以及原生向小程序发送事件的通信机制。文末附带了通用状态码及业务错误码说明,用于排查集成过程中的激活、启动等问题。 ###### 扩展能力接入 - [使用说明](https://opendocs.alipay.com/mini/02eizj.md): 本文档介绍了AMPE官方提供的硬件设备扩展能力,旨在帮助小程序直接与硬件设备交互。目前开放的接口包括StartNavigation(导航)、GetHWEnvironment(获取硬件配置)、makePhoneCall(拨打电话)和openLocation(地图位置)。接入实现分为两步:第一步是硬件设备通用能力注册,推荐在启动时通过配置extensionList完成,也可使用AromeExtendBridgeRequest;第二步是通过registerBridgeExtension监听小程序调用,根据action参数执行具体业务逻辑。 - [小程序接入硬件设备导航](https://opendocs.alipay.com/mini/02bp9p.md): 该文档阐述了小程序接入硬件设备导航能力的实现方案。主要流程包括硬件端注册与监听、小程序端调用两部分。硬件设备厂商需先向AMPE注册导航能力,并通过代码监听小程序发出的导航事件。当接收到“StartNavigation”请求时,硬件端解析经纬度、地址等参数,拉起本地导航并回传结果。小程序端则通过`my.call`方法调用`ampeStartNavigation`接口,传递目的地信息。此方案实现了小程序对硬件本地导航能力的直接调用,打通了两者的导航交互链路。 - [小程序获取硬件设备配置信息](https://opendocs.alipay.com/mini/02eizk.md): 本文档阐述了小程序获取硬件设备信息的机制,重点解决了可变信息的实时交互问题。硬件信息分为不可变信息和可变信息。文档详细介绍了两种获取可变信息的方式:一是小程序主动获取,通过调用`GetHWEnvironment`接口,硬件端监听并回传`isDarkMode`等参数;二是硬件设备动态发送,当配置变化时通过`ampeHWEnvChanged`接口实时向小程序推送事件。两者结合,确保了小程序能精准、实时地适配硬件环境变化。 - [小程序接入硬件设备拨打电话](https://opendocs.alipay.com/mini/0aboyu.md): 本文档主要阐述支付宝小程序硬件扩展(AMPE)中 `makePhoneCall` 接口的接入方案。针对部分硬件设备对电话能力的特殊处理需求,AMPE 允许厂商自定义实现拨打电话功能,否则沿用默认唤起方式。接入流程包含两个核心步骤:首先通过启动配置或 `AromeExtendBridgeRequest` 注册能力,推荐在 `AromeLaunchAppRequest` 中配置 `extensionList`;其次通过 `registerBridgeExtension` 监听小程序事件,在 `onCalled` 回调中识别 `makePhoneCall` 动作,解析号码参数并执行自定义拨号逻辑,最后通过回调返回结果。 - [小程序接入硬件设备地图位置](https://opendocs.alipay.com/mini/0abbjj.md): 本文档介绍了AMPE开放openLocation接口供硬件设备接入小程序地图定位功能的流程。该接口允许开发者自定义地图展示或使用默认内置地图,需传递地址、名称及经纬度参数。接入实现包含注册与监听两步:推荐在启动时配置扩展列表进行注册,或通过AromeExtendBridgeRequest注册;随后通过注册BridgeExtension监听小程序事件,匹配openLocation动作后执行自定义地图拉起逻辑并回调结果。 ##### 开发指南 - [AMPE 小程序开发指南](https://opendocs.alipay.com/mini/01l9vi.md): 本文档介绍了基于AMPE框架开发智能设备端支付宝小程序的完整流程。支付宝小程序具备轻量化、低成本及硬件拓展优势,通过AMPE框架可实现软硬件深度融合。开发流程包括入驻开放平台、搭建CLI环境、创建项目及获取AppID。支付宝提供IDE、CLI及VSCode结合IDE Lite等多种开发工具。开发过程中需适配设备屏幕尺寸,完成代码编写后,需进行硬件真机预览、版本上传与审核。最后,开发者需开通AMPE开放能力以在市场透出,并可针对专用终端关闭支付宝搜索可见性。 ##### 运营能力接入 - [小程序子服务](https://opendocs.alipay.com/mini/01kt6g.md): AMPE开放平台支持智能设备调用已绑定小程序的二级子服务能力,通过“服务直达”功能,配合设备语音或场景推荐,实现直接打开小程序特定页面的效果。接入流程包括在【小程序市场】预览服务、绑定应用、在【应用管理】添加子服务并获取服务code,最后通过接口调用启动。技术实现上,客户端使用AromeLaunchMiniServiceRequest请求类进行调用。该服务仅限企业支付宝账号接入,且当前仅支持智能汽车、智能音箱等安卓智能设备,典型应用示例为天猫精灵CC10。 - [情景智能服务](https://opendocs.alipay.com/mini/0248hu.md): AMPE平台推出「情景智能」服务,旨在通过人与设备的信息整合,在智能汽车、音箱等端外设备上为用户提供场景化服务,实现支付宝小程序“主动找人”与“主动找设备”。该服务支持智能消息与服务卡片两种接入方式,涵盖生活缴费、出行导航、物流提醒等12类场景,并支持电动汽车里程兑换蚂蚁森林能量等特色功能。接入流程涉及设备信息上报与用户授权校验,服务仅限企业支付宝账号接入安卓智能设备。 ##### API 列表 ###### 基础能力 - [批量添加小程序硬件设备](https://opendocs.alipay.com/mini/03rtx1.md): 该文档定义了支付宝接口`alipay.open.mini.ampe.device.add`,用于批量添加小程序硬件设备,支持第三方代理调用。适用场景为厂商完成硬件入驻后添加设备。文档详述了公共请求参数(如app_id、sign、timestamp)及业务参数(product_id、model_id、device_id_list),规定单次最多提交200个设备ID。提供了Java、PHP、C#的代码示例及正常与异常响应示例,并列出了BIZ_ERROR、INVALID_PARAMETER等业务错误码及其解决方案,为开发者提供了完整的接入指南。 - [批量删除小程序硬件设备](https://opendocs.alipay.com/mini/03q6oa.md): 本文档介绍了支付宝接口`alipay.open.mini.ampe.device.delete`,用于批量删除小程序硬件设备,支持第三方代理调用。文档详细说明了公共请求参数(如app_id、sign、timestamp等)和业务请求参数(product_id、model_id、device_id_list),其中设备ID列表单次最多提交200个。文中提供了Java、PHP、C#三种语言的请求示例,展示了请求构建与执行过程。此外,文档还列出了正常与异常的响应格式,并针对INVALID_PARAMETER和BIZ_ERROR等业务错误码给出了具体的解决方案,指导开发者正确集成接口。 - [查询绑定的小程序列表信息](https://opendocs.alipay.com/mini/03q9r0.md): 本文档介绍了支付宝接口`alipay.open.mini.ampe.bindedminiapp.batchquery`,用于查询绑定的小程序列表信息。该接口支持第三方代理调用,最多可查500条记录。文档详细说明了公共请求参数(如app_id、method、sign等)和业务请求参数(mobile_app_id、page_num、page_size)。提供了Java、PHP、C#三种语言的请求示例。响应参数包含绑定小程序的总数及详细信息列表(如ID、名称、状态、版本等)。文档还列举了正常与异常响应示例,以及INVALID_PARAMETER和BIZ_ERROR两种业务错误码的解决方案。 - [AMPE小程序不可用通知](https://opendocs.alipay.com/mini/03pxr4.md): 本文档定义了支付宝接口`alipay.open.mini.ampe.miniappstatus.changed`,用于通知AMPE小程序不可用状态变更。该接口支持绑定应用监听小程序在AMPE侧的不可用消息。核心参数包括公共参数(如通知ID、时间戳、签名等)和业务参数。业务参数主要包含小程序ID(mini_app_id)及操作类型(operate_type),操作类型涵盖关闭AMPE计划(close_ampe)和手动下架。文档提供了HTTP POST请求示例及业务错误码说明,明确了消息获取成功与失败的判定标准。 - [AMPE用户在设备端登陆变更通知消息](https://opendocs.alipay.com/mini/03q08y.md): 本文档定义了支付宝开放平台接口`alipay.open.mini.ampe.userlogin.notify`,用于通知AMPE用户在设备端的登录变更消息。文档详细规定了接口的公共请求参数,涵盖通知ID、时间戳、应用ID、版本号、签名信息及字符集等,以确保通信安全。核心业务参数封装于`biz_content`中,包含产品ID、名称、用户标识、设备标识及登录状态等关键数据。此外,文档提供了HTTP POST请求示例,并列举了`success`与`fail`两种业务错误码,为开发者接入该通知功能提供了完整的接口规范与参考。 - [AMPE运行维护消息通知](https://opendocs.alipay.com/mini/0eh3ms.md): 本文档定义了支付宝接口`alipay.open.mini.ampe.operation.notify`,用于向外部厂商发送AMPE运行维护消息通知。适用场景包括设备信息缺失及异常通知等。接口参数分为公共请求参数与业务请求参数。公共参数包含通知ID、时间戳、应用ID、版本号、签名及加密信息等,支持1.0与1.1协议版本。业务参数重点包含运维类型、设备ID及产品ID,其中运维类型支持“设备ID不存在”的枚举。此外,文档定义了业务错误码,用于反馈消息获取的成功或失败状态。 ###### 场景服务 - [查询指定产品开通的场景列表](https://opendocs.alipay.com/mini/03q08w.md): 本文档详细介绍了支付宝开放平台接口 `alipay.open.mini.ampe.scene.query`,用于查询指定产品开通的场景列表,并支持第三方代理调用。文档规定了请求必须包含公共参数(如app_id、签名、时间戳等)和业务参数(必选的product_id)。接口提供了Java、PHP、C#三种语言的请求示例。响应结果包含场景信息列表(场景ID和名称),文档还明确了公共响应参数、正常及异常响应示例,以及“调用应用不匹配”等业务错误码的解决方案。 - [查询用户关联的场景列表](https://opendocs.alipay.com/mini/03pxr2.md): 本文档详细介绍了支付宝接口 `alipay.open.mini.ampe.userscene.query` 的调用规范,该接口用于查询用户关联的场景列表,并支持第三方代理调用。接口请求需包含应用ID、签名、时间戳等公共参数,以及用户标识(user_key)、产品ID和设备标识(device_id)三个必选业务参数。文档提供了Java、PHP和C#三种语言的请求示例。响应数据包含网关返回码、签名及用户已选择的场景列表信息。此外,文档还列出了用户ID、产品ID或设备ID为空以及用户标识不合法等常见业务错误码的描述及相应解决方案。 - [修改用户关联的场景列表](https://opendocs.alipay.com/mini/03pxr3.md): 该文档详细介绍了支付宝开放平台接口 `alipay.open.mini.ampe.userscene.modify`,用于修改用户关联的场景列表,并支持第三方代理调用。文档首先阐述了接口的公共请求参数,涵盖应用ID、签名方式、时间戳等必要信息,指出业务参数需封装在 `biz_content` 中传递。核心业务参数包括必选的 `user_key`(用户标识)、`device_id`(设备标识)、`product_id`,以及可选的启用和禁用场景ID列表。文档提供了Java、PHP和C#三种语言的SDK调用示例,展示了具体的请求构建与执行流程。同时,文档列举了正常及异常响应的JSON格式示例,并针对 `user_key`、`product_id`、`device_id` 为空等常见业务错误码给出了解决方案,指导开发者正确排查参数缺失问题。 - [AMPE用户更改场景关系通知消息](https://opendocs.alipay.com/mini/03pxr5.md): 该文档定义了支付宝开放平台接口“alipay.open.mini.ampe.userscene.notify”,用于通知AMPE用户场景关系的变更。文档详细规定了公共请求参数(如通知ID、时间戳、签名信息等)和业务请求参数(如产品ID、用户标识、设备标识及变更类型)。此外,文档提供了基于HTTP POST的请求示例,展示了数据封装与传输格式,并列出了“success”与“fail”两种业务错误码及其含义,为开发者接入该通知接口提供了完整的技术规范。 - [情景推荐信息校验](https://opendocs.alipay.com/mini/0eha0k.md): 该文档介绍了支付宝接口 `alipay.open.mini.ampe.recommend.detect`(AMPE情景推荐信息校验)的功能与使用方法。该接口支持第三方代理调用,用于厂商验证接收到的情景推荐信息的完整性和有效性,验证通过后进行智能设备推送。文档详细列出了公共请求参数、业务请求参数(包括产品ID、设备标识和订单ID),并提供了Java、PHP和C#的代码示例。此外,还说明了响应参数结构,特别是校验结果字段 `valid`,并列举了推荐信息失效、参数为空、解密错误等常见业务错误码及其解决方案。 ###### 设备服务 - [AMPE设备信息上报权限查询](https://opendocs.alipay.com/mini/03q6od.md): 本文档介绍了支付宝接口`alipay.open.mini.ampe.collectright.query`,用于查询AMPE设备及用户是否具备信息上报权限,并支持第三方代理调用。接口请求需包含用户标识、设备产品ID和设备编号等核心业务参数。文档提供了Java、PHP及C#三种语言的调用示例,展示了完整的请求构建与执行流程。响应结果通过`can_collect`字段返回权限状态。此外,文档还列举了用户标识为空、标识非法及参数无效等常见业务错误码,并给出了相应的解决方案,为开发者接入提供了全面指导。 - [ampe设备信息上报](https://opendocs.alipay.com/mini/03q08z.md): 该文档详细介绍了支付宝接口 `alipay.open.mini.ampe.devicedata.create`,用于AMPE设备信息的上报,支持第三方代理调用。接口请求包含公共参数和业务参数,业务参数中必须包含用户标识、设备产品ID和设备标识,可选参数包括用户路由标识及JSON格式的设备详细数据(如导航位置、实时位置、设备状态等)。文档提供了Java、PHP、C#的请求示例,明确了响应参数结构,并列出了如“数据开关关闭”、“解析异常”等业务错误码及其对应的解决方案,指导开发者正确对接与调试。 ###### 对话服务 - [对话服务发送query](https://opendocs.alipay.com/mini/0ehdzv.md): 该文档详细介绍了支付宝接口`alipay.open.mini.ampe.chat.send`,用于向AMPE对话服务发送用户查询。接口支持第三方代理调用,请求需包含应用ID、签名、时间戳等公共参数,以及用户标识(openid或user_id)、AMPE产品与设备ID、原始query、会话ID、地理位置等业务参数。文档提供了Java、PHP、C#及HTTP的请求示例。响应结果包含编码后的对话内容。此外,文档还列举了系统繁忙、参数错误、设备未注册等常见业务错误码及其解决方案,指导开发者进行正确的接口调用与异常处理。 ##### 常见问题 - [开发问题](https://opendocs.alipay.com/mini/00vdmv.md): 该文档为AMPE Service常见接口问题的排查指南,涵盖初始化、登录、激活及小程序启动等场景。针对初始化无回调,需检查APK安装及后台服务白名单。Token失效需核对参数、配置AndroidManifest及检查厂商限制。启动无响应需排查后台自启动权限。激活失败(错误码2000/7001)多因系统解压致so文件丢失,需检查相关系统标志。错误码1004/2000需确认APK版本架构、网络连通性及设备时间,并可通过ADB命令拉起日志页面辅助排查。文档强调关注厂商系统差异及配置限制。 - [平台问题](https://opendocs.alipay.com/mini/00vbax.md): AMPE平台目前仅面向企业用户开放,支持企业主账号及管理员子账号进行入驻与管理。针对设备厂商关注的资金安全问题,平台实现了权限隔离,开放平台的子账号权限仅限于应用配置与AMPE后台管理,无法访问商家平台的资金信息,确保了主账号资金安全。在技术配置方面,添加移动应用所需的Android应用签名可在开放平台控制台的移动应用概览中获取。此外,公钥与私钥的生成可使用支付宝开放平台提供的开发助手工具,生成后需在移动应用设置中的“接口加签方式”处完成配置。 - [运营问题](https://opendocs.alipay.com/mini/03ryb8.md): 文档定义了情景智能端的两类消息类型:AMPE_RECOMMEND_PUSH用于进出场消息接收,WIDGET-CONTENT-PUSH用于平台场景(开放平台订阅场景)消息接收。进出场消息字段包含支付宝界面元素、服务信息、设备ID及核心事件类型(ENTER入场/EXIT出场)等。平台场景消息则针对话费提醒、外卖、电影票及停车洗车充电等服务推荐场景分别定义了字段结构,涵盖商家名称、订单状态、影院地址、服务卡片样式及优先级等关键参数,为不同业务场景的数据解析提供了规范。 - [网络相关问题](https://opendocs.alipay.com/mini/06e26m.md): 本文档主要包含AMPE系统的域名名单与流量评估两部分内容。域名名单列出了基础服务、车生活小程序及卡片功能所需的alipay、alibaba、amap等相关域名后缀,并建议咨询开发人员了解具体场景。流量评估部分提供了初始化、激活、小程序启动及静置等流程的耗时与流量数据。其中,初始化流量约160KB,首次冷启动小程序登录流量约3MB,静置24小时消耗约4.8MB。文档指出高频使用流量取决于小程序类型,需单独评估。该文档为系统配置和流量规划提供了核心参考依据。 - [更新日志](https://opendocs.alipay.com/mini/0hzr00.md): 本文档记录了支付宝开放平台2025年8月至2026年4月期间的API接口变更日志。主要内容包括接口参数更新与废弃接口删除。在更新方面,“alipay.trade.app.pay”接口新增个人代付单通道标识参数;多个账单数据查询接口(如余额、流水、买卖单查询等)新增了用户及系统限流错误码(USER_RATE_LIMIT、SYSTEM_RATE_LIMIT),并调整了部分字段描述。在删除方面,因业务变更,平台于2025年8月下线了“查询应用子服务信息”、“创建AMPE引导二维码”及“AMPE快递查询”三个接口。开发者需关注限流处理及接口废弃通知。 #### 多端开发 - [多端开发概述](https://opendocs.alipay.com/mini/006ks0.md): 多端开发允许开发者使用支付宝小程序接口编写一套代码,通过IDE发布至支付宝、钉钉、淘宝等多个端,实现“一次开发,多端触达”,有效节约开发成本。系统采用统一框架,各端共享基础语法与API(前缀`my`),并通过扩展对象(如`my.ap`、`my.dd`)支持特定能力。开发者需分别入驻各开放平台。开发过程支持端的灵活切换与真机预览,IDE内置互投评估工具以检测API兼容性。开发完成后,代码需上传至各对应平台审核发布。 - [各端通用组件和 API](https://opendocs.alipay.com/mini/006ks3.md): 文档阐述了小程序跨端开发的统一性,指出各端在框架、目录结构、基础组件及API上保持一致。文档核心为组件与API索引。基础组件涵盖视图、内容、表单、导航、地图等八大类。基础API包括网络、路由、交互反馈、动画、画布、节点查询、缓存、多媒体、设备信息、蓝牙、iBeacon及扫码等功能,为开发者提供了全面的技术支持参考。 - [各端扩展组件和 API](https://opendocs.alipay.com/mini/006ksb.md): 文档阐述了小程序在不同终端上的扩展机制,各端基于通用组件和API结合应用场景进行扩展。支付宝端文档位于支付宝开放平台,高德、天猫精灵等众多应用均采用其标准;淘宝端和钉钉端的文档分别位于各自开放平台。此外,支付宝IoT端、阿里车端及mPaaS端的扩展文档分别指引至支付宝开放平台、ALiOS开放平台及阿里云mPaaS文档中心。 - [IoT 端小程序开发](https://opendocs.alipay.com/mini/01n4yu.md): 本文档是一则关于IoT端小程序开发文档位置变更的通知。通知指出,由于文档结构进行了调整,原有的IoT端小程序开发文档已整体迁移至IoT专区文档目录下。该通知旨在告知用户文档路径的更新,请相关开发人员知悉此变动,并及时前往新的目录查阅相关开发文档。 #### 鸿蒙 - [概述](https://opendocs.alipay.com/mini/0d29p9.md): 本文档主要阐述了支付宝小程序在原生鸿蒙系统下的适配指南。鉴于鸿蒙系统存在行为差异及部分能力未支持,开发者需进行特定适配。文档介绍了环境判断方法,指出`my.env`和`my.getSystemInfo`返回的platform字段为'Harmony',而`my.getDeviceBaseInfo`返回'harmony',提醒开发者注意参数大小写。在WebView识别方面,提供了User-Agent示例,并警示避免将环境误判为华为浏览器。此外,文档强调了鸿蒙系统底部导航条对安全区域的影响,建议开发者在自定义tabbar等场景下注意适配。 - [差异和兼容性 ](https://opendocs.alipay.com/mini/0d2b4b.md): 该文档汇总了鸿蒙版支付宝与其他版本现存的差异,内容涵盖开放能力、组件及API三个方面。在开放能力上,Native渲染会降级为Webview渲染,小游戏暂不支持。在组件上,input组件仅支持系统键盘。在API上,文档详细列举了包括调试、界面、数据、文件、媒体、蓝牙及Beacon等在内的19个暂不支持接口,并明确从基础库2.9.37开始支持通过`my.canIUse`方法进行可用性判断,建议开发者务必在鸿蒙端验证后再进行变更。 #### 插件 - [插件介绍](https://opendocs.alipay.com/mini/006l32.md): 文档介绍了小程序插件的概念、特性、优势及应用场景。插件是独立封装的软件模块,拥有独立应用和上下文,与宿主小程序相互隔离,确保数据安全。相比普通组件,插件具备集成便捷、支持独立发版、数据安全性高及支持商业化结算等优势。文档列举了四大典型场景:在企业服务中封装复杂业务逻辑(如电子签名);在互动营销中隐藏后台细节(如直播服务);在流量变现中统一对接多渠道推广平台;在实用工具中固化操作流程(如OCR识别)。插件有效解决了功能集成、数据安全与开发效率问题。 ##### 插件获取与使用 - [小程序获取插件](https://opendocs.alipay.com/mini/006l39.md): 该文档旨在指导有服务能力插件需求的商家在支付宝平台上获取和使用插件。操作前需注意,必须使用小程序所属的支付宝主账号登录,且账号需完成实名认证。获取流程主要分为两部分:首先通过开放平台控制台进入小程序详情页,在“插件服务”中点击“订购其他插件”;其次,在选择所需插件(如支付宝卡包插件)并确认获取后,完成小程序的授权绑定。若账号下无小程序可即时创建。绑定完成后,商家可选择进行插件管理或直接配置小程序。 - [服务市场订购插件](https://opendocs.alipay.com/mini/03i228.md): 本文档介绍了在支付宝开放平台为小程序订购插件服务的完整操作流程。主要步骤包括:首先登录开放平台控制台,进入小程序详情页的“开发”管理下的“插件服务”板块,点击“订购其他插件”并选择目标插件;其次在详情页点击“立即订购”;接着选择对应的小程序并填写联系人信息,点击“授权并订购”;最后系统提示订购成功,用户即可开始使用该插件。该流程涵盖了插件查找、授权绑定及开通使用的全过程,步骤清晰简洁。 - [插件使用](https://opendocs.alipay.com/mini/006l3d.md): 文档详细介绍了支付宝小程序插件的使用方式,主要分为静态声明和动态加载,推荐使用静态声明的懒加载模式以提升性能。静态声明需在 app.json 中配置,支持普通模式及具备预加载、占位组件特性的懒加载模式,同时支持宿主向插件导出数据或提供自定义组件。动态加载通过 my.loadPlugin 接口按需引入,无需预声明,但不支持数据导出。文档还详细说明了两种模式的配置方法、版本兼容性要求、组件与页面的引用协议及 JS 接口调用方式,并指出了相关的使用限制和注意事项。 - [小程序模板使用插件](https://opendocs.alipay.com/mini/02gc7g.md): 本文档介绍了小程序模板支持使用插件的功能及操作指南。通过该功能,模板在实例化小程序时可自动为商户挂载并实例化插件,既方便模板开发者快速集成功能,也有助于插件开发者推广服务。操作流程包括:登录支付宝开放平台为模板添加插件(服务市场插件需先订购)、参照普通小程序步骤进行集成与联调、构建小程序。新构建的小程序将自动绑定插件,存量小程序需重新构建上传版本方可使用。 ##### 插件开发 - [插件应用创建](https://opendocs.alipay.com/mini/006l3j.md): 本文档介绍了小程序插件的创建流程及版本管理方法。创建路径需登录开放平台控制台,选择“小程序插件”并点击创建。随后按要求填写插件信息并确认,即可进入插件总览页进行后续开发、提审与发布。在版本管理方面,文档指引开发者下载小程序开发者工具(IDE)以开展具体的插件开发工作,并提供了相关开发文档的查阅入口。 - [插件开发](https://opendocs.alipay.com/mini/006l3o.md): 本文档是支付宝小程序插件开发指南,全面阐述了插件的开发规范与流程。首先介绍了插件的获取方式及开发限制,如不支持特定选择器、`getApp` 方法及 `web-view` 组件等。接着详细说明了插件的目录结构,以及 `plugin.json` 配置文件中组件、页面和接口的声明方式。文档指引了如何在开发者工具中创建并关联插件项目,并深入讲解了组件定义、页面跳转限制、JS 接口导出、通过 `requireMiniProgram` 获取宿主数据,以及利用抽象节点引用宿主组件等开发细节。最后,文档提供了页面栈隔离机制说明,汇总了插件跳转至宿主页面、其他小程序或插件的各种解决方案,并简述了真机预览与上传发布的流程。 - [插件多端开发](https://opendocs.alipay.com/mini/01jsg3.md): 本文档介绍了阿里生态中小程序插件的多端研发规范与流程。插件采用统一标准,开发者可使用小程序开发者工具通过同一份代码支持支付宝、钉钉、高德等多端的开发与发布。入驻方面,除钉钉和淘宝需独立平台外,其余端均在支付宝开放平台统一管理。文档详细说明了项目创建、多端切换、编码调试及版本上传发布的具体步骤,并提示开发者需注意各端接口与组件能力的差异,以确保插件兼容性。 - [插件联调](https://opendocs.alipay.com/mini/00j91p.md): 本文档介绍了支付宝小程序插件的联调功能,旨在允许开发者在插件发布前邀请主体小程序进行联合调试。该流程需插件方与小程序方配合:插件开发者先在管理后台添加主体小程序;小程序方进行授权确认(同主体自动授权);随后插件方设置体验版供小程序拉取。联调成立后可在IDE及真机进行测试。文档强调联调仅限开发预览环境,正式上线需完成订购;若无体验版需存在订购关系;且IDE内插件版本变更需重启项目。建议联调结束后及时解绑。 - [插件快捷联调](https://opendocs.alipay.com/mini/01phjs.md): 该文档介绍了支付宝小程序 IDE 新增的主体应用拉取真机预览版插件功能,旨在解决以往插件联调模式在代码频繁改动场景下使用不便的问题,提升联调效率。文档明确了使用该功能的前提条件,包括 IDE 及客户端版本要求、基础库版本兼容性及主体授权等。核心操作流程涵盖获取插件预览版本号,以及针对静态/懒加载插件和动态插件两类场景,分别在 app.json 和 mini.project.json 中进行声明与联调配置的详细步骤。最后,文档说明了 IDE 模拟器与真机调试的操作方法,并强调了该配置仅对线下版本生效、不支持直跳场景等多项注意事项。 ##### 插件发布 - [插件提审](https://opendocs.alipay.com/mini/006l3w.md): 本文档介绍了支付宝小程序插件完成开发上传后的审核与发布流程。开发者需登录支付宝开放平台,在插件详情页选择版本并提交审核。流程包含提交前自检、确认功能列表与版本信息、等待审核及最终上线等环节。审核期间支持撤回或设为体验版测试。审核通过后,插件需点击上线方可发布至服务市场。若审核未通过需根据驳回原因修改,上线前亦可选择退回开发重新编辑。 - [插件发布管理](https://opendocs.alipay.com/mini/030s8b.md): 本文档介绍了支付宝小程序插件发布到服务市场的完整流程与操作规范。发布前需确保账号为企业身份并已入驻相关平台,且插件已有线上版本。操作入口分为服务商平台与开放平台两种。创建服务时需填写名称、选择应用、介绍案例等,目前销售属性仅支持免费模式,提交后预计2个工作日完成审核。审核通过后,商家可在服务市场搜索订购,开发者可利用链接或二维码推广。此外,文档还提供了服务管理功能说明,支持对已发布服务进行修改、下架、展示或隐藏操作。 ##### 插件管理 - [插件管理](https://opendocs.alipay.com/mini/006l42.md): 本文档介绍了企业开发者通过插件中心管理插件的操作流程。核心步骤包括三个环节:首先,选择“我要使用插件”并点击“立即使用”;其次,点击“查看我获取的插件”进入相应页面;最后,在“已获取插件页面”根据需求对插件进行管理。该指南清晰地指引用户完成从入口进入到具体管理的全过程。 - [插件授权](https://opendocs.alipay.com/mini/006l46.md): 本文档说明了小程序插件授权机制,该授权由商家在插件中心订购触发,支付宝服务端通过HTTP协议向应用网关发送授权消息。文档详细解析了报文结构,包括通知校验ID、通知类型(固定为open_app_auth_notify)及业务内容(biz_content)。其中biz_content包含授权令牌(app_auth_token)、刷新令牌、授权方应用ID等关键信息,并说明了废弃字段与异常错误码处理建议。开发者需严格遵循处理逻辑:依据商家app_id与插件ID维度存储令牌以避免覆盖,利用auth_time保证令牌最终一致性,并按规定流程进行验签和消息识别。 - [插件后端开发](https://opendocs.alipay.com/mini/006l3s.md): 该文档主要阐述了支付宝小程序插件服务端开发的核心——**代调用**机制。由于插件无法独立运行,需协助商家调用支付宝接口,因此开发前需下载SDK。核心流程涉及两种授权:一是**商家授权**,插件通过配置应用网关接收回调或手动查找获取`app_auth_token`,建立PID与token的映射关系;二是**用户授权**,通过`auth_code`换取`auth_token`。最终,插件利用`app_id`、`app_auth_token`及`access_token`三者结合,实现代商家获取用户信息的完整调用链路。 - [插件版本升级](https://opendocs.alipay.com/mini/02ijt6.md): 该文档介绍了支付宝小程序插件版本管理功能的升级及使用方法。升级后,插件订购者可在小程序内使用指定版本插件。操作前需拥有小程序并已获取插件。操作流程包括:登录开放平台进入插件管理页面,点击“版本升级”按钮(仅一个线上版本时不显示);选择目标版本(默认最新);设置全网与内灰维度的灰度范围。设置后插件进入灰度状态,支持扩大范围。最终可选择“全量生效”完成升级,或“取消升级”回退至旧版本。 - [协助小程序更新插件](https://opendocs.alipay.com/mini/0bveuj.md): 本文档主要介绍了小程序插件服务中插件版本更新的机制与操作流程。插件更新分为自动更新和主动更新两种方式,通常由小程序使用者控制,但经授权后,插件服务商可协助进行版本升级。文档详细阐述了小程序启用自动更新的步骤,以及服务商如何通过管理后台查看已授权小程序列表。核心操作包括单个升级和批量升级,两者均支持灰度发布、比例调整、取消回退及全量生效,但批量升级不支持版本回滚且仅针对特定状态的小程序生效。此外,文档还明确指出在灰度发布期间,小程序端无法关闭自动更新开关,需等待升级结束或取消。 ##### 插件技术知识汇总 - [插件代商家获取会员手机号](https://opendocs.alipay.com/mini/01dznv.md): 文档介绍了支付宝小程序API `my.getPhoneNumber`,用于获取用户绑定的手机号。该功能需用户主动触发,通过button组件点击发起授权。使用前需满足插件绑定、AES密钥配置及客户端版本等限制。前端调用成功后返回加密数据,需发送至开发者后端进行验签和解密。文档提供了组件属性说明、前端调用示例代码,并列举了正常响应及无效授权、系统繁忙、签名类型缺失等异常响应代码及其解决方案,指导开发者安全实现手机号获取功能。 ###### 插件相关 API - [my.getParentAppIdSync](https://opendocs.alipay.com/mini/006l4c.md): 本文档介绍了小程序插件 API `my.getParentAppIdSync`,其功能是在插件中同步获取宿主小程序的 APPID。该接口要求基础库版本 1.21.0 及以上,低版本需进行兼容处理。接口返回包含 `appId` 字符串属性的对象。文档还指出,自基础库 2.7.17 起提供了功能更全的 `my.getAccountInfoSync` 接口,可同时获取小程序及插件的版本号。示例代码演示了调用方法及结果打印。 - [my.getPluginIdSync](https://opendocs.alipay.com/mini/02v9ao.md): 该文档介绍了支付宝小程序 API `my.getPluginIdSync`,用于同步获取插件 ID,仅支持在插件内调用。使用该接口需基础库 2.7.13 或更高版本,并支持个人与企业支付宝小程序。文档提供了包含兼容性判断的代码示例,接口返回一个 Object 对象,其中包含字符串类型的 `pluginId` 属性。此外,文档提及基础库 2.7.17起可使用 `my.getAccountInfoSync` 获取更多插件信息。 #### 安全 - [小程序开发安全指引](https://opendocs.alipay.com/mini/03nzps.md): 文档阐述了安全开发总原则及前后端安全实践规范。总原则强调零信任、权限最小化、数据代码保护。前端方面,要求禁止明文传输敏感信息,展示时须按身份证、手机号、银行卡等严格规范脱敏,核心代码逻辑应避免泄露,并强制使用SSL加密。后端方面,要求及时更新框架,严格实施接口鉴权防止越权攻击,规范OAuth流程。同时需防范批量攻击,校验数据与操作合法性防御注入与CSRF等攻击,并对文件上传下载进行严格的权限管控与隔离。 - [合规类安全要求](https://opendocs.alipay.com/mini/044v9v.md): 本文档阐述了支付宝小程序开发的强制性合规要求,涵盖数据安全、隐私合规、内容安全与生态安全四大方面。数据安全要求关注脱敏与加密;隐私合规强调最小化采集、明示协议及用户授权;内容安全严禁涉政、涉恐及低俗等违法信息。针对开发者,文档重点提出了合规获取信息、妥善处理数据及合理配置域名三大要点:包括禁止默认勾选隐私条款与诱导授权,保障用户拒绝权;数据传输需加密且使用不超范围,发生泄露需及时应急上报;域名配置应限定可信范围并禁止使用通配符,以防范数据泄露与违规内容投放。 - [保障商家安全](https://opendocs.alipay.com/mini/04q98t.md): 支付宝开放平台致力于保障商家信息与交易安全,提供三项核心安全服务。一是后端安全扫描,商家添加域名白名单时触发,由合作伙伴四叶草安全检测漏洞并通过控制台通知修复。二是小程序安全网关,采用终端风险对抗技术,实现端侧分析与决策,兼顾隐私合规,适用于营销反作弊、反黄牛等场景,具备签名对抗和异常行为分析等功能。三是交易安全防护产品RiskGo,为开发者提供一站式业务风险解决方案,精准识别交易与商家风险。 #### openid 开发指南 ##### openid 概览 - [openid 简介](https://opendocs.alipay.com/mini/0ai2i6.md): 支付宝开放平台宣布openid已全面开放,旨在替代userid成为稳定唯一的用户标识,以降低开发者适配成本。相比userid,openid能避免系统升位影响,且“棋盘密云”等新产品及未来新品仅支持openid。文档详细阐述了appid、openid、unionid及userid的定义与区别:openid用于应用维度的用户识别,而unionid用于同一商家账号下的跨应用用户识别。目前所有开放能力均已支持openid,开发者可通过控制台进行配置管理,也可申请灰度或回退至userid,文档还通过实例直观展示了不同场景下的标识生成逻辑。 - [ unionid 数据互通](https://opendocs.alipay.com/mini/0ai2i8.md): 本文档介绍了支付宝开放平台中用于实现多应用数据互通的unionid机制及应用分组功能。unionid作为同一用户在应用分组下的唯一标识,可解决跨应用统一会员识别问题。文档详细阐述了应用分组的三个使用限制:账号唯一性、应用绑定排他性及管理员权限要求。在操作层面,说明了绑定应用(本账号及跨账号)与审批流程,并指出分组最多绑定50个应用且不可解绑。最后,文档介绍了通过用户授权接口获取unionid的方法,并通过实例对比展示了利用unionid关联不同应用用户身份,避免重复注册,实现业务联动的具体应用场景。 ##### 自研开发 - [openid 开发流程](https://opendocs.alipay.com/mini/0ai5vq.md): 本文档介绍了为保护用户信息安全,支付宝开放平台接口升级至OpenID标准的接入指南。接入前需将服务端SDK升级至指定版本(Java、.NET、PHP、Python均有明确要求),且不支持Easy版SDK。获取OpenID主要有三种方式:通过用户授权接口获取、支付完成后从结果中获取、以及通过付款码解码查询。调用接口时需传入OpenID。针对常见问题,文档指出不同应用间的数据互通需使用UnionID;对于旧系统兼容性,建议根据应用关联情况选择正常接入或申诉回退至UserID模式;遇到SDK版本不支持报错时,可选择升级SDK或申请回退。 - [openid 开发配置升级](https://opendocs.alipay.com/mini/0ai4nj.md): 该文档介绍了开放平台接口为保护用户信息安全而升级至openid标准的操作流程。升级流程主要包含三个阶段:首先在控制台确认“开始升级”;其次进入“openid接入验证”阶段,接口同时返回uid和openid,开发者需改造应用并通过白名单和灰度验证兼容性;最后是“字段回收验证”阶段,接口仅返回openid,开发者需处理存量数据并再次进行验证。整个流程支持配置白名单测试和灰度流量控制,确保应用平稳过渡,最终完成升级。 ##### 服务商开发 - [openid 代开发流程](https://opendocs.alipay.com/mini/0aibp4.md): 为保障用户信息安全,支付宝开放平台接口升级至openid标准。本文档重点阐述代开发模式下第三方应用对接openid的流程与规范。核心机制要求商家应用授权后,接口交互内容仅包含openid,且入参必须使用openid。接入流程主要分为四步:一是创建或配置第三方应用,设定为“仅支持openid调用”;二是邀请商家授权,需注意授权前后调用标准的转换规则及已上架应用的例外情况;三是通过用户授权、支付回传或付款码解码获取openid;四是使用openid作为参数代调用接口。此举旨在强化隐私保护,规范接口调用标准。 - [第三方应用开发 openid](https://opendocs.alipay.com/mini/0ai9ol.md): 为保护用户信息安全,开放平台接口升级至openid标准,新开发者统一使用openid。建议服务商尽快升级第三方应用以兼容openid,避免影响代开发服务。兼容方案包括评估改造范围、配置应用支持双标识调用及后台系统改造。后台改造需校验商家应用标准,根据openid或uid返回值使用对应字段,调整数据库存储逻辑以兼容47位openid和16位uid,并改造下游消费系统。同主体数据互通建议使用unionid,异主体可通过手机号实现。 - [第三方应用与商家应用兼容](https://opendocs.alipay.com/mini/0ai85s.md): 为保护用户信息安全,开放平台接口正升级至openid标准,新入驻商家将统一使用openid,这可能导致第三方应用与商家应用的用户标识不兼容。文档提供了两种查询商家用户标识的方法:通过开放平台控制台或调用应用信息查询接口。针对不兼容场景,服务商需评估改造影响并选择两种解决方案:一是修改第三方应用用户标识以支持openid,从而服务更多商家;二是修改商家应用用户标识,可通过控制台配置或调用应用信息修改接口实现,操作时需确保商家业务能正常处理openid逻辑,以保障代开发服务的顺利进行。 ##### 存量 userid 转换 openid - [openid 配置申请](https://opendocs.alipay.com/mini/0ai9ok.md): 为保护用户信息安全,开放平台接口正逐步升级至openid标准,目前处于灰度阶段。商家账号作为升级主体,需主动申请才能从userid模式迁移。升级成功后,商家账号下的应用支持openid配置管理,需在控制台手动配置。操作流程涵盖提交申请、审批及后续的配置验证环节。此外,针对需对接外部系统或服务商未升级等特定场景,文档提供了回退至userid的申诉指引。 - [接口操作指南](https://opendocs.alipay.com/mini/0arv7p.md): 本方案旨在协助处于openid灰度阶段的商户,通过接口批量将存量userid转换为稳定唯一的openid。方案采用工单模型,核心流程包括创建工单、批量上传userid、提交审核及审核通过后查询openid。文档详细定义了 userid 与 openid 的概念,并提供了六个关键接口的功能说明与调用规范,涵盖工单的创建、数据上传、提交、结果查询、状态检查及取消操作。商户需遵循单次上传不超过100条、活跃工单不超10个等限制,利用工单ID串联整个转换链路,实现存量数据的平滑迁移。 ###### API 列表 - [创建openid批量转换工单接口](https://opendocs.alipay.com/mini/0arwjk.md): 本文档介绍了支付宝接口`alipay.open.app.openid.applyorder.create`,用于创建OpenID批量转换工单,支持第三方代理调用。文档详细规定了公共请求参数(如app_id、method、sign等)和业务响应参数(返回order_id工单ID)。提供了Java、PHP、C#及HTTP的请求代码示例,展示了SDK配置与调用流程。响应部分区分了正常与异常情况,并列表说明了SYSTEM_ERROR、OPEN_ID_NOT_SUPPORT等业务错误码的含义及解决方案,指导开发者在遇到系统异常、权限未开启或工单超限等情况时进行正确处理。 - [批量上传用户userid到openid转换工单](https://opendocs.alipay.com/mini/0ar4ll.md): 本文档介绍了支付宝接口 `alipay.open.app.openid.applyorder.upload`,用于批量上传用户userid到openid转换工单,支持第三方代理调用。接口核心请求参数包括工单ID(order_id)和用户ID列表(user_id_list),单次调用限制最多100个用户ID。响应结果包含非法用户ID列表。文档提供了Java、PHP、C#及HTTP等多种语言的请求示例,详细展示了SDK初始化、参数构建及请求执行流程。此外,还列举了系统错误、参数无效、工单状态不匹配等业务错误码及其解决方案,并明确了仅未提交状态的工单支持此操作。 - [openid转换工单提交审核接口](https://opendocs.alipay.com/mini/0arxyn.md): 该文档介绍了支付宝接口`alipay.open.app.openid.applyorder.submit`,用于提交OpenID转换工单审核。接口支持第三方代理调用,核心业务参数为工单唯一标识`order_id`。文档详细列出了公共请求参数(如app_id、签名、时间戳等)的规范,并提供了Java、PHP、C#的请求代码示例。响应示例展示了成功与失败的标准格式。此外,文档枚举了包括系统繁忙、工单状态不匹配、ID无效等在内的多种业务错误码及其对应的解决方案,为开发者排查调用故障提供了明确指引。 - [根据支付宝用户userid批量获取用户openid和unionid](https://opendocs.alipay.com/mini/0are0o.md): 本文档介绍了支付宝接口 `alipay.open.app.openid.batchquery`,旨在帮助合作伙伴将存量用户ID数据升级为OpenID和UnionID。接口支持第三方代理调用,核心功能是根据用户ID列表批量查询对应的OpenID和UnionID。请求需包含必选参数 `user_id_list`(用户ID列表)和 `order_id`(工单ID)。响应结果包含映射后的OpenID列表及非法用户ID列表。文档提供了Java、PHP、C#及HTTP的请求示例,并详细列出了公共参数与业务参数。此外,文档定义了系统错误、工单状态不匹配、用户ID无效等业务错误码及其解决方案,确保开发者能准确处理接口调用中的异常情况。 - [检查转换工单审核状态接口](https://opendocs.alipay.com/mini/0arju6.md): 本文档介绍了支付宝接口 `alipay.open.app.openid.applyorder.checkavailable`,用于检查OpenID转换工单的审核状态,并支持第三方代理调用。核心请求参数为可选的工单ID,若不指定则返回最近10条工单。响应包含工单列表,详细说明了工单的六种状态(初始、审核中、已驳回、转换中、已取消、完成)及驳回原因。文档提供了Java、PHP、C#的调用示例,以及系统繁忙、工单ID无效等业务错误码的解决方案,帮助开发者集成与排查问题。 - [取消openid转换工单接口](https://opendocs.alipay.com/mini/0are0p.md): 本文档介绍了支付宝接口`alipay.open.app.openid.applyorder.cancel`,用于取消OpenID转换工单,支持第三方代理调用。接口要求传入工单唯一标识`order_id`作为必选业务参数,并遵循支付宝开放平台标准的公共参数规范(如RSA2签名)。文档提供了Java、PHP、C#三种语言的请求示例,展示了请求构建与响应处理流程。针对调用过程中可能出现的系统繁忙、应用未处于升级流程、工单ID无效或不匹配、工单状态不满足取消条件等业务错误,文档给出了具体的错误码描述及相应的解决方案。 - [openid申诉回退到userid](https://opendocs.alipay.com/mini/0ai736.md): 本文档说明了支付宝开放平台申请从 openid 回退到 userid 开发模式的流程。申请条件主要包括系统基于 userid 开发导致升级成本高,或 openid 无法支持特定业务场景(如间连支付)。开发者需在平台控制台的“openid配置管理”中提交申诉,审核通过后可进行切换操作。切换后,接口交互将统一使用 userid。文档特别警示,已上架的应用进行此操作可能导致线上运行故障,需谨慎评估风险。 #### 扩展能力 ##### 开发质量 ###### 功能解决方案 - [内嵌H5页面访问受限](https://opendocs.alipay.com/mini/018uni.md): 本文档主要阐述了支付宝小程序页面访问受限问题的现象、原因及解决方案。受限页面会拦截用户访问,导致用户无法继续操作,仅能返回或关闭。统计表明,此类问题与用户流失率及负面反馈呈正相关,严重影响用户体验。文档详细分析了六种常见错误码,涵盖域名非https格式、未配置H5域名白名单、使用http协议以及Scheme链接格式错误等情形。针对不同错误,文档提出了具体的解决策略,包括升级服务器支持https协议、在开放平台配置域名白名单、检查URL格式规范以及使用API替代Scheme链接进行跳转,旨在帮助开发者快速定位并修复问题,提升用户留存率。 - [页面不存在](https://opendocs.alipay.com/mini/03qty8.md): 该文档详细阐述了小程序“页面不存在”错误的成因、影响及解决方案。当用户访问不存在的页面时,系统展示错误页,用户仅能返回首页或关闭小程序。此问题与用户流失率及负面反馈呈正相关,严重影响用户体验。 根本原因在于用户访问了启动包中不存在的页面或路径错误。文档重点分析了两种常见错误码:043002005由逻辑层代码异常导致Page函数未执行引起,建议排查代码监控;043002006则因小程序版本不含该页面或链接配置错误导致,建议检查唤起源配置或使用onPageNotFound监听进行重定向兜底。 - [内嵌H5加载异常](https://opendocs.alipay.com/mini/03qty6.md): 本文档阐述了小程序内嵌H5页面加载异常的成因与应对策略。当web-view请求服务端失败(如404、502错误)时,支付宝会展示统一错误页面并透出错误码。统计表明,此类加载问题与用户流失率及负面反馈呈正相关,严重影响用户体验。文档重点分析了errorCode-1202及subErrorCode-404错误,指出其通常由服务器文件删除、迁移、修改导致路径错误或URL拼写拼接不当引起。建议开发者通过检查站点配置、确认资源存在、谨慎处理文件变更及URL拼接来解决问题,以降低流失率,保障小程序稳定运行。 - [弹窗报错](https://opendocs.alipay.com/mini/0d9s19.md): 文档主要阐述了小程序中“弹窗报错”的定义、成因、影响及常见解决方案。弹窗报错指界面显示异常信息,导致功能不可用且缺乏用户引导,严重影响体验。其根本原因在于业务逻辑对未预期场景处理不当,多发于页面加载或用户交互时。常见原因包括两类:一是网络接口请求异常,表现为网络繁忙提示,需通过检查错误码、域名证书、端口及服务日志解决;二是ISV权限不足,源于未配置产品或密钥等,需参照权限问题指引解决。 - [白屏](https://opendocs.alipay.com/mini/018unh.md): 文档主要阐述了小程序白屏的定义、成因及优化方案。白屏指页面无节点状态,支付宝框架在6秒后进行判定。其核心原因在于页面存在接口依赖,若数据未返回则页面空白。主要诱因包括接口超时、getAuthCode等JSAPI超时异常及jserror报错。针对接口超时问题,文档建议采用接口缓存策略去除网络依赖,并推荐接入ant-skeleton骨架屏组件,在数据加载期间展示占位内容,从而有效避免白屏并提升用户体验。 ###### 稳定性解决方案 - [资源文件请求异常解决方案](https://opendocs.alipay.com/mini/01b3ho.md): 文档主要介绍了小程序开发中常见的资源异常类型、排查方法及具体错误解决方案。资源异常主要分为请求接口报错和静态资源加载报错两类,可通过支付宝云监控在移动端或PC端进行排查,查看异常率与请求URL等数据。文档详细分析了四种常见错误:一是图片资源为undefined/null,多因变量未赋值或异步渲染导致,需做空值兼容处理;二是URL格式错误,含特殊符号或中文,需修正为标准格式;三是域名解析出错,涉及DNS故障或域名过期,需检查网络与域名状态;四是证书错误,如过期或不匹配,需续费或重装SSL证书。 ###### 性能解决方案 - [性能解决方案](https://opendocs.alipay.com/mini/018tp6.md): 该文档旨在指导开发者优化支付宝小程序的首屏启动耗时,以提升用户体验并降低流失率。首屏启动耗时定义为用户点击至内容完全显示的时间。文档从五个核心维度提出了优化方案:在代码包准备方面,建议使用分包加载、预下载,并控制包内图片大小;在网络图片方面,强调控制图片大小、并发数及请求数,推荐使用懒加载与雪碧图;在JSAPI调用方面,需减少同步接口使用,避免重复与高频并发调用;在setData优化方面,应控制单次数据量与调用频率,采用分批渲染;在网络请求方面,建议利用缓存、缩短URL长度并优化服务器响应。全文为提升小程序性能提供了具体的标准与实施策略。 - [附录一:优化 setData 逻辑方案明细](https://opendocs.alipay.com/mini/018srb.md): 文档主要阐述了小程序中优化 `setData` 逻辑的方法。首先分析了四种触发渲染接口的区别,指出页面级接口会触发全量差异比较,而组件级接口仅触发局部比较。基于此,提出了四项核心优化建议:避免频繁调用接口;将频繁渲染逻辑封装为自定义组件以缩小渲染范围;长列表使用 `$spliceData` 追加数据;复杂页面组件化。在代码实践中,推荐使用路径表达式更新数据,避免直接修改 `this.data`。此外,针对页面触发组件渲染的场景,提供了将组件实例挂载到页面以实现精准调用组件 `setData` 的解决方案。 - [小程序启动耗时优化-高级发布策略](https://opendocs.alipay.com/mini/02d4vk.md): 该文档介绍了小程序“高级发布策略”的功能、操作流程及技术补充方案。该策略旨在通过优先访问本地缓存和异步下载新版本,优化启动耗时,平均减少约200ms,目前仅面向特定邀约小程序开放。启用流程包括上传版本、点击上架、选择策略及确认完成。策略分为“性能优化”(适合日常迭代,启动快但覆盖慢)和“覆盖优先”(适合重大变更,覆盖快但启动慢)。此外,针对低频访问用户可能无法及时更新版本的问题,文档建议使用UpdateManager API检测新版本并提示用户重启更新。 ##### 社区方案 - [TypeScript 支持](https://opendocs.alipay.com/mini/00ulpw.md): 文档介绍了支付宝小程序官方提供的 TypeScript 类型定义包 `@mini-types/alipay`。核心内容包括该包的安装指令,以及在 `tsconfig.json` 文件中通过配置 `types` 字段进行引用的方法。文档还提供了项目 GitHub 源码地址,指引查阅详细 README 文档,并说明了通过提交 issue 进行问题反馈的渠道。 ### 框架 - [框架概述](https://opendocs.alipay.com/mini/038o21.md): 本文档主要介绍了小程序的架构体系,涵盖文件结构、逻辑结构及第三方NPM模块支持。在文件结构上,小程序分为应用描述层和页面描述层,分别由特定的文件组成并置于规定目录,最终代码打包为单一脚本运行。在逻辑结构上,核心采用响应式数据绑定系统,实现视图层与逻辑层的同步更新。文档强调了框架非浏览器环境,禁用`window`等保留字作为导入符号。此外,文档说明了NPM模块的安装引入方法及开启语法转换配置的注意事项。 - [目录结构](https://opendocs.alipay.com/mini/04a41u.md): 该文档阐述了小程序项目的目录结构规范。项目包含三个全局文件,其中app.js和app.json为必需,分别负责逻辑与配置,app.acss为可选样式文件。每个页面由四个文件组成,js、json和axml为必需,分别负责逻辑、配置和结构,acss为可选样式。项目根目录下的mini.project.json文件用于配置编译开发功能,可通过miniprogramRoot指定源码目录。文档提供了目录示例,并强调小程序包体积限制在2MB以内。 #### Native 渲染 - [概览](https://opendocs.alipay.com/mini/0ai07p.md): 文档介绍了小程序Native渲染引擎,旨在解决WebView渲染存在的冷启动慢、渲染耗时长及交互体验差距等问题。Native渲染引擎具有更高的效率,兼容绝大部分WebView样式,并支持拓展增强特性,提供接近原生的应用体验。目前该能力已作为实验性功能开放。开发者需在支付宝客户端10.5.70及以上版本和基础库2.9.6及以上版本的环境中,通过扫描二维码体验已支持Native渲染的“小程序示例”。 - [差异和兼容性](https://opendocs.alipay.com/mini/0ahw0b.md): 该文档详细汇总了小程序 Native 渲染引擎与 WebView 渲染引擎的差异及兼容性判断方式。在框架层面,页面及组件的 `createIntersectionObserver` 等观察器、SJS 事件中的 DOM 操作及组件选择方法暂不支持。组件方面,`cover-view`、`textarea`、`picker` 等大量组件暂不支持,`input`、`canvas`、`web-view` 等组件需特定基础库或客户端版本。API 方面,`createIntersectionObserver` 等接口不可用,Canvas 相关接口已支持,`createSelectorQuery` 有限制。开发者应利用 `my.canIUse` 方法进行可用性检测,以确保功能兼容。 - [从 WebView 迁移](https://opendocs.alipay.com/mini/0ahxv0.md): 本文档详细说明了支付宝小程序 Native 渲染功能的配置方法与环境要求。首先,启用该功能需满足支付宝客户端 10.5.70及以上、基础库 2.9.6及以上,且真机预览需 IDE 版本 3.8.4以上。开发者可通过在 app.json 或页面 JSON 中配置 `renderer` 字段为 "native" 来启用渲染,支持应用级全局配置与页面级单独配置,且页面级配置优先级高于应用级。此外,文档还介绍了如何利用 `rendererOptions.native` 字段设定基础库及客户端的最低版本限制,其实际生效条件为应用级与页面级配置的交集。最后,开发者可通过页面或组件实例的 `this.renderer` 属性识别当前渲染模式。 - [ACSS 样式支持度](https://opendocs.alipay.com/mini/0bwyd9.md): 该文档详细规定了特定环境下的CSS支持规范。在模块层面,支持动画、过渡、Flex布局等核心功能,但Positioned布局缺失sticky支持,font-face限制字体属性。选择器全面支持常规类型,包括属性选择器及部分伪类,伪元素仅限::before和::after。属性列表明确了默认值与限制,如overflow不支持scroll需用组件替代,box-sizing默认为border-box。媒体查询特性依赖客户端版本。动画支持transform及尺寸属性变更,但skew与perspective不支持动画。数据类型涵盖多种单位与颜色格式,为开发者提供了详尽的技术参考标准。 #### 性能与优化 - [概述](https://opendocs.alipay.com/mini/0aw6si.md): 小程序性能直接影响用户体验与留存,加载缓慢、频繁报错及交互卡顿会导致用户流失。其运行采用双线程架构,webview负责渲染,worker负责逻辑,两者通过异步通信传输序列化数据,数据量影响性能。启动流程包括四个阶段:资源准备阶段负责下载包与初始化环境;代码注入阶段执行JS并触发应用生命周期;首次渲染阶段完成首屏绘制并触发Page.onReady;业务渲染阶段通过setData完成完整内容绘制。 - [性能优化建议](https://opendocs.alipay.com/mini/03a4p2.md): 本文档主要探讨小程序性能优化策略,聚焦于首屏渲染速度提升与 `setData` 逻辑优化。首屏优化方面,建议通过清理无用资源控制包体积,将数据请求提前至 `onLoad` 生命周期,并分步传输数据以控制首屏渲染节点数量。在 `setData` 优化上,文档建议避免频繁调用,优先使用路径更新数据,针对长列表使用 `$spliceData`,并将复杂业务封装为自定义组件以缩小渲染范围。此外,文档还强调了在列表渲染中使用 `key` 参数对性能提升的重要性。 - [MYWebAssembly](https://opendocs.alipay.com/mini/0b2bz8.md): MYWebAssembly 是支付宝小程序提供的类 WebAssembly 接口,旨在提升小程序性能。该功能仅支持在 Worker 线程内使用,iOS端需开启实验 Worker,并要求基础库 2.9.7 及客户端 10.5.60 以上版本。MYWebAssembly 仅支持 instantiate、Table、Memory、Global 和 Instance 方法,其中 instantiate 方法的参数仅接受代码包内的绝对路径。文档详细列出了双端对 Bulk memory、SIMD、Exception handling 等特性的支持差异,并提供了创建 Worker 及调用 MYWebAssembly 的代码示例。 - [小程序运行机制](https://opendocs.alipay.com/mini/038x6a.md): 本文档详细阐述了支付宝小程序的运行机制。首先介绍了小程序的下载机制,首次使用时下载资源并缓存,后续访问可跳过下载以提升速度。文档明确了冷启动与热启动的区别:冷启动执行初始化并触发onLaunch,热启动仅从后台切换至前台并触发onShow。在运行状态上,区分了前台与后台运行,并说明了通过onShow和onHide监听切换的方法。缓存部分指出单个小程序上限为10MB,提供了同步与异步的存储、读取、清除等API接口。销毁机制方面,关闭操作仅使小程序进入后台,只有在后台时间过长或资源占用过高时才会被系统销毁。最后,文档解答了Cookie使用、缓存清理、权限报错及版本兼容性等常见问题。 - [骨架屏](https://opendocs.alipay.com/mini/0bx5sa.md): 骨架屏是在页面数据加载前通过灰色区块展示轮廓的优化技术,需基础库2.9.99及以上版本支持。开发者可在app.json中通过ignorePages和externalPages字段灵活配置宿主及插件页面的渲染策略,支持全局与页面级文件定义。文档提供了丰富的内置变量及异步对象以获取系统信息和样式数据,并推荐使用异步对象替代已废弃的ACSS变量。此外,通过设置超时时间与手动调用移除方法,可实现骨架屏的延迟下屏,确保关键数据加载完成后再展示真实视图。 #### 小程序全局配置 - [项目配置](https://opendocs.alipay.com/mini/03dbc3.md): 本文档详细介绍了小程序项目配置文件 mini.project.json 的功能与属性规范。该文件用于定制项目的编译与开发行为,要求 IDE 版本 3.0.1 及以上。文档核心内容涵盖基础配置(如编译类型、源码路径)、编译选项(如 TypeScript/Less 支持、路径别名 resolveAlias、代码转译 transpile)、资源打包策略(黑名单 uploadExclude 与白名单 assetsInclude)以及开发调试选项。此外,还详细说明了插件联调配置 pluginResolution 和预处理脚本 scripts 的使用方法,旨在帮助开发者优化构建流程、管理项目资源及解决包体积超限等问题。 - [项目配置(旧版)](https://opendocs.alipay.com/mini/038q8l.md): 本文档说明了小程序项目配置文件 `mini.project.json` 的使用方法,该文件位于项目根目录,用于定义编译与打包策略。核心配置项涵盖了源码路径设置、编译类型选择、axml严格语法检查、Component2及Appx2.0特性启用、多进程编译与产物压缩优化等。文档还详细介绍了预处理脚本的配置,支持在编译、预览或上传前执行自定义命令;以及打包黑白名单(include/exclude)规则,用于管理资源文件包含与忽略,解决包体积超限问题。此外,还包含了用于开发调试阶段的 debugOptions 配置说明。 - [迁移至新项目配置](https://opendocs.alipay.com/mini/09j22u.md): 本文档介绍了小程序项目配置新格式的功能特性与迁移指南。format2 新增了 TypeScript/Less 支持、Tree-shaking 优化、路径别名及代码转译等配置,旨在提升研发效率。IDE 3.8.1 及以上版本支持自动升级配置。文档详细说明了手动迁移步骤,特别是针对 node_modules 转译行为(如 enableNodeModuleBabelTransform 和 node_modules_es6_whitelist)的变更,提供了三种迁移案例并建议避免全量转译以优化构建速度。此外,新格式默认使用基础库 2.0,停止支持 1.0。文档最后列出了旧有配置项与新配置项的映射关系表,帮助开发者平滑过渡。 - [小程序应用配置介绍](https://opendocs.alipay.com/mini/038rmx.md): 本文档介绍了小程序顶层应用 `App()` 的核心概念与结构。`App()` 作为构造方法生成唯一的 App 实例,负责管理所有页面、全局数据及生命周期回调。小程序顶层通常包含三个文件:`app.json`(应用配置)、`app.js`(应用逻辑)和可选的 `app.acss`(应用样式)。文档通过代码示例展示了 `app.json` 中页面路径与窗口标题的配置方法,以及 `app.js` 中 `onLaunch`、`onShow`、`onHide`、`onError` 等生命周期回调函数的定义与全局数据 `globalData` 的声明方式。 - [app.json 应用配置](https://opendocs.alipay.com/mini/038rmy.md): 本文档详细介绍了小程序全局配置文件 `app.json` 的功能与属性。`app.json` 用于设置页面路径、窗口表现、多Tab、分包及插件等。核心配置项包括:`pages` 定义页面路径及首页;`window` 设置导航栏、背景色及下拉刷新等窗口样式;`tabBar` 配置底部导航栏样式与菜单项;`subPackages` 与 `preloadRule` 管理分包加载与预下载。此外,文档还阐述了全局组件声明、代码懒加载、网络超时、接口权限及运行行为修改等高级功能配置,并提供了各配置项的参数说明、版本要求及常见问题解答。 - [app.acss 全局样式](https://opendocs.alipay.com/mini/038rmz.md): 文档阐述了 `app.acss` 文件在小程序架构中的定位与功能。该文件作为全局样式文件存在,其定义的样式规则具有全局效力,能够作用于当前小程序项目内的所有页面,实现样式的统一管理。此外,文档提示开发者可通过查阅“ACSS 语法参考”获取更深入的样式编写知识。 - [app.js 注册小程序](https://opendocs.alipay.com/mini/038q8m.md): 该文档详细介绍了小程序 `App()` 方法的注册规范与生命周期管理。`App()` 必须在 `app.js` 中调用且仅限一次,用于配置小程序的初始化、显示、隐藏等生命周期回调,以及错误监听、全局分享和页面不存在等事件处理。文档明确了小程序前后台的定义及销毁机制,解析了启动参数的获取方式,强调了开发过程中的注意事项,如禁止在特定生命周期内操作页面栈。此外,还介绍了 `globalData` 全局数据存储、自定义函数挂载及 `getApp()` 调用方法,并解答了无法在 `app.js` 中关闭小程序的常见问题。 - [getApp 方法](https://opendocs.alipay.com/mini/038rn0.md): 文档介绍了小程序中用于获取应用实例的全局方法 `getApp()`。该方法主要用于在子页面中获取顶层应用实例,以便访问全局数据。文档提供了基本用法示例,并强调了三项注意事项:首先,在 `App()` 函数内部不可调用 `getApp()`,需使用 `this` 获取实例;其次,获取实例后请勿手动调用生命周期回调函数;最后,需严格区分全局变量与页面局部变量。文档通过代码示例说明,各文件中声明的局部变量仅在当前文件有效,互不影响,而通过 `getApp()` 访问的全局数据则可在不同页面间共享和修改。 - [小程序 tabBar、titleBar 多语言配置](https://opendocs.alipay.com/mini/038rn1.md): 本文档介绍了小程序tabBar与titleBar的多语言配置方法。小程序会依据支付宝客户端语言自动读取相应配置。配置需遵循特定目录结构:在根目录创建locale文件夹,内含以语言代码命名的子目录,通过app.json文件配置对应语言的界面文本。目前仅支持简体中文、繁体中文(台湾/香港)及英文四种语言,且需使用真机调试查看效果。配置时,根目录app.json定义页面路径,而语言包app.json定义具体的名称与标题,两者协同实现国际化适配。 - [ACSS 语法参考](https://opendocs.alipay.com/mini/038rnl.md): ACSS 是一套用于描述 AXML 组件样式的语言,其规则与 CSS 完全一致,并针对小程序开发进行了扩充。ACSS 支持 px、rpx 等单位,其中 rpx 为响应式像素,规定屏幕宽度为 750rpx,可实现自适应布局,且框架已处理好多端兼容性。 ACSS 支持通过 `@import` 导入外联样式表,支持相对路径、绝对路径及第三方模块路径。组件支持 style 和 class 属性,建议静态样式使用 class 以提升渲染速度。选择器规则同 CSS3,但禁用系统保留类名及属性选择器。app.acss 定义全局样式,页面 acss 定义局部样式。本地资源引用需使用绝对路径。针对样式污染问题,可通过配置 styleIsolation 解决;页面高度 100% 无效则需依赖父容器高度或使用绝对定位。 #### 小程序页面 - [小程序页面介绍](https://opendocs.alipay.com/mini/038q8n.md): 文档详细介绍了小程序中 **Page** 的概念与用法。Page 代表应用的一个页面,负责展示与交互,通常对应一个包含 .js、.axml、.json 和 .acss 四个文件的子目录。页面通过 `Page` 构造函数注册,利用 `data` 对象初始化数据,并在 AXML 中使用双花括号语法进行数据绑定与渲染。文档还阐述了交互逻辑的实现,即通过绑定事件(如 `onTap`)触发脚本中的响应函数。特别强调了更新页面状态必须使用 `this.setData` 方法,该方法会触发视图层的重新渲染,实现数据驱动视图更新。 - [页面配置](https://opendocs.alipay.com/mini/038q8o.md): 文档介绍了支付宝小程序页面`.json`文件的作用与配置方法。该文件用于配置页面窗口表现,其设置会覆盖全局`app.json`中的同名`window`配置项。除支持所有全局窗口配置外,页面配置还额外支持三个属性:`optionMenu`(设置导航栏图标,即将废弃)、`titlePenetrate`(设置导航栏点击穿透)和`barButtonTheme`(设置导航栏图标主题)。文档详细列出了这些属性的类型、功能描述及最低支持版本,并提供了配置代码示例。针对导航栏自定义的常见问题,文档指出目前不支持完全自定义,仅支持通过API隐藏返回图标、设置样式或控制加载动画。 - [页面结构](https://opendocs.alipay.com/mini/038rn2.md): 本文介绍了小程序开发中`.axml`文件的作用与语法特性。文档指出,位于`/pages`目录下的`.axml`文件主要用于定义当前页面的结构。在语法规范上,该文件内容遵循AXML语法。文档特别强调,虽然AXML与HTML在形式上非常相似,但两者之间存在诸多不同之处,开发者需要注意区分。如需了解更深入的语法细节,建议查阅相关的详细技术文档。 - [页面样式](https://opendocs.alipay.com/mini/038rn3.md): 本文档主要介绍了小程序页面样式(.acss)的定义方法与样式隔离机制。文档指出,`/pages` 目录下的 .acss 文件用于定义页面样式,且页面根元素为 `page`,支持设置背景色等属性。核心内容在于阐述页面样式隔离配置:默认情况下页面样式对外产生影响,但从基础库 2.7.2 版本起,开发者可在 .json 文件中配置 `styleIsolation` 属性。该属性支持 `apply-shared`(接受外部样式影响但不影响外部)和 `shared`(默认值,样式双向互通)两个选项,以此实现灵活的样式作用域管理。 - [页面运行机制](https://opendocs.alipay.com/mini/038q8p.md): 本文档详细阐述了小程序中 `Page(object)` 方法的使用,用于注册小程序页面。核心内容包括:通过 object 参数配置页面的初始数据、生命周期回调函数及事件处理函数。文档重点说明了 `data` 对象的定义与更新机制,强调必须使用 `setData` 方法更新数据,不可直接修改。页面生命周期涵盖从加载、显示、渲染完成到隐藏、卸载的各个阶段。此外,详细介绍了 `onShareAppMessage`等页面事件处理函数,以及用于统一管理扩展事件(如 `onBack`、`onResize`)的 `events` 对象。最后,文档列举了 `setData`、`createSelectorQuery` 等实例方法及 `route`、`router` 等实例属性,为小程序页面开发提供了完整的API参考。 - [getCurrentPages 方法](https://opendocs.alipay.com/mini/038rn4.md): `getCurrentPages()` 方法用于获取当前小程序页面栈的实例,返回一个数组,其首元素为首页,末元素为当前页面。小程序通过栈结构管理页面,不同的路由方式(如初始化、打开新页面、重定向、返回及Tab切换)对应特定的入栈或出栈操作,文档明确警告不可修改页面栈以防状态错误。该方法支持 `getAllPages` 参数(需基础库2.7.7+),用于解决宿主小程序与插件间的页面实例隔离问题。开启该参数可获取跨域页面的代理实例以读取 `route` 路径信息,但无法调用页面方法或获取页面参数。示例代码展示了利用页面栈长度判断页面层级及相应的路由跳转逻辑。 - [Router](https://opendocs.alipay.com/mini/03uzdq.md): 文档介绍了页面路由器对象,包含 navigateTo 等五个方法,可通过 this.pageRouter 或 this.router 获取。与全局 my.* 方法相比,其核心优势在于相对路径基于当前页面或组件路径解析,而非栈顶页面,开发者更推荐使用。该特性需基础库 2.7.22+ 支持。在页面中,两者等效且相对于当前页面;在自定义组件中,this.router 相对于组件定义路径,this.pageRouter 则相对于所在页面路径。文档还指出了插件权限隔离、组件嵌入宿主时 pageRouter 为空以及页面销毁后调用失效等限制,并通过代码示例对比展示了不同场景下的跳转差异。 - [页面常见问题](https://opendocs.alipay.com/mini/038x5q.md): 本文档主要汇总了小程序开发过程中的常见问题及解决方案。针对小程序白屏问题,提供了检查设备、版本、清理缓存及升级客户端等排查步骤。在生命周期管理方面,解答了onError、onShareAppMessage的使用,详述了onLaunch与onShow在不同扫码及跳转场景下的参数获取逻辑。文档还涉及了Cookie处理机制、域名白名单配置对请求的影响,以及禁止首屏授权等规范。此外,涵盖了JS引入、SJS语法应用、数据刷新异常排查等开发技巧,旨在协助开发者快速解决技术难题。 - [Sitemap 配置](https://opendocs.alipay.com/mini/038x5r.md): 该文档主要介绍了小程序服务搜索功能的配置方法。开发者可通过根目录下的 `sitemap.json` 文件控制小程序页面是否允许被支付宝算法识别与索引,进而决定服务是否在搜索结果中展示。文档详细说明了配置原则,包括冲突处理、参数匹配及通配符用法,并列举了多种配置示例。同时,文档定义了 `rules`、`action`、`page` 等关键属性。此外,还介绍了 IDE 调试功能,说明了版本限制、索引提示开关设置及文件大小限制,帮助开发者验证索引配置的有效性。 #### AXML - [AXML 介绍](https://opendocs.alipay.com/mini/038x5s.md): 文档主要介绍了小程序框架设计的标签语言AXML。AXML结合基础组件和事件系统,用于构建小程序的页面结构,其语法主要包含数据绑定、条件渲染、列表渲染、模板和引用五个部分。文档通过代码实例详细展示了前四种核心语法的用法:数据绑定利用双大括号语法实现页面动态渲染;列表渲染通过`a:for`指令遍历数组;条件渲染使用`a:if`、`a:elif`和`a:else`指令控制组件显示逻辑;模板功能则支持定义可复用的代码片段,并通过数据传递实现页面结构的高效构建。 - [数据绑定](https://opendocs.alipay.com/mini/038x5t.md): 本文档主要阐述了 AXML 中的数据绑定机制,其核心是通过 Mustache 语法(双大括号 `{{}}`)将动态数据与 Page 中的 data 进行绑定。文档详细介绍了简单绑定的应用场景,包括组件属性、控制属性及布尔关键字的绑定,并特别强调了布尔值需使用双引号封装以避免类型转换错误。此外,文档说明了支持在 `{{}}` 内进行的三元、算术、逻辑、字符串及数据路径等多种运算,以及数组与对象的组合方式,涵盖解构运算符的使用和变量覆盖规则。最后,文档针对页面跳转时的数据清除问题提供了解决方案。 - [条件渲染](https://opendocs.alipay.com/mini/038q8q.md): 本文档主要介绍了小程序框架中条件渲染指令 `a:if` 的使用方法及最佳实践。首先阐述了 `a:if` 的基本语法,支持配合 `a:elif` 和 `a:else` 实现多分支判断。其次,说明了使用 `` 标签包装多个组件以进行批量条件控制的技巧,指出 `` 仅作为包装元素不参与渲染。最后,详细对比了 `a:if` 与 `hidden` 的区别:`a:if` 具有惰性渲染特性,适合条件不常改变的场景;`hidden` 始终渲染组件,适合频繁切换的场景。开发者应根据具体的性能消耗场景选择合适的渲染方式。 - [列表渲染](https://opendocs.alipay.com/mini/038rn8.md): 本文档详细介绍了小程序列表渲染指令的使用方法。核心内容包括:首先,通过 `a:for` 属性绑定数组实现组件重复渲染,默认提供 `index` 和 `item` 变量,支持自定义变量名及嵌套循环。其次,`block a:for` 用于渲染多节点结构块。再者,为保持动态列表项的状态和渲染效率,需使用 `a:key` 指定唯一标识,值可为唯一属性字符串或 `*this`,若列表静态可忽略。最后,`key` 是更通用的写法,支持填充表达式,但不能设置在 `block` 上。 - [模板](https://opendocs.alipay.com/mini/038q8r.md): AXML提供模板功能,用于定义可复用的代码片段。建议使用模板是因为其具备独立作用域,仅使用传入的data数据,且数据不变时UI不会重渲染,性能更优。定义模板需使用name属性声明名称。使用时通过is属性指定模板,利用data属性传入数据,is属性支持Mustache语法实现动态渲染。模板作用域仅限传入数据,但支持通过事件绑定处理页面逻辑。 - [引用](https://opendocs.alipay.com/mini/038rna.md): AXML 提供了 `import` 和 `include` 两种文件引用方式。`import` 用于加载已定义的 template 模板,具备作用域概念,仅导入目标文件直接定义的模板,不支持间接引用的传递性。`include` 则将目标文件除模板外的代码整体引入,相当于将代码拷贝到当前位置。此外,AXML 引入路径支持相对路径、绝对路径以及从 node_modules 载入第三方模块。这两种方式配合灵活的路径规则,实现了代码的高效复用与模块化组织。 - [引入 SJS](https://opendocs.alipay.com/mini/04tp83.md): 本文档介绍了 `import-sjs` 标签的使用方法,该标签用于在 AXML 文件中引入 SJS 脚本导出的符号。文档详细说明了两种引入方式:针对 `export default` 的默认导出,`name` 属性须为合法标识符;针对 `export` 的具名导出,`name` 属性须为对象字面量,并支持符号重命名。此外,文档明确了命名冲突的处理规则:默认导出同名会在编译期覆盖原符号,而具名导出同名则会直接抛出编译异常,开发者需严格遵守相关规范。 #### SJS 语法参考 - [SJS 介绍](https://opendocs.alipay.com/mini/038x5u.md): SJS(Safe/Subset JavaScript)是小程序定义的一套脚本语言,作为JavaScript的子集,其导出的变量和函数可在AXML中使用。SJS文件扩展名必须为.sjs,采用模块化管理,支持使用export和import进行导出引用,也可引用npm包中的.sjs文件。SJS运行于渲染层,与逻辑层隔离,无法调用JS文件函数或小程序API。这种机制使其可用于响应基础组件事件,减少两层通信开销。文档通过代码示例展示了SJS的定义、导出、在AXML中的引用及数据渲染过程。 - [变量](https://opendocs.alipay.com/mini/038q8s.md): 该文档详细阐述了 SJS 语言中变量的定义规范与语法规则。首先,明确 SJS 变量均为值的引用。在语法方面,支持 var、let 和 const 声明,其表现与 JavaScript 一致,var 存在变量提升,未赋值变量默认为 undefined。其次,文档规定了变量命名规则:首字符必须是字母或下划线,后续字符可包含字母、下划线和数字。最后,文档列出了与 JavaScript 语法一致的保留标识符列表,如 arguments、break、function 等,这些标识符严禁作为变量名使用。 - [注释](https://opendocs.alipay.com/mini/038x5v.md): 本文档介绍了 SJS 代码的注释方法,明确指出其语法与 JavaScript 保持一致。文档详细说明了两种注释形式:一是使用双斜杠“//”进行单行注释;二是使用“/* */”进行多行注释。文中通过具体的代码示例,清晰展示了这两种注释方法在 SJS 文件中的实际书写格式和应用场景。 - [运算符](https://opendocs.alipay.com/mini/038rnh.md): 本文档详细介绍了SJS中支持的各类运算符及其用法。内容涵盖算术运算符(含字符串拼接)、比较运算符、二元逻辑运算符、位运算符、赋值运算符、一元运算符、三元运算符及逗号运算符。文档通过丰富的代码示例展示了各运算符的具体操作和返回结果,包括自增自减、typeof类型检测、delete属性删除等。最后,文档指明SJS的运算符优先级规则与JavaScript保持一致。 - [语句](https://opendocs.alipay.com/mini/038x60.md): 文档详细介绍了 .sjs 文件中四种流程控制语句的语法与用法。`if` 语句支持单分支、双分支(else)及多分支(else if)条件判断,根据表达式真值执行相应代码块。`switch` 语句用于多路选择,规定 `case` 后仅能使用变量、数字或字符串,`default` 分支可选。`for` 语句用于循环操作,支持 `break` 和 `continue` 控制循环流程。`while` 语句包含 `while` 和 `do...while` 两种形式,当表达式为真时执行循环,同样支持流程控制关键词。文档通过具体代码示例展示了各语句的执行逻辑与输出结果。 - [数据类型](https://opendocs.alipay.com/mini/038x61.md): 该文档详细阐述了SJS支持的数据类型及其用法。SJS支持string、boolean、number、object、function、array、date和regexp八种数据类型。用户可通过`constructor`和`typeof`两种方式判断数据类型,需注意`typeof`对数组和日期等均返回object的特性。文档详细介绍了各类型的语法、属性和方法,指出String、Object、Array、Function等类型支持ES6语法(如模板字符串、解构赋值、箭头函数)。特别指出Date和RegExp对象需分别使用`getDate()`和`getRegExp()`函数进行实例化,各类型方法主要遵循ES5标准。 - [基础类库](https://opendocs.alipay.com/mini/038q91.md): 本文档详细说明了SJS脚本语言支持的标准库接口及其限制。首先指出SJS不支持JavaScript大部分全局属性和方法的特性。随后分模块列举了Global支持的全局属性(如NaN、undefined)和方法(如URI编解码、数值转换);console.log用于调试输出;Number对象支持的边界值属性;JSON对象的序列化与反序列化方法及其在不同数据类型下的转换示例;以及Math对象提供的数学常量与计算函数。所有接口定义均参考ES5标准。 - [esnext](https://opendocs.alipay.com/mini/038x63.md): 该文档说明了SJS支持的部分ES6语法特性。主要涵盖五个方面:一是let与const声明,具备块级作用域特征;二是箭头函数,支持简洁语法并能保持上下文this指向;三是增强的对象字面量,允许属性和方法简写,但明确不支持super关键字;四是模板字符串,支持变量嵌入;五是解构赋值,支持数组、对象及函数参数解构,并允许设置默认值。这些特性有效提升了SJS代码的编写效率与可读性。 - [SJS 响应事件](https://opendocs.alipay.com/mini/038x65.md): 本文档介绍了SJS函数响应基础组件事件的能力,旨在解决复杂交互中使用setData导致的通信延迟问题。SJS允许在web-view侧直接响应事件,无需经过worker,从而实现高性能的富交互体验。该功能支持类CSS选择器语法,主要包含事件回调和属性监听两种应用方式。事件回调提供了Descriptor对象,支持动态修改样式、类名、查询布局及调用worker方法;属性监听则可在组件属性变化时触发相应逻辑。使用SJS需注意基础库版本限制,且不支持原生组件和自定义组件。 #### 事件系统 - [事件介绍](https://opendocs.alipay.com/mini/038q92.md): 本文档详细介绍了小程序事件系统的定义、使用方法及传播机制。事件作为视图层到逻辑层的通讯桥梁,负责将用户行为反馈至逻辑层处理。文档阐述了事件绑定方式及事件对象的结构,重点区分了冒泡事件(on前缀)和非冒泡事件(catch前缀)的差异。此外,文档详细说明了事件的捕获阶段机制,该阶段先于冒泡且顺序相反,支持通过capture-on和capture-catch进行监听或中断。最后,文档列举了支持冒泡的组件列表,并针对事件覆盖问题提供了利用catch阻止冒泡的解决方案。 - [事件对象](https://opendocs.alipay.com/mini/038q94.md): 文档介绍了组件触发事件时传递给逻辑层的事件对象结构,主要包含BaseEvent、CustomEvent和TouchEvent三类。BaseEvent作为基础对象,包含type、timeStamp、target和mark属性,其中dataset用于传递组件数据需经连字符转驼峰处理,mark则用于识别节点并支持冒泡路径数据合并。CustomEvent继承BaseEvent,通过detail属性携带额外信息如用户输入。TouchEvent也继承BaseEvent,包含touches和changedTouches数组分别记录当前触摸点和变化的触摸点,并定义了Touch及CanvasTouch对象的坐标属性。 #### 自定义组件 - [自定义组件介绍](https://opendocs.alipay.com/mini/038x6e.md): 自定义组件功能支持将复用模块抽象化,实现页面间及跨小程序(通过NPM)的复用。基础库1.7.0起支持该功能,1.14.0版本新增component2特性,包括onInit、deriveDataFromProps生命周期及ref获取实例功能,需在IDE中手动启用。创建组件包含新建文件夹、JSON声明、JS注册及页面引用四个步骤。组件由axml、js、json、acss组成,需在json中设置component字段,通过Component构造器定义data、props、methods等,最后在页面json中配置usingComponents即可使用。 ##### 创建自定义组件 - [组件配置](https://opendocs.alipay.com/mini/038q98.md): 该文档主要介绍了自定义组件的声明方式,需在`[componentName].json`文件中进行配置。核心要点包括:必须将`component`字段设为`true`以声明该文件为自定义组件;若组件存在依赖,需在`usingComponents`对象中声明引用路径。文档详细说明了参数类型与必填项,并规定了路径书写规范:项目绝对路径以`/`开头,相对路径以`./`或`../`开头。通过规范的JSON配置,实现了组件身份定义与依赖管理的标准化。 - [组件模板和样式](https://opendocs.alipay.com/mini/038x6h.md): 本文档详细介绍了小程序自定义组件的开发规范。组件包含AXML模板与ACSS样式,用户自定义事件需置于methods中。文档重点阐述了插槽机制:默认插槽用于单一内容替换,具名插槽支持多位置渲染,作用域插槽则允许外部内容访问组件内部数据。在样式方面,组件默认样式共享,但可通过配置styleIsolation实现样式隔离。文档还介绍了非虚拟化组件节点的配置方法,允许开发者直接对组件节点设置样式,并支持`:host`选择器。此外,支持通过externalClasses引入外部样式类。最后,文档通过完整示例展示了组件生命周期及数据流转过程。 - [组件对象](https://opendocs.alipay.com/mini/038x6i.md): 文档详细介绍了小程序 Component 构造器的使用方法,涵盖了组件定义、参数配置、实例属性及方法。核心内容包括:通过 data 定义内部状态,props 接收外部属性,methods 定义方法与事件响应,mixins 实现代码复用。文档列举了 onInit、didMount 等生命周期函数及其版本要求,并强调了 props 的只读性与事件命名规范。此外,说明了组件实例属性(如 $page、$id)及方法(如 setData、$selectComponent、createIntersectionObserver),提供了数据更新、节点查询及组件间通信的完整指南与代码示例。 - [生命周期](https://opendocs.alipay.com/mini/038q9a.md): 文档定义了组件生命周期,分为数据维度和节点树维度。数据维度包含onInit、deriveDataFromProps(需开启component2)、didMount、didUpdate、didUnmount和onError方法,用于处理组件创建、更新、卸载及错误捕获。节点树维度自基础库2.8.5起支持,通过lifetimes字段定义created、attached、ready、moved和detached方法,用于响应节点树变化。文档详细说明了各方法的触发时机、参数及版本要求,并强调节点树生命周期需在options中显式开启。 - [mixins](https://opendocs.alipay.com/mini/038x6k.md): 小程序提供了 mixins 机制用于解决多个自定义组件间公共逻辑的复用问题。开发者可在组件定义中引入 mixin 对象。自基础库 2.8.2 起,支持通过 `Mixin()` 注册生成 mixin 实例,该方式支持嵌套引用、组件扩展机制及 `hasMixin` 校验。文档详细规定了同名字段的冲突处理规则:对于属性、方法和数据,组件定义优先级最高,其余按数组顺序和嵌套层级遵循“后者覆盖前者”或“引用者覆盖被引用者”的原则;而生命周期函数和 observers 不覆盖,会按特定优先级顺序全部执行,且同一实例被多次引用时不会重复执行。 - [ref 获取组件实例](https://opendocs.alipay.com/mini/038q9b.md): 文档介绍了基础框架 1.18.0 起支持的自定义组件对外实例定义与获取机制。首先,组件可通过配置 `ref` 方法返回对外实例,适用于宿主与插件间的交互;若未定义,同域引用返回组件 `this`,跨域返回 `null`。其次,开启 component2 后,支持在 AXML 中定义 ref 回调,组件创建时自动触发并传入实例。最后,文档详细说明了 `selectOwnerComponent` 和 `selectComposedParentComponent` 方法,分别用于获取创建者组件和事件路径父组件,并通过嵌套组件示例演示了插槽场景下两者的区别与正确用法。 - [链式注册 API](https://opendocs.alipay.com/mini/0d79iq.md): 该文档介绍了一种名为“链式注册 API”的新型自定义组件定义形式。该 API 允许开发者通过链式调用(如 `.prop()`、`.data()`、`.methods()` 等)配置组件属性与逻辑,并以 `.register()` 结尾完成注册,适用于基础库 2.9.32 及以上版本。文档详细列出了包括属性定义、数据初始化、方法注册、生命周期回调及数据监听等在内的十种支持方法。此外,文档阐述了重复链式调用的合并策略,指出除 `options` 外其他配置均可重复调用并合并。同时说明了 Mixins 的链式声明支持及其优先级逻辑:组件优先级最高,函数类配置采用高优先级后执行策略,而覆盖类配置则由高优先级生效。 - [使用自定义组件](https://opendocs.alipay.com/mini/038x6m.md): 该文档主要介绍了小程序中自定义组件的使用方法。首先指出自定义组件的事件需组件明确支持。使用步骤包括:在页面JSON文件中声明组件路径,以及在页面AXML文件中像基础组件一样调用。开发者可通过属性向组件传参,组件内部通过this.props获取。文档强调组件仅能在页面或组件自身的AXML中直接使用,不支持通过import或include引用。引用路径支持项目绝对路径、相对路径及npm包路径三种形式。 - [发布自定义组件](https://opendocs.alipay.com/mini/038rnv.md): 本文档介绍了支付宝小程序自定义组件发布到 npm 的流程。首先,文档规定了推荐的文件结构,包含组件源码目录及 Demo 文件。其次,详细展示了 package.json 配置及构建脚本逻辑,通过 rc-tools 和自定义脚本实现代码编译、复制与清理。最后,阐述了发布步骤:执行构建命令生成生产目录;注册并验证 npm 账号以规避 E403 错误;通过命令行登录并发布组件。开发者遵循此流程可高效实现组件的复用与分享。 - [占位组件](https://opendocs.alipay.com/mini/03dyb0.md): 该文档介绍了支付宝小程序中“占位组件”的使用方法。在使用懒加载或分包异步化特性时,自定义组件可能未即时加载,占位组件用于临时替代不可用组件以防渲染阻塞,待原组件加载完毕后自动替换。文档明确了使用须知:需基础库2.8.1及以上版本;占位组件必须是自定义组件且初始可用;禁止嵌套指定占位组件。开发者通过JSON文件中的`componentPlaceholder`字段进行配置,文档提供了具体配置示例及渲染流程说明。 - [自定义组件常见问题](https://opendocs.alipay.com/mini/038rnw.md): 本文档主要解答小程序开发中关于自定义组件与模板的常见问题。针对“worker render components is not sync”报错,建议升级基础库或关闭component2设置。组件命名需避免重名以防页面混乱。在组件通信方面,父子组件相互调用可将实例挂载至页面实例(this.$page)实现;子组件无法监听父组件参数变化,建议使用props传值。此外,模板中不支持使用自定义组件,若遇布尔值参数获取失败,需升级IDE版本。目前暂不支持监听单数据变化的方法。 - [数据变化观测器](https://opendocs.alipay.com/mini/04y1n6.md): 该文档介绍了支付宝小程序中用于观测自定义组件和页面数据变化的“数据变化观测器”功能,需基础库2.8.1及以上版本。为避免冲突,开发者需在Component或Page构造器的options中显式设置`observers: true`启用该功能。观测器支持监听单字段、多字段、子数据路径及通配符`**`,可在`setData`时触发计算逻辑。注意事项包括:观测器由`setData`动作触发,非仅值变化;需防范回调中修改被观测字段导致的死循环;通配符`**`影响性能;重名字段仅响应`setData`。文档还对比了开启`component2`对观测器触发时机和递归行为的影响,建议开启以优化性能。 - [视口交叉观察器](https://opendocs.alipay.com/mini/0hgmbn.md): `component.createViewportIntersectionObserver` 是支付宝小程序基础库 2.9.91 及以上版本提供的 API,旨在创建视口交叉观察器以优化曝光检测场景的性能与体验。该接口适用于企业与个人支付宝小程序,接受回调函数和选项对象作为参数,其中选项仅支持 `initialRatio` 和 `thresholds`。相比旧版 API,它在处理多个节点时采用批量结算方式,功能上默认等同于开启了 `selectAll` 和 `dataset`。返回的 `ViewportIntersectionObserver` 对象提供 `observe` 方法(仅支持 SJS 选择器多选)启动监听,以及 `disconnect` 方法停止监听。 - [Mixin](https://opendocs.alipay.com/mini/05bchn.md): 本文档介绍了注册 `mixin` 的方法,该方法接受一个 Object 类型参数。基础库 2.8.2 开始支持,2.8.5 起支持页面引用 Mixin 实例。文档重点说明了 Page 引用 mixin 与 Component 的区别:Page 引用时,`props`、部分生命周期函数(如 `onInit`、`didMount` 等)、`lifetimes` 和 `relations` 定义段会被忽略;`rootEvents` 触发时机同 `page.events`;`methods` 内方法会被解构至 Page 实例但优先级较低。文档详细列举了 `data`、`observers`、`mixins`、`methods` 等参数的定义、类型、功能描述及版本要求,并提供了示例代码。 - [抽象节点](https://opendocs.alipay.com/mini/06mket.md): 该文档介绍了小程序自定义组件中的“抽象节点”特性,该特性自基础库2.8.6及IDE 3.4.3起支持。抽象节点允许组件调用者决定模板中特定节点的具体实现,而非由组件本身确定。开发者需在JSON文件的`componentGenerics`字段中声明抽象节点并指定默认组件。使用时,调用者通过`generic:xxx="yyy"`语法指定具体组件,但该属性值仅支持静态值,不支持数据绑定。此特性有效提升了组件的通用性与复用灵活性。 - [自定义组件扩展](https://opendocs.alipay.com/mini/05bdpv.md): 本文档介绍了用于定制自定义组件功能的自定义组件扩展机制,该机制要求基础库版本在2.8.2及以上。扩展机制的核心是通过 `Mixin()` 构造器提供的 `definitionFilter` 定义段,赋予开发者在组件注册阶段修改其定义段的能力。相比传统的函数包裹方式,该机制代码结构更清晰。`definitionFilter` 函数接收使用者的定义对象及依赖链上的过滤器列表作为参数。其执行逻辑遵循“当A使用B时,注册A触发B的过滤器”的原则,且支持嵌套调用,允许开发者灵活控制对组件定义段的修改与扩展。 - [组件间关系](https://opendocs.alipay.com/mini/069w9y.md): 文档介绍了自定义组件的 `relations` 定义段,旨在解决具有相互关系的组件间通信与感知的复杂性。该功能需基础库 2.8.5 及以上版本支持,并需在组件构造器中显式开启。开发者通过在组件中定义目标路径和关系类型(parent/child 或 ancestor/descendant)建立双向关联。文档详细说明了关联建立的生命周期回调(linked、linkChanged、unlinked)、节点获取方法以及通过 Mixin 建立关联的方式,并指出了关系配对的约束条件。 - [获取更新性能统计信息](https://opendocs.alipay.com/mini/069xfk.md): 本文档介绍了用于统计 setData 界面更新开销的 setUpdatePerformanceListener 接口。该接口需基础库 2.8.5 及以上支持,可在组件或页面生命周期中调用。通过配置 options 参数及回调函数 listener,开发者可获取更新过程的 ID、时间戳及变更数据字段等信息。更新过程分为基本更新、子更新和被合并更新三类。需注意该接口仅统计当前组件或页面,若需全局监控需在各组件中分别调用。传入 null 可禁用统计。 #### 基础能力 - [文件系统](https://opendocs.alipay.com/mini/03dt4s.md): 支付宝小程序文件系统是一个以小程序和用户维度隔离的存储管理系统。文件主要分为代码包文件和本地文件两大类。代码包文件随小程序发布,只读不可修改,适用于首次加载资源。本地文件存储于独立沙盒,分为本地临时文件、本地缓存文件和本地用户文件。临时文件生命周期短,随小程序关闭可能被清理;缓存文件和用户文件为持久化存储,总计限额200MB,单个文件限30MB。在权限上,代码包文件、临时文件和缓存文件仅可读,唯独本地用户文件支持读写操作。文档还规范了各类文件的生成方式、路径协议、清理策略及对应API的支持情况,指导开发者合理管理文件资源。 - [小程序全局 / 页面参数设置以及解析细节](https://opendocs.alipay.com/mini/03durs.md): 本文档阐述了小程序全局与页面参数的设置与解析规范。设置参数时需使用NPM包`query-string`的`stringify`方法将对象转为字符串,默认会对键值进行`encodeURIComponent`编码。解析参数时,基础库默认调用`parse`方法并进行`decodeURIComponent`解码。从基础库2.7.19起,`app.json`新增`behavior.decodeQuery`配置项,若设置为`disable`,可关闭自动解码功能,保留原始编码字符。该配置影响所有通过字符串传递参数的场景,包括Scheme链接、IDE编译设置、页面跳转API及navigator组件等,建议设置最低基础库版本以保证兼容性。 - [自定义 tabBar](https://opendocs.alipay.com/mini/03jry7.md): 本文档介绍了支付宝小程序自定义 tabBar 的开发指南,旨在帮助开发者通过自定义组件实现底部导航栏的个性化定制。核心流程包括在 app.json 中开启 customize 配置、创建自定义组件目录以及手动管理页面切换时的 tabBar 状态。针对普通模式存在的页面切换闪烁和下拉刷新跟随问题,文档引入了 Native 渲染模式,该模式通过设置 overlay 字段启用,使 tabBar 独立于页面渲染。开发者需注意 Native 模式需真机调试,且存在弹层遮挡无法通过 z-index 解决的限制。此外,文档还说明了版本兼容性要求及运行时环境检测方法。 ##### 分包 - [分包加载](https://opendocs.alipay.com/mini/038rny.md): 支付宝小程序自客户端10.1.60版本起支持分包加载功能,旨在满足复杂业务需求并提升首页启动速度。开发者可将小程序划分为包含核心页面的主包和按需加载的分包。用户进入分包页面时,客户端才下载对应代码,建议大体积或多团队协作项目使用此功能。 配置需在`app.json`中声明`subPackages`字段。打包原则规定启动页必须在主包,分包间不可相互引用资源,但可引用主包资源。大小限制为单包不超过4MB,整包不超过20MB。此外,系统支持分包预下载以优化跳转体验,并通过服务端构建自动兼容低版本客户端。 - [分包异步化](https://opendocs.alipay.com/mini/057ht3.md): 该文档介绍了小程序“分包异步化”特性,旨在解决分包间共享组件或JS模块导致主包体积增大、影响启动性能的问题。该特性允许跨分包内容异步加载,减少主包大小。文档明确了IDE及基础库版本要求,并提供了具体使用方法:跨分包自定义组件引用需配置“占位组件”先行渲染,待分包下载后替换;跨分包JS代码引用需使用回调或Promise风格的异步接口。此外,文档指出该特性兼容历史写法,支持细颗粒度的渐进式接入,接入成本低。 #### 基础库 - [基础库介绍](https://opendocs.alipay.com/mini/038ro0.md): 小程序基础库是加载小程序框架的容器,提供标准组件和API接口。其运行依赖支付宝客户端,新能力需特定客户端版本支持,低版本客户端无法兼容高版本基础库。基础库随客户端更新进行灰度发布,通常1-2周覆盖98%用户,且受客户端版本上限制约。当前存在v1.x和v2.x版本,v2.x为主流。开发者可在开放平台设置小程序最低基础库版本,低于此版本的用户需更新客户端。基础库无法通过API主动更新,但IDE支持切换版本调试。 - [基础库 2.x 升级](https://opendocs.alipay.com/mini/038x6w.md): 该文档介绍了支付宝小程序基础库从1.x升级至2.x的指南。基础库2.x在性能、渲染、内存占用及开发能力上均有显著提升,且完全兼容旧版。升级步骤包括IDE配置、调试验证及上传发布,支持回滚操作。文档详细列举了升级后可能遇到的编译与运行时问题,如ES6语法配置、SJS变量定义、条件渲染语法、AXML箭头函数限制、ACSS语法规范及Slot位置限制等,并提供了相应的解决方案与技术支持建议。 - [小程序的 JavaScript 引擎](https://opendocs.alipay.com/mini/038x68.md): 本文阐述了支付宝小程序的 JavaScript 运行环境。小程序在 iOS 和 Android 分别使用 JavaScriptCore 和 V8 引擎,导致 ES 标准支持存在差异。文档介绍了抹平这些差异的方法:语法层面,支持自动转换 ES6+ 并可配置支持 ES2023;内置对象层面,推荐开启基础库内置 Polyfill 或自行引入,并注意全局对象配置与包体积影响。此外,还指出了 `new Date` 解析的跨平台差异、动态脚本执行的安全限制(如禁用 `eval`),以及 ES Module 中保留的导入符号规范,为开发者提供了完整的兼容性指南。 - [小程序场景值](https://opendocs.alipay.com/mini/038x6c.md): 本文档主要介绍了支付宝小程序场景值的概念、获取方式及相关注意事项。场景值用于标识用户进入小程序的路径,需基础库1.10.0及以上版本支持。开发者可通过两种方式获取:一是在`app.js`的`onLaunch`和`onShow`方法中读取`options.scene`;二是调用`my.getLaunchOptionsSync`或`my.getEnterOptionsSync`接口。文档特别指出,受Android系统限制,用户按Home键退出后从桌面重新进入时,系统将保留上一次的场景值。此外,文档还提供了代码示例及关于跳转链接拼接的常见问题解答。 - [场景值列表](https://opendocs.alipay.com/mini/08otyv.md): 该文档主要列举了支付宝小程序的各项场景值ID及其对应说明,旨在定义小程序的不同访问入口与来源渠道。文档涵盖了包括首页十二宫格、应用中心、扫一扫、搜索结果页、聊天分享卡片、生活号、市民中心、出行频道、第三方APP跳转等在内的三十余个具体场景。这些场景值详细区分了从客户端核心入口、垂直业务频道、社交分享、线下扫码到付费推广流量等多种访问路径,为小程序的开发分析、来源追踪及精细化运营提供了标准化的参数依据。 - [兼容](https://opendocs.alipay.com/mini/038x6t.md): 本文档主要介绍了小程序基础库升级后的兼容性处理策略。核心内容包括三个方面:一是使用 `my.canIUse` 接口检测新增 API、参数、返回值及组件属性,实现功能降级或条件渲染;二是通过获取基础库与客户端版本号字符串,利用自定义函数进行版本对比判断;三是在开放平台控制台设置最低基础库版本,强制低版本用户升级客户端。文档提供了具体的代码示例与操作指引,帮助开发者解决低版本兼容问题。 ### 组件 - [组件概览](https://opendocs.alipay.com/mini/0396yv.md): 本文档是对小程序组件的全面概览。组件是对数据和方法的封装,开发者通过组合组件进行业务开发。文档首先介绍了组件的基础使用方法,包括利用Mustache语法进行数据绑定,以及所有组件共有的属性(如id、class、style、自定义属性data-*和事件绑定)。同时明确了属性的类型要求,涵盖布尔值、数字、字符串、数组、对象及事件处理函数等。核心部分详细列举了框架提供的组件列表,分为视图容器、基础内容、表单组件、导航、媒体组件、画布、地图、开放组件、无障碍访问及页面属性配置节点等类别。每类组件下包含具体组件名称及功能说明,如view视图容器、form表单、video视频及web-view网页承载组件等,构成了完整的小程序开发基础库。 #### 视图容器 - [view 视图容器](https://opendocs.alipay.com/mini/038rnb.md): 本文档介绍了小程序基础组件 view 视图容器,它类似于 HTML 的 div 元素,用于容纳其他元素。文档说明了使用限制:可通过 overflow 属性或 scroll-view 实现滚动,但不支持直接覆盖 map 组件,需使用 cover-view。属性说明部分详细列举了包括 disable-scroll(阻止滚动)、hover-class(触摸状态)、hidden(隐藏)、animation(动画)等样式与交互属性,以及 onTap、onAppear等触摸、动画和可见性事件,并注明了部分属性的默认值及基础库版本要求。常见问题解答了如何通过循环标识改变展示顺序,以及利用 my.pageScrollTo 解决跨屏幕滚动定位差异的问题。 - [swiper 滑块视图容器](https://opendocs.alipay.com/mini/0397se.md): 本文档介绍了滑块视图容器 swiper 组件,其内部仅允许放置 swiper-item。文档明确了使用限制,如不可置于 map 组件上、建议使用 view 替代 cover-view 嵌套等。核心属性涵盖了指示点配置、自动播放、循环滑动、纵向控制、边距设定及交互阈值调整等。组件支持 onChange、onTransition 等事件监听,并提供多滑块显示、缓动动画及动态高度调整等高级功能,部分功能依赖于特定基础库版本。 - [scroll-view 可滚动视图区域](https://opendocs.alipay.com/mini/038q8t.md): 本文档详细介绍了可滚动视图区域组件 scroll-view 的功能、属性及使用规范。该组件支持横向与纵向滚动,提供滚动位置设置、动画效果及边缘事件监听等功能。文档指出了多项使用限制,如竖向滚动需设固定高度、滚动时阻止页面回弹、不支持横纵向同时滚动及自定义下拉刷新等。属性说明涵盖了滚动方向、阈值、动画时长、交互反馈及触摸事件等详细配置。此外,FAQ 部分针对嵌套滑动冲突、蒙层穿透及事件多次触发等常见问题提供了具体的解决方案与排查思路。 - [cover-view 文本视图](https://opendocs.alipay.com/mini/038q8u.md): 该文档主要介绍支付宝小程序组件 `cover-view`,这是一个用于覆盖在 map、canvas 等原生组件之上的文本视图。使用该组件需基础库版本 1.10.0 及以上,且不支持 Native 渲染引擎,实际效果以真机为准。文档详细说明了组件属性,包括点击事件回调 `onTap` 和实现手势穿透效果的 `penetrateGuesture`(仅 iOS 有效)。常见问题解答中指出,组件不支持更改背景色,建议修改字体颜色,但支持通过 acss 设置圆角和阴影样式。开发者需注意版本兼容性及平台差异。 - [cover-image 图片视图](https://opendocs.alipay.com/mini/038rnd.md): 该文档介绍了小程序组件 `cover-image`,这是一种覆盖在原生组件之上的图片视图,其覆盖能力与 `cover-view` 一致。组件使用受基础库版本限制,要求1.10.0 及以上,且暂不支持 Native 渲染引擎,建议通过 `my.canIUse` 进行兼容性判断。文档详细说明了两个核心属性:`src` 用于设置图片地址,支持格式同 `image` 组件;`onTap` 用于定义点击事件回调。这两个属性均要求基础库版本在 1.9.0 及以上。开发者需注意版本兼容处理以确保功能正常。 - [match-media 媒体查询](https://opendocs.alipay.com/mini/03a60m.md): 文档介绍了小程序组件 `match-media`,旨在提供更友好的响应式布局方案。该组件允许开发者通过指定 media query 规则,根据屏幕尺寸和方向等条件匹配展示特定节点,实现针对不同屏幕的自适应布局。使用该组件需注意基础库版本需在 2.7.14 及以上,否则组件不显示,建议做兼容处理。此外,Native 渲染引擎暂不支持该组件,可通过 `my.canIUse('match-media')` 进行判断。组件属性包括 min-width、max-width、width、min-height、max-height、height(单位均为 px)以及 orientation(屏幕方向),支持精准控制内容在特定宽度、高度或横竖屏状态下展示。 - [movable-view 可移动视图容器](https://opendocs.alipay.com/mini/038q8w.md): 文档详细介绍了小程序组件 movable-view,它是一个可在页面中拖拽滑动的可移动视图容器。该组件必须在 movable-area 内使用且作为直接子节点。使用时需注意基础库版本要求(1.11.0及以上),暂不支持 Native 渲染。组件必须设置宽高,默认绝对定位,移动范围取决于与 movable-area 的尺寸对比。文档详细列出了方向控制、惯性、阻尼、摩擦、缩放及动画等属性,并说明了触摸事件与交互事件的触发机制及返回值,为开发者实现拖拽功能提供了完整的技术参数与规范。 - [movable-area 可移动视图区域](https://opendocs.alipay.com/mini/038x5w.md): 本文档介绍了支付宝小程序组件 movable-area,其功能为定义 movable-view 的可移动区域。文档明确指出了该组件的使用限制:要求基础库版本在 1.11.0 及以上,若版本较低需做兼容处理;目前暂不支持 Native 渲染引擎;开发者必须显式设置 width 和 height 属性,否则默认为 10px。在属性配置方面,文档详细说明了 scale-area 属性,该属性为布尔类型,默认值为 false。当设置为 true 时,可将内部支持缩放功能的 movable-view 的手势生效区域扩展至整个 movable-area,该属性要求基础库版本在 1.20.0 及以上。此外,文档还提供了扫码体验与在线示例入口。 - [page-container 页面容器](https://opendocs.alipay.com/mini/04ne6j.md): 该文档详细介绍了小程序“假页”容器组件的功能与用法。该组件旨在解决页面内复杂弹窗交互中返回操作直接退出页面的问题,通过拦截右滑手势、安卓物理返回键及 navigateBack 接口,实现关闭容器而不退出页面的效果。文档明确了基础库 2.8.0 以上支持、单页面仅限一个容器等使用限制,并强调需在 onAfterLeave 中同步状态。文中提供了完整的示例代码,涵盖了属性配置(如弹出位置、遮罩层、动画时长)及生命周期事件说明,并针对弹出层影响导航栏显示的常见问题给出了解决方案。 - [share-element 共享元素](https://opendocs.alipay.com/mini/04y2ya.md): 本文档介绍了共享元素组件,这是一种实现页面间元素穿越效果的动画形式。该组件必须与page-container结合使用,通过name属性映射两个页面的对应元素。当容器显示且transform属性为true时触发动画,退出时产生返回动画。使用限制包括需基础库2.8.1及以上版本,且暂不支持Native渲染引擎。文档提供了完整的示例代码,演示了联系人列表点击跳转详情页时的转场动画实现,涵盖了页面结构、数据逻辑及样式配置。组件支持配置动画时长、缓动函数等属性。 - [root-portal 容器](https://opendocs.alipay.com/mini/05snwp.md): 本文档介绍了小程序组件 `root-portal` 的功能与用法。该组件用于使子树脱离页面,效果类似 CSS 的 fixed position,适用于弹窗制作。文档指出需基础库 2.8.3 及以上版本支持,且暂不支持 Native 渲染引擎,建议通过 `my.canIUse` 接口进行判断。示例代码展示了基本结构。属性方面,`enable` 属性(Boolean 类型,默认为 true)控制是否脱离页面,为开发者提供了关键的接入指引和兼容性说明。 #### 基础内容 - [text 文本](https://opendocs.alipay.com/mini/038q8y.md): 该文档是小程序基础组件“文本”的使用指南。文档提供了组件的简介及扫码体验入口。核心内容详细说明了文本组件的四个属性配置:`selectable`属性控制文本是否可选,默认为false;`space`属性用于设置连续空格的显示方式,支持nbsp、ensp、emsp三种有效值,以适应不同操作系统的空格标准;`decode`属性决定是否解析HTML实体字符,默认为false;`number-of-lines`属性用于设置多行省略,要求值大于等于1,表现同CSS相关属性一致。 - [icon 图标](https://opendocs.alipay.com/mini/038rnf.md): 本文档主要介绍了小程序 Icon 组件的使用规范与属性配置。在使用限制方面,该组件不支持点击事件,页面跳转后的返回图标不可隐藏,且需注意插件样式命名冲突可能导致显示异常。在属性定义上,组件通过 type 属性指定图标类型(如 info、warn、success 等),其中 loading 类型要求基础库 1.7.2 及以上版本;size 属性控制图标大小,默认值为 23px;color 属性用于设置图标颜色,支持 CSS 色值。开发者需根据文档指引规避功能限制并正确配置相关属性。 - [progress 进度条](https://opendocs.alipay.com/mini/038x5y.md): 该文档介绍了用于显示页面数据请求进度的进度条组件。文档明确指出Native渲染引擎暂不支持该组件,建议使用`my.canIUse('progress')`进行兼容性判断。组件提供六个核心属性用于自定义配置:`percent`设置百分比数值(0-100);`show-info`控制是否在右侧显示百分比,默认不显示;`stroke-width`定义线条粗细,默认6px;`active-color`和`background-color`分别设置已选和未选进度条颜色,前者默认为绿色;`active`属性控制是否显示从0%开始的入场动画,默认关闭。此外,文档还提供了扫码体验及在线示例供开发者参考。 - [rich-text 富文本](https://opendocs.alipay.com/mini/038x5z.md): 文档详细介绍了小程序富文本组件的使用规范。该组件要求基础库版本1.11.0及以上,不支持Native渲染引擎及内部JS事件执行。核心属性nodes支持数组或HTML String(需基础库2.8.5+),space属性控制空格显示。nodes节点分为元素节点和文本节点,支持部分受信任的HTML标签(如div、img、a等)及class、style属性,但不支持id。文档特别指出a标签不支持直接跳转,并提供了利用marks属性配合onTap事件调用JSAPI实现跳转的解决方案。此外,还涵盖了触摸事件定义、字符实体支持说明及常见问题解答。 #### 表单组件 - [button 按钮](https://opendocs.alipay.com/mini/038q90.md): 本文档详细介绍了小程序按钮组件的使用指南。文档首先明确了按钮用于强调操作并引导用户点击的功能定位。核心内容涵盖了组件的详细属性说明,包括尺寸、类型、是否镂空、禁用及加载状态等基础样式属性,以及点击态样式控制和表单提交功能。重点阐述了open-type开放能力,如分享、授权、关注生活号及获取用户头像等,并列举了对应的scope有效值及各类回调事件。最后,文档针对服务端解密手机号、去除默认边框及实现按钮触发分享等常见问题提供了解决方案。 - [form 表单](https://opendocs.alipay.com/mini/038x62.md): 该文档详细介绍了小程序表单组件的功能定义、属性说明及常见问题。表单组件用于提交textarea、input、checkbox等用户输入数据。文档强调了使用限制,包括预览效果以真机为准、formId需真机调试返回、提交时组件需设置name属性作为key。核心属性涵盖report-submit(控制是否返回formId)、onSubmit(提交事件回调)和onReset(重置事件)。常见问题部分指出formId不支持自定义、有效期为7天且可发送三次消息、表单类模板消息必须使用表单生成的formId,且不支持静默触发提交。 - [label 标签](https://opendocs.alipay.com/mini/038x64.md): 该文档介绍了用于改进表单组件可用性的 label 组件。其核心功能是通过 for 属性绑定组件 ID 或直接包裹组件,实现点击标签时自动聚焦对应组件。文档规定了触发优先级:for 属性高于内部嵌套组件,若内部包含多个组件则默认触发第一个。在使用限制上,label 标签不支持 onTap等点击事件,且仅支持绑定 checkbox、radio、input 和 textarea 四种组件。此外,文档还提供了属性说明,明确 for 属性为 String 类型,用于指定目标组件 ID。 - [input 输入框](https://opendocs.alipay.com/mini/038rnj.md): 本文档详细介绍了小程序 Input 输入框组件的使用规范。该组件用于接收用户少量文字输入,支持多种类型(如文本、数字、密码)及键盘样式设置。文档重点说明了 Native 渲染引擎的兼容性限制、iOS 端自动聚焦配置以及 `position:fixed` 布局下的光标错位解决方案。核心内容涵盖了 value、type、placeholder、confirm-type 等关键属性的定义与兼容性,以及 onInput、onFocus 等事件处理。此外,文档还针对受控组件使用陷阱、iOS 光标漂移、键盘遮挡、点击事件监听缺失及输入抖动等常见问题提供了具体的解决方案与代码示例,指导开发者正确处理样式定制与交互逻辑。 - [textarea 多行输入框](https://opendocs.alipay.com/mini/038rnk.md): 本文档介绍了小程序组件 textarea(多行输入框)的功能、使用限制及属性说明。该组件支持多行内容输入与键盘隐藏。文档特别指出,设置 `enableNative="{{false}}"` 可解决 Android 系统下文字消失及键盘弹出导致的内容上移问题。在限制方面,Native 渲染引擎暂不支持,无法获取键盘高度,且 iOS 高版本不支持自动唤起键盘。属性方面,文档详细列举了包括 value、placeholder、maxlength、focus、auto-height 等基础属性,以及 onInput、onFocus、onBlur 等事件处理函数,并注明了部分属性的基础库版本要求。 - [radio 单选按钮](https://opendocs.alipay.com/mini/038rnm.md): 本文档介绍了小程序单选按钮组件的功能与属性。该组件存在两项使用限制:不支持修改选中后的宽高,且radio标签不支持与text标签嵌套,仅支持平行关系。组件包含四个主要属性:value用于定义选中事件携带的值;checked控制选中状态,默认为false;disabled设置禁用状态,默认为false;color属性用于自定义颜色,需基础库1.10.0及以上版本支持。 - [radio-group 单选项目组](https://opendocs.alipay.com/mini/038rnn.md): 该文档介绍了单项选择器组组件,其内部由多个 radio 组成。文档提供了扫码体验和在线示例以供参考。在属性说明方面,组件主要包括 onChange 和 name 两个属性。onChange 属性类型为 EventHandle,用于监听选中项的变化,触发时通过 event.detail 返回选中项的 value;name 属性类型为 String,用于定义组件名称,以便在表单提交时获取相应数据。该组件是小程序表单开发中实现单选功能的基础组件。 - [checkbox 多项选择器](https://opendocs.alipay.com/mini/038rnp.md): 本文档介绍了小程序多选组件的使用方法。该组件不支持修改选中背景色。核心属性包括:value(定义组件值),checked(设置初始选中状态,默认false),disabled(设置禁用状态,默认false),onChange(状态改变触发的事件),以及color(自定义颜色,需基础库1.10.0及以上)。文档还提供了在线示例供开发者参考。 - [checkbox-group 多项选择器组](https://opendocs.alipay.com/mini/038x66.md): 该文档详细介绍了“多项选择器组”组件,明确其内部由多个checkbox复选框构成,主要用于提供多选交互功能。文档提供了扫码体验和在线示例两种方式以供开发者参考。在属性配置上,组件支持`name`属性用于定义组件名称以便表单提交数据,以及`onChange`属性用于监听选中项的改变,其回调数据包含选中项的value值。该文档为组件的基本使用和核心接口定义提供了清晰说明。 - [switch 单选开关](https://opendocs.alipay.com/mini/038q93.md): 本文档介绍了小程序基础组件 Switch(单选开关)的定义与用法。该组件在 iOS 上显示为圆形,Android 上显示为方形,且不支持自定义大小样式。文档详细列出了组件的核心属性,包括用于表单提交的 name、控制选中状态的 checked、设置禁用的 disabled 以及自定义颜色的 color(需基础库 1.10.0 及以上)。此外,还介绍了状态改变回调事件 onChange 及受控组件属性 controlled(需基础库 1.8.0 及以上),为开发者提供了完整的接口说明及版本兼容性指引。 - [slider 滑动选择器](https://opendocs.alipay.com/mini/038q95.md): 该文档详细介绍了滑动选择器组件的定义、使用限制及属性配置。组件用于数值选择,暂不支持Native渲染引擎,建议通过API判断支持情况。核心功能涵盖数值范围设定、步长控制、禁用状态及样式自定义,包括轨道颜色、尺寸和滑块外观。组件提供`onChange`与`onChanging`事件响应用户交互,前者在拖动结束后触发,后者在拖动过程中实时触发(需基础库1.5.0及以上)。通过配置属性,开发者可灵活实现表单数据提交与界面展示需求。 - [picker-view 滚动选择器](https://opendocs.alipay.com/mini/038x69.md): 文档介绍了嵌入页面的滚动选择器组件 `picker-view` 及其子组件 `picker-view-column`。核心内容包括:组件仅支持放置 `picker-view-column`,通过索引获取选中值;不支持 Native 渲染引擎及透明背景;严禁内部使用 `hidden` 或 `display: none`,必须使用 `a:if` 控制显隐。属性方面,支持 `value` 数组设定选中项,自定义选中框及蒙层样式,以及 `immediate-change` 控制事件触发时机。事件接口包括 `onChange` 监听数值变化,以及 `onPickStart` 和 `onPickEnd` 监听滚动状态,部分功能依赖指定基础库版本。 - [picker 底部弹起的滚动选择器](https://opendocs.alipay.com/mini/038q96.md): 文档详细介绍了选择器组件,该组件提供可滚动列表供用户选择。在交互上,iOS系统从底部弹起,Android系统从中间弹出,但Native渲染引擎暂不支持。组件的核心属性包括:用于设置标题的title,定义选择数据的range(支持字符串或对象数组),指定对象显示字段的range-key,表示选中下标的value,以及用于监听值变化的onChange事件和设置禁用状态的disabled属性。此外,文档还提及了级联选择和日期选择的API调用方式。 #### 导航 - [navigator 页面链接](https://opendocs.alipay.com/mini/038q97.md): 该文档介绍了小程序中的 navigator 组件,主要用于实现页面链接跳转功能。组件使用存在限制,不支持 onTap 事件。文档详细说明了组件的五个核心属性:open-type 定义跳转方式(默认为 navigate);url 指定跳转链接;hover-class 设置点击态样式;hover-start-time 和 hover-stay-time 分别控制点击态的出现延迟与保留时间。此外,文档列举了 open-type 的六种有效值,分别对应 navigate、redirect、switchTab、navigateBack、reLaunch 等 API 功能以及退出小程序操作。 #### 媒体组件 - [image 图片](https://opendocs.alipay.com/mini/038q99.md): 本文档介绍了小程序 image 组件的使用规范。该组件支持 JPG、PNG 等多种图片格式,默认尺寸为 300px*225px。核心属性包括 src、mode、lazy-load 及事件监听等。mode 属性提供 5 种缩放模式和 9 种裁剪模式,其中 widthFix 可实现高度自适应。文档指出了 Android 平台在 flex 布局下使用 widthFix 的样式兼容性问题,并提供了解决方案。此外,针对 H5 白名单配置、二进制流图片需转 base64 显示以及真机图片被压缩等常见问题,文档也给出了具体的处理建议。 - [video 视频](https://opendocs.alipay.com/mini/038rnr.md): 本文档介绍了小程序 video 组件的功能与使用规范。重要通知指出,自2025年09月30日起,该组件将不再支持优酷视频,仅允许播放生活号+平台视频,需尽快完成迁移。组件要求基础库 1.10.0 及支付宝客户端 10.5.60 以上版本,支持网络地址及生活号+视频ID播放。文档列出了不支持CSS动画及带安全校验m3u8格式等限制,并提供了详细的属性说明,包括播放控制、界面布局、事件回调(如播放、暂停、错误处理)及浮窗设置。此外,文档还涵盖了支持的音视频编码格式(如H.264、AAC)、错误码对照表、缓存策略说明及ID命名规范等故障自查步骤,帮助开发者正确集成与调试视频播放功能。 - [lottie 动画](https://opendocs.alipay.com/mini/038x6o.md): 本文档介绍了Lottie动画库在支付宝小程序中的适配方法。Lottie可解析Adobe After Effects导出的JSON动画并在移动端本地渲染,要求支付宝版本10.1.35及以上。文档提供了完整的代码示例,并详细说明了组件属性,包括自动播放、路径设置、循环次数、占位图及低端设备降级策略等。针对资源文件处理,推荐使用Zip包或Base64内链方式。常见问题部分涵盖了兼容性修复、真机测试注意事项、特定版本Android字体闪退问题、iOS后台切换处理、组件ID唯一性要求及文件压缩规范,旨在帮助开发者顺利集成并解决潜在的适配问题。 - [camera 相机](https://opendocs.alipay.com/mini/03qegu.md): 本文档介绍了系统相机组件的使用方法与配置说明。组件需基础库1.11.0及以上支持,并须在`onReady`回调后创建上下文。核心属性包括应用模式(普通或扫码)、摄像头朝向、闪光灯状态、输出分辨率及帧数据尺寸。组件支持初始化完成、异常终止、权限错误及扫码成功等多种事件回调。文档提供了axml与js代码示例,并详细列出了各属性合法值及常见错误码(如权限缺失、磁盘错误等),供开发者参考。 #### 画布 - [canvas 画布](https://opendocs.alipay.com/mini/038rnx.md): 该文档详细介绍了小程序 Canvas 组件的功能、属性及使用方法。Canvas 是支持像素级控制的矩形绘图区域,基础库 2.7.0 起支持新版同层渲染 Canvas,使用时必须指定 type 属性(2d 或 webgl)及 onReady 事件。文档列举了 id、type、尺寸及触摸事件等关键属性,并提供了 Canvas2D 和 WebGL 的代码示例,强调需在 onReady 回调中获取实例。此外,文档还包含高 DPR 屏幕优化建议,以及针对 iOS 平台同层组件覆盖元素事件穿透的配置方法和使用限制。 #### 地图 - [map 地图](https://opendocs.alipay.com/mini/03a6zd.md): 该文档详细介绍了小程序 map 地图组件的使用规范与属性配置。map 组件为原生组件,层级最高,同页面多实例需唯一 ID,且不支持 CSS 动画和 scroll-view 嵌套,但支持同层渲染。核心功能涵盖地图展示与交互,包括中心经纬度、缩放、旋转等基础属性,以及 markers(标记点)、polyline(路线)、polygon(多边形)、circles(圆)等覆盖物配置。文档深入解析了各类覆盖物的具体参数,如标记点的自定义样式、气泡窗口及事件响应。此外,还介绍了通过 optimize 属性优化缩放体验、通过高德平台配置自定义地图样式的方法,并在 FAQ 中解答了导航跳转、海外支持等常见问题。 - [map 高级定制渲染](https://opendocs.alipay.com/mini/038x6s.md): 本文档介绍了支付宝小程序地图组件的高级定制渲染功能,该功能支持动态定制地图覆盖物的渲染布局。主要能力包括对 marker 的 icon 图标和 customCallout 气泡进行定制渲染,其中 customCallout 支持点击事件响应及气泡背景个性化设置。使用该功能需满足支付宝版本 10.1.92 及以上,且 IDE 模拟器不支持调试,需在真机进行。XML 布局文件须置于小程序根目录并在配置文件中声明打包,支持模板参数动态渲染。文档详细展示了相对、水平、垂直等布局示例,并提供了 box、text、image、lottie 四种组件的属性说明及通用样式配置指南。 #### 开放组件 ##### web-view - [web-view H5 页面承载](https://opendocs.alipay.com/mini/038x6y.md): 该文档详细介绍了支付宝小程序 web-view 组件的使用方法,该组件用于在小程序中嵌入 H5 页面。组件仅支持企业小程序,每个页面仅允许存在一个会自动铺满全屏的 web-view。使用时必须在开放平台配置 H5 域名白名单,且变更白名单需小程序发版生效。组件提供 src、onMessage等属性,H5 页面引入特定 JS 脚本后,可调用导航、图片、位置、支付等小程序 API。小程序与 H5 可通过 postMessage 机制实现双向通信,并支持获取当前页面 URL 进行分享。开发过程需注意 URL 编码,且调试应以真机效果为准。 - [web-view 常见问题](https://opendocs.alipay.com/mini/038q9f.md): 本文档详细阐述了支付宝小程序 web-view 组件加载 H5 页面的配置规范、常见问题及解决方案。核心要点包括:web-view 仅支持 HTTPS 域名,需配置白名单及校验文件,不支持 scheme 链接、IP 地址及重定向。文档说明了 H5 与小程序间的通信机制,利用 JS接口实现消息传递、授权登录、扫码及支付等功能,建议通过小程序原生组件处理用户授权。此外,还涵盖了页面设计限制(如标题不可隐藏、不支持叠加原生控件)、Cookie 与缓存处理原则、调试技巧及 iOS 视频播放等特定场景的处理方法,为开发者提供了全面的技术指导。 - [配置 H5 域名](https://opendocs.alipay.com/mini/038ro1.md): 本文档主要阐述了支付宝小程序中使用 web-view 组件时的 H5 域名白名单配置流程及注意事项。配置对象涵盖主文档、iframe 及跳转的 URL,静态资源无需配置。使用限制包括域名需已备案、外网访问状态码须为 200,且配置变更需小程序发版后方可生效。配置步骤涉及登录控制台、下载并放置校验文件至域名根目录、验证文件可访问性以及提交场景说明与截图审核。此外,文档还列举了 render 域名限制、scheme 校验、白名单缺失、SSL 强制开启及 startApp 权限等常见错误码及其对应的解决方案,帮助开发者排查页面加载异常问题。 - [支付宝小程序内嵌 H5 页面](https://opendocs.alipay.com/mini/03a8a8.md): 本文档介绍了支付宝小程序嵌入 H5 页面的方法。核心是通过 `` 标签承载网页。前置条件包括拥有企业账号且 H5 页面需部署于支持 HTTPS 的自有服务器。实施流程分五步:注册企业账号;完成平台入驻;创建小程序并配置关键设置(包括接口加签、服务器域名白名单、H5 域名校验及 HTTPS 升级),获取 APPID;在开发工具中编写代码嵌入页面;最后进行提审与发布。文档着重强调了安全配置与域名白名单的重要性。 - [lifestyle 关注生活号](https://opendocs.alipay.com/mini/038ro7.md): 本文档介绍了支付宝小程序 lifestyle 组件,用于实现小程序内关注生活号的功能。组件要求基础库 1.13.0 及客户端 10.1.5 以上版本,暂不支持 Native 渲染。它仅支持关联的生活号,用户点击可进行关注或跳转。核心属性包括必填的 public-id(生活号 APPID)和关注成功回调 onFollow。文档还说明了自定义样式的包裹方法、真机调试的要求,以及通过 API 查询用户关注状态的方法。 - [contact-button 智能客服](https://opendocs.alipay.com/mini/038ro2.md): 该文档详细介绍了支付宝小程序智能客服组件的接入与使用方法。该服务由蚂蚁集团零号云客服提供,仅支持企业用户,且对基础库和客户端版本有特定要求,暂不支持Native渲染引擎。使用时,开发者需通过`contact-button`组件集成,必填属性为`tnt-inst-id`(企业编码)和`scene`(聊天窗编码),两者均可在云客服后台获取。组件支持自定义按钮样式、支付宝端内消息提醒以及接入访客名片等高级功能。文档还详细说明了各属性配置方法,特别是通过`ext-info`属性实现订单数据带出和未读消息同步,并提供了常见问题的排查思路。 - [error-view 异常视图](https://opendocs.alipay.com/mini/038x70.md): 该文档介绍了一个用于展示业务异常状态的组件。其主要目的是在服务器异常、业务空状态或逻辑执行失败时提供统一视图,避免白屏以提升用户体验。组件要求基础库版本不低于2.7.0,且不支持Native渲染引擎。功能上,它支持全屏与非全屏两种模式,并提供default、busy、error、network、trade五种预设异常类型。开发者可通过属性自定义主次文案及颜色,支持内嵌button或navigator组件实现自定义按钮行为(如刷新、返回),并能通过data-*属性传递异常详情。组件默认适配深色背景,低版本环境需进行兼容性检测。 - [join-group-chat 加入群聊](https://opendocs.alipay.com/mini/05snwq.md): 文档介绍了支付宝小程序“join-group-chat”组件的功能与接入方法,旨在引导用户加入商家群聊。该组件根据用户入群状态自动调整跳转逻辑,未入群跳转中间页,已入群直接进入群聊。使用时需注意基础库版本需2.8.3及以上,且暂不支持Native渲染引擎和自定义文案,建议使用真机调试。组件核心属性为必填的“template-id”,开发者需登录商家平台,在商家粉丝群管理后台创建并发布组件模板后获取该ID,随后将其嵌入小程序代码中即可完成配置。 - [subscribe-message 嵌入式订阅](https://opendocs.alipay.com/mini/05z9mt.md): 本文档介绍了小程序嵌入式订阅消息组件,用于在小程序内向用户发送订阅消息。组件根据用户订阅状态动态展示:有未订阅模板时显示“订阅”按钮,全部订阅后变为“管理”按钮,若用户已拒绝或全部订阅则不展示组件。该组件要求基础库2.8.4以上版本,暂不支持Native渲染引擎。文档提供了AXML和JS代码示例,定义了template-id和onComplete属性,并详细说明了回调函数中用户操作行为behavior及订阅数据result的结构。最后列举了十余种错误码,涵盖用户取消、参数无效、模板配置异常及系统限制等场景,供开发者参考处理。 - [获取头像昵称](https://opendocs.alipay.com/mini/0cz1w1.md): 该文档介绍了支付宝小程序的“头像昵称填写”能力,旨在帮助用户快速完善个人资料。该功能需基础库2.9.29及客户端10.6.0以上支持。开发者可通过设置button组件open-type为chooseAvatar实现头像选择,设置input组件type为nickname实现昵称填写。文档特别强调,自基础库2.9.37起,系统会对头像和昵称进行安全检测。若图片或昵称未通过检测,将分别导致回调不触发或输入内容被清空,建议开发者使用表单提交方式收集数据。 #### 无障碍访问 - [aria-component](https://opendocs.alipay.com/mini/038ro4.md): 本文档介绍了小程序无障碍访问功能中 aria 属性的使用。自基础库 1.18.0 起,view、button 等基础组件支持该属性,但 Native 渲染引擎暂不支持。核心内容包括利用 role 属性为 AXML 组件赋予语义角色(如 article、heading),使用 aria-label 提供文本描述或替代内容,通过 aria-labelledby 关联组件实现内容联合朗读。文档还阐述了 aria-checked 和 aria-expanded 在交互状态反馈中的应用,特别是自定义组件需显式设置状态。此外,文档简述了 WCAG 等无障碍标准,并提供了 iOS 和 Android 系统开启读屏功能的操作指南。 #### 页面属性配置节点 - [page-meta](https://opendocs.alipay.com/mini/038x71.md): 文档详细介绍了小程序组件 `page-meta` 的功能与用法。该节点用于配置页面属性及监听事件,须为页面首个节点,功能等同于特定页面API调用。使用需基础库 2.7.7 及以上版本。文档提供了 AXML 和 JS 代码示例,演示了背景色、滚动位置、字体大小等属性的配置方法及滚动事件的监听。属性说明部分涵盖了窗口背景色(含iOS顶部/底部)、根背景色、滚动控制、页面样式及根字体大小等关键配置,并指出了部分属性在 Native 渲染引擎下的兼容性限制。 #### 扩展组件 - [UI 组件说明](https://opendocs.alipay.com/mini/06nl5s.md): 支付宝开放平台于2023年02月08日发布公告,宣布mini-ali-ui组件库将停止更新与升级,并推荐开发者转用antd-mini组件库。公告明确指出,此次停更不会对已使用该组件的现有小程序造成影响,确保了存量业务的稳定性。针对新组件库的使用问题,官方提供了antd-mini交流群(群号:62730003177)供开发者咨询。官方对此次调整带来的不便表达了歉意。 #### 广告 - [ad 图文广告](https://opendocs.alipay.com/mini/0drov4.md): 本文档介绍了小程序图片广告组件的使用方法与规范。该组件支持单行图片和轮播图两种样式,要求基础库版本1.14.0及以上,且支付宝客户端需在10.1.72版本以上以避免兼容性问题,同时仅支持Android 5.0及以上系统。在代码实现上,开发者需使用``标签,并配置必填属性`unit-id`,该ID需在支付宝媒体管理平台申请。此外,组件提供了`onLoad`和`onError`两个可选回调函数,分别用于处理广告查询成功与失败(如网络异常)的事件。 - [ad-feeds 信息流广告](https://opendocs.alipay.com/mini/0hyzqb.md): 该文档主要介绍了支付宝官方信息流广告组件的功能特性、使用限制及接入方法。该组件用于展示双列商品Feeds流,支持下拉加载及个性化推荐,要求基础库版本不低于2.9.81,低版本需做兼容处理。文档提供了具体的代码示例,展示了如何在页面中引入组件及检测支持性。组件核心属性包括必填的广告展位码、可选的骨架屏卡片数量以及广告加载成功或失败的事件回调函数,开发者需在支付宝媒体管理平台申请展位码后方可使用。 ### 服务端 #### 支付产品 ##### JSAPI 支付 - [JSAPI支付产品介绍](https://opendocs.alipay.com/mini/053llc.md): 该文档介绍了支付宝JSAPI支付产品的核心功能与应用。JSAPI支付允许商家在支付宝小程序内通过接口唤起收银台完成收款,并支持商家分账功能。目前该产品仅限于小程序场景使用,严禁通过小程序拉起H5页面支付。准入对象涵盖企业、个人及个体工商户,个人申请需提供营业执照。计费方面,单笔费率为0.6%至1%,分账免费,服务费四舍五入保留两位小数。退款有效期为交易后12个月内,资金原路退回且退还手续费。结算默认实时到账,但新签约商家需遵循T+1结算规则。 ###### 权限集列表 ###### 支付(必选) - [产品介绍](https://opendocs.alipay.com/mini/05x9kt.md): JSAPI支付是商家在支付宝App内通过调用接口唤起收银台完成收款的产品,核心应用于小程序支付场景。产品支持企业、个人及个体工商户账号申请,个人申请需提供一致的营业执照。计费采用单笔模式,费率介于0.6%至1%之间,支持余额、银行卡及花呗等支付方式,商家分账免费。退款有效期为交易后12个月,资金原路退回并退还手续费。结算默认实时到账,但新签约未满90日或连续交易未满30日的商家实行T+1结算。使用时严禁小程序内拉起H5支付,分账退款由系统自动按比例处理。 - [接入准备](https://opendocs.alipay.com/mini/05xmim.md): 本文主要介绍使用支付宝开放平台服务端SDK快速接入JSAPI支付的流程,支持商家自研和服务商代开发两种模式。自研商家需创建小程序应用,配置接口加签方式与应用网关等关键参数,完成应用上线、账号绑定、产品开通及APPID关联。服务商模式需创建第三方应用,协助商家开通产品、关联APPID并获取代开发授权令牌。最后,文档详细说明了服务端SDK的集成步骤,包括公钥模式与公钥证书模式下的AlipayClient对象初始化配置及关键参数说明,确保开发者能正确调用支付接口。 - [接入指南](https://opendocs.alipay.com/mini/05x9ku.md): 本文档介绍了使用支付宝开放平台服务端SDK接入JSAPI支付的流程,支持商家自研和服务商代开发两种模式。商家自研需完成创建小程序应用、配置加签方式与网关、上线应用、绑定商家账号、开通产品并关联APPID等步骤,注意资金接口须用证书加签且必须关联APPID。服务商模式需创建第三方应用、协助商家开通并关联APPID、获取代开发授权令牌。最后,文档详细说明了SDK的集成方法及alipayClient的初始化配置,包括公钥模式与公钥证书模式的关键参数设置。 ###### API 列表 - [my.tradePay](https://opendocs.alipay.com/mini/05xhsr.md): 本文档详细介绍了支付宝小程序支付接口 `my.tradePay` 的使用方法,该接口支持 JSAPI 支付和预授权支付两种模式,适用于企业小程序。JSAPI 支付用于唤起收银台完成付款,预授权支付则用于资金冻结、扣款及解冻。文档分别阐述了两种模式的接入流程,涵盖开发配置、产品开通、服务端获取交易参数(trade_no 或 orderStr)、前端唤起及服务端结果验证等关键步骤。文档特别强调前端返回码 9000 不能作为支付成功的依据,需以服务端异步通知或查询结果为准。此外,文档还提供了详细的入参说明、错误码排查建议、代码示例及常见问题解答。 - [统一收单交易创建接口](https://opendocs.alipay.com/mini/05x9kv.md): 本文档详细介绍了支付宝JSAPI支付下单接口的使用规范。该接口用于在交易创建后获取交易号,需配合小程序`my.tradePay`方法完成支付流程。文档首先定义了公共请求参数,涵盖应用ID、接口方法、签名类型及时间戳等必填字段。接着重点解析业务请求参数,明确了商户订单号、金额、标题、产品码(JSAPI_PAY)及小程序应用ID(op_app_id)等必填项,并对买家标识、商品信息、超时设置、支付渠道控制及签约参数等可选参数进行了详细说明。文档提供了Java、PHP、C#及cURL等多种语言的代码示例,区分了交易组件接入场景。此外,还列出了响应参数结构、常见业务错误码及其解决方案,并阐释了异步通知的触发类型与数据格式,为开发者集成小程序支付功能提供了完整指导。 - [统一收单交易撤销接口](https://opendocs.alipay.com/mini/05xunj.md): 本文档详细介绍了支付宝撤销交易接口的功能与使用规范。该接口用于处理支付失败或系统超时,根据支付状态关闭订单或退款,仅限结果未知时调用,正常退款需用退款API。文档列出了公共及业务请求参数,要求传入商户订单号或支付宝交易号。提供了cURL、Java、C#和PHP的SDK调用示例。此外,说明了响应参数结构及含义,并列举了包括“交易不允许撤销”、“商户余额不足”在内的多种业务错误码及其解决方案,供开发者集成参考。 - [统一收单交易查询接口](https://opendocs.alipay.com/mini/05xsky.md): 该文档详细介绍了支付宝统一收单交易查询接口。该接口用于商户主动查询订单状态,适用于系统异常未收到通知、返回未知状态或处理中状态、以及撤销交易前确认等场景。文档明确了公共请求参数(如app_id、method、sign等)和业务请求参数,其中商户订单号与支付宝交易号二选一。响应参数涵盖交易状态、金额明细、买家信息及支付渠道等。此外,文档提供了Java、PHP、C#等多种语言的调用示例,并列出了常见业务错误码及解决方案,帮助商户集成查询功能。 - [统一收单交易退款接口](https://opendocs.alipay.com/mini/05xskz.md): 本文档详细介绍了支付宝退款接口的功能规则与接入规范。该接口支持单笔交易多次退款,要求退款总额不超过交易金额,并通过唯一的退款请求号保障幂等性。文档强调了退款时间限制、间隔要求及防重复退款注意事项。核心业务参数包括必填的退款金额、交易单号,以及可选的商品详情与分账回退信息。特别指出退款成功判断以`fund_change=Y`为准,而非接口响应码。此外,文档提供了Java、PHP等多语言调用示例及常见业务错误码解决方案,指导开发者安全准确地实现退款流程。 - [统一收单交易退款查询接口](https://opendocs.alipay.com/mini/07wx9g.md): 该文档详细介绍了支付宝统一收单交易退款查询接口。商户可利用此接口查询退款请求的执行状态。文档强调了关键注意事项:接口返回码10000仅代表查询操作成功,需通过检查`refund_status`字段是否为`REFUND_SUCCESS`来确认退款是否真正成功;若退款未成功,可使用相同的退款请求号和金额进行重试;建议查询请求在退款发起10秒后进行。文档明确了公共请求参数与业务请求参数(如退款请求号、交易号等),提供了Java、C#、PHP等语言的调用示例。响应参数涵盖了交易金额、退款状态、资金渠道及优惠券详情等,并附带常见业务错误码及解决方案,指导商户准确处理退款查询流程。 - [收单退款冲退完成通知](https://opendocs.alipay.com/mini/05xr1l.md): 本文档定义了支付宝退款至银行卡完成后的通知接口(alipay.trade.refund.depositback.completed)规范。该通知仅在退款请求中传入deposit_back_info选项时触发。文档详细列出了公共请求参数(如notify_id、sign、app_id等)及消息属性,核心包含交易号、退款状态及金额。其中dback_status字段标识冲退结果,失败时资金转入支付宝余额。商户需响应“success”以确认处理,否则系统将在25小时内按特定策略进行最多8次重试投递。 - [查询对账单下载地址接口](https://opendocs.alipay.com/mini/05xr1m.md): 该文档介绍了支付宝商户离线账单下载接口,旨在帮助商户通过API获取账单下载地址以实现快速查账。接口核心请求参数包括应用ID、签名、时间戳等公共参数,以及账单类型、账单日期和二级商户ID等业务参数。文档详细说明了多种账单类型(如交易账单、资金账单、营销账单等)及其对应的日期格式规则,并提供了cURL、Java、C#和PHP的接入代码示例。响应结果包含账单下载链接,该链接有效期为30秒。此外,文档还列举了参数无效、账单不存在、系统限流等常见业务错误码及其相应的解决方案,指导开发者正确处理异常情况。 - [统一收单交易关闭接口](https://opendocs.alipay.com/mini/05xhst.md): 本文档详细介绍了支付宝“统一收单交易关闭接口”的使用规范。该接口用于在交易创建后,用户超时未支付时,商户主动关闭未付款交易。文档阐述了公共请求参数(如app_id、method、签名类型等)及业务请求参数,重点说明了trade_no与out_trade_no二选一的逻辑。同时提供了Java、PHP、C#、Node.js等多种语言的SDK调用示例。此外,文档列出了公共与业务响应参数,定义了正常及异常响应格式,并针对参数无效、交易状态异常、交易不存在等业务错误码提供了具体解决方案,最后说明了交易关闭后的异步通知触发机制。 - [常见问题](https://opendocs.alipay.com/mini/05xhsu.md): 该文档详细解答了支付宝小程序支付(JSAPI支付)的常见开发问题。内容涵盖支付额度限制的成因与解除方法、产品审核时效,重点对比了“JSAPI支付”与“当面付”的区别。文档明确了从“当面付”迁移至“JSAPI支付”的关键步骤:修改产品码为JSAPI_PAY、新增op_app_id字段及在商家平台关联小程序APPID。此外,针对IDE环境测试报错、无法调起支付及主体未绑定等故障,提供了具体的排查方案与代码示例,指导商家快速完成接入与调试。 ###### 相关资料 - [对账说明](https://opendocs.alipay.com/mini/0et4s2.md): 支付宝提供商家平台下载和接口调用两种对账方式。商家平台支持下载资金账单和交易账单,包含日账单和月账单功能,数据范围覆盖至2013年,月账单通常在次月4日前生成。接口对账支持收款账号接入和主账号开通接入两种模式,商家通过调用alipay.data.dataservice.bill.downloadurl.query接口获取下载链接,下载CSV文件进行自动对账,需注意链接仅30秒有效期。下载的账单分为业务账单和账务账单,均包含汇总和明细表,支持在下载设置中自定义字段和语言。 - [异步通知说明](https://opendocs.alipay.com/mini/080p65.md): 本文档详细阐述了支付宝支付结果的异步通知机制。在支付完成后,支付宝通过POST请求向商户的notify_url发送支付结果。为保证系统稳定性,文档强烈建议商户同时接入主动查询接口,以防因通知丢失导致订单状态不一致。核心内容涵盖异步通知的参数说明,包括交易状态(如TRADE_SUCCESS、TRADE_FINISHED)及其触发条件,以及资金明细和优惠券信息的字段解析。此外,文档说明了通知的重试策略:若未收到“success”响应,系统将按特定频率重发。最后,重点介绍了异步返回结果的验签流程,包括RSA签名验证步骤及商户侧必须执行的业务逻辑二次校验(如订单号、金额、商户ID的核对),确保交易数据的真实性与安全性。 - [沙箱调试说明](https://opendocs.alipay.com/mini/0845zf.md): 该文档介绍了支付宝沙箱环境及其在JSAPI支付调试中的应用。沙箱环境与生产环境隔离,支持核心链路调试,允许开发与商务流程并行以提高效率,但数据体系独立且逻辑以生产环境为准。文档详细阐述了JSAPI支付的业务用例流程,涵盖创建订单、唤起收银台、接收通知、交易查询及退款五个关键步骤,并提供了各接口的调用示例、参数说明及沙箱退款规则(金额须一致且仅限一次)。 - [小程序细分业务场景](https://opendocs.alipay.com/mini/08by8k.md): 该文档阐述了JSAPI支付业务场景的集成方案。商家通过统一收单交易创建接口回传business_params参数,即可在商家后台的小程序交易数据中对不同业务场景进行拆分查看。文档详细定义了涵盖餐饮、零售、商业生活、交通出行、车主服务、教育培训、医疗卫生、酒旅景区、生活缴费、物流传输等十四大行业的数十种细分业务场景代码及适用范围,如餐饮外卖、共享充电宝、医疗挂号、顺风车等,旨在帮助商家精准匹配业务类型,实现精细化的数据运营与管理。 - [更新日志](https://opendocs.alipay.com/mini/07esf8.md): 该文档记录了支付宝开放平台在2023年7月至2026年1月期间的产品更新动态。核心内容包括:账单下载接口新增多个错误码(如流量限制、类型不支持等)并优化参数描述;交易查询接口将交易号等字段调整为可选返回;交易退款接口新增指定退款账号及凭证编号等字段。此外,JSAPI支付实现全面开放,官方新增业务FAQ,明确退分账规则按新老商户区分执行,并补充了账期结算标识字段的详细说明。 - [更新日志](https://opendocs.alipay.com/mini/07z3ry.md): 2023年7月15日,支付宝宣布新增JSAPI支付功能全面开放。该功能主要面向商家及服务商,支持在支付宝App内通过调用官方提供的JSAPI接口,直接唤起收银台完成收款操作。此次更新为商家在支付宝生态内的支付场景提供了便捷的接口调用方案。 ##### 商家扣款 - [产品介绍](https://opendocs.alipay.com/mini/06de8c.md): “商家扣款”是“周期扣款”的升级产品,支持商家引导用户签约后主动发起周期性扣款,适用于会员包月、租赁缴费等场景。产品包含“支付并签约”与“独立签约后扣款”两种模式,支持移动端、PC和小程序场景。使用时需遵守扣款时间(7:00-22:00)、金额限制(单笔限额100元,优惠价不低于原价1/3)及签约参数(周期类型、首次扣款时间等)等规范。准入条件严格,仅限注册资本不少于2000万且无经营风险的企业账号接入。费率为单笔0.6%-1%,退款期限12个月并退还手续费,新签约商家可能面临T+1结算。 ###### 权限集列表 ###### 商家扣款(必选) - [产品介绍](https://opendocs.alipay.com/mini/0izsmy.md): “商家扣款”产品已于2026年3月28日完成升级,新版支持商家引导用户签约后主动发起周期性扣款,并支持关联“商家分账”。该产品单笔限额100元,适用于会员包月、租赁缴费等场景,核心模式为“支付并签约”。使用时需遵守扣款时间、优惠金额限制及间隔周期等规则。准入条件要求商家为企业账号,注册资本不低于2000万元,且满足月活用户数量与无经营风险等要求。计费按单笔0.6%-1%收取,支持退款退费,结算默认实时到账。 - [接入准备](https://opendocs.alipay.com/mini/0izne4.md): 本文档主要介绍使用支付宝开放平台服务端SDK接入“商家扣款”产品的流程,支持商家自研和服务商代开发两种模式。自研商家需完成创建应用、配置关键参数(如接口加签、应用网关)、上线应用、绑定账号及开通产品等步骤。服务商模式则侧重于创建第三方应用、获取商家授权令牌及协助开通产品。文档还详细说明了SDK的集成方法,包括公钥模式与公钥证书模式的初始化配置、关键参数说明及代码示例,指导开发者安全、规范地完成接口调用。 ###### 接入指南 - [支付并签约场景](https://opendocs.alipay.com/mini/0iztfw.md): 本文档指导商家接入支付宝“商家扣款-支付并签约”产品,实现用户支付同时完成代扣协议签约。该产品仅支持自研或第三方应用代调用,不支持沙箱,产品码固定为GENERAL_WITHHOLDING。接入场景包括商家APP、支付宝小程序和PC端网页。APP与PC端需调用alipay.trade.app.pay生成订单串或二维码唤起支付;小程序需先调用alipay.trade.create获取tradeNo再通过my.tradePay唤起。签约参数需配置周期规则、场景码及个人产品码CYCLE_PAY_AUTH_P。签约成功后,商家可通过alipay.trade.pay发起周期扣款,系统支持异步扣款与重试。文档还提供了协议查询、解约、退款及异步通知处理等辅助功能指引。 - [SDK&DEMO](https://opendocs.alipay.com/mini/0izsn0.md): 本文档主要介绍了支付宝客户端 SDK 和服务端 SDK 的功能定义与集成说明。客户端 SDK 需集成于商户 App,用于唤起支付宝 App 处理签约及支付请求,支持 iOS 和 Android 双端,涵盖“支付并签约”与“独立签约”功能,并针对 iOS 端特定场景提供了独立签约 SDK 方案。服务端 SDK 需集成于商户服务端,用于发起代扣、查询等请求及处理返回结果,支持 JAVA、PHP、Python、NodeJS 和 .NET 五种语言,封装了签名、验签和 HTTP 请求等基础功能,协助开发者快速接入。 - [异步通知说明](https://opendocs.alipay.com/mini/0iziyx.md): 本文档阐述了支付宝异步通知机制,用于在支付完成后向商户发送交易结果。核心内容包括:建议商户同时接入查询接口以防通知遗漏;详细定义了通知参数、交易状态枚举及触发条件;规定了重试策略(立即3次,后续延时至15h);强调了严格的安全验签流程,需先RSA验签,再二次校验订单号、金额、商户ID等信息,并仅在TRADE_SUCCESS或TRADE_FINISHED状态下认定支付成功。商户处理后需返回“success”以停止通知。 ###### API 列表 ###### 签约 - [支付宝个人协议页面签约接口](https://opendocs.alipay.com/mini/08bntw.md): 该文档详细阐述了支付宝代扣协议页面签约接口的功能与使用规范。该接口用于生成跳转链接,支持用户在支付宝H5页面完成代扣协议签约,需在服务端调用SDK并返回页面数据供前端渲染。文档核心内容包括公共请求参数与业务请求参数说明,其中个人签约产品码、访问渠道及单次扣款限额为必填项,周期扣款需额外配置周期规则参数。此外,接口支持芝麻授权、子商户信息、用户实名信息、签约场景及风控信息的配置。文档最后提供了Java、C#、PHP的代码示例,以及响应数据的处理方式和异步通知示例。 - [支付宝个人代扣协议查询接口](https://opendocs.alipay.com/mini/08bntu.md): 该文档详细介绍了支付宝个人代扣协议查询接口的功能与使用规范。接口允许商户通过协议号、商户签约号或用户信息查询代扣协议详情。文档明确了请求参数规范,指出应优先使用alipay_open_id进行用户标识。响应内容涵盖协议状态、有效期、签约主体及还款计划等关键信息。文中提供了cURL、Java、C#及PHP的代码示例,并列举了系统异常、参数错误、协议不存在等常见业务错误码及其解决方案,辅助开发者高效对接与调试。 - [支付宝个人代扣协议解约接口](https://opendocs.alipay.com/mini/08bntt.md): 本文档定义了支付宝个人代扣协议解约接口,接口名称为alipay.user.agreement.unsign,用于解除用户与商户间的代扣协议。请求包含公共参数和业务参数,核心业务参数需传入用户标识(推荐使用alipay_open_id,与alipay_user_id、alipay_logon_id三选一,有优先级之分)和协议标识(agreement_no或external_agreement_no二选一)。文档详细说明了参数约束、签名要求及异步解约操作类型。接口响应仅包含公共状态码,无特定业务返回参数。此外,文档提供了Java、PHP等多种语言的SDK调用示例,列举了SYSTEM_ERROR、AGREEMENT_NOT_EXIST等常见业务错误码及其解决方案,并附带了异步通知示例,为开发者提供了完整的接入指引。 ###### 支付 - [app支付接口2.0接口](https://opendocs.alipay.com/mini/08bnts.md): 该文档介绍了支付宝App支付接口,用于生成可信签名字符串以唤起客户端执行支付并签约。接口需在服务端调用,核心参数包括公共参数(app_id、签名信息等)与业务参数。业务参数涵盖基础订单信息及签约配置,支持周期扣款场景,可设定扣款周期、限额及执行时间。文档提供了Java、C#、PHP及Node.js的接入代码示例,说明了响应参数orderStr的获取方式。此外,还列举了无权限、系统错误等业务错误码的解决方案,并描述了支付成功、关闭等状态的异步通知机制,为商户接入支付签约功能提供了完整指南。 - [统一收单交易支付接口](https://opendocs.alipay.com/mini/08bntx.md): 该文档详细介绍了支付宝商家扣款接口,用于商户在用户签约后进行免密代扣操作。接口核心请求参数包括商户订单号、金额、标题、产品码(固定为GENERAL_WITHHOLDING)及代扣协议信息等,并支持配置商品详情、优惠及异步支付参数。文档提供了cURL、Java、PHP等多种语言的SDK调用示例。响应结果包含交易号、支付状态及资金渠道等信息。此外,文档列举了详尽的业务错误码及其解决方案,涵盖协议失效、余额不足、限额超限等异常场景,并定义了交易状态变更的异步通知机制,确保商户能准确处理扣款结果。 - [统一收单交易查询接口](https://opendocs.alipay.com/mini/08bntl.md): 本文档主要介绍了支付宝订单查询接口的功能与使用规范。该接口支持商户主动查询所有支付宝支付订单的状态,适用于商户系统未收到支付通知、接口返回系统错误或处理中状态、以及撤销交易前确认状态等场景。接口请求需包含商户订单号或支付宝交易号二选一,并支持定制查询选项以获取结算信息、资金渠道等额外数据。文档提供了Java、PHP、C#、Node.js及cURL的调用示例,详细说明了公共请求参数与业务请求参数。响应结果涵盖交易状态、金额详情、买家信息及各类扩展业务数据。此外,文档还列举了交易不存在、参数无效等常见业务错误码及其解决方案,供开发者排查问题。 - [统一收单交易退款接口](https://opendocs.alipay.com/mini/08bntn.md): 该文档是支付宝退款接口(alipay.trade.refund)的开发指南。核心功能为卖家通过接口将款项原路退还给买家。主要规则包括:支持单笔交易多次部分退款,需保证退款请求号唯一且重试时不变;累计退款金额不得超标;同一交易退款间隔需3秒以上;严禁与其他退款产品混用。退款成功的判断标准是返回参数`fund_change=Y`,若为N或无值需调用查询接口确认。若原订单涉及分账,退款前需接收方开启分账回退授权。文档详细列出了公共与业务请求参数(如退款金额、订单号、退分账明细等)、响应参数说明,并提供了Java、PHP等多种语言的代码示例及常见错误码解决方案。 - [统一收单交易关闭接口](https://opendocs.alipay.com/mini/08bnto.md): 该文档详细介绍了支付宝“alipay.trade.close”接口,用于关闭用户创建后一定时间内未支付的订单。文档主要包含公共请求参数与业务请求参数的详细定义,其中业务参数trade_no与out_trade_no二选一且前者优先级更高。文中提供了cURL、Java、C#、PHP及Node.js五种语言的请求代码示例,以及正常和异常情况下的响应参数说明。此外,文档列举了ACQ.INVALID_PARAMETER、ACQ.TRADE_NOT_EXIST等常见业务错误码及其解决方案,并说明了交易关闭触发的异步通知类型及回调示例,为开发者提供了完整的接入指引。 - [统一收单交易撤销接口](https://opendocs.alipay.com/mini/08bntp.md): 本文档详细说明了支付宝撤销交易接口(alipay.trade.cancel)的使用规范。该接口仅适用于支付系统超时或结果未知的场景,用于关闭未支付订单或退款已支付订单。文档界定了接口的公共请求参数(如app_id、method、签名等)及业务参数(商户订单号或支付宝交易号二选一),并提供了Java、PHP、C#及cURL的调用示例。响应结果中包含Action字段标识具体操作(close或refund),Retry_flag字段提示是否重试。文档最后列举了包括余额不足、交易已完结、超过撤销时间等常见业务错误码及其解决方案,强调正常支付订单应使用退款API。 ###### 对账 - [查询对账单下载地址接口](https://opendocs.alipay.com/mini/08bntr.md): 本文档详细介绍了支付宝离线账单下载接口的使用方法,旨在帮助商户通过接口获取离线账单下载地址以实现快速查账。文档核心内容包括接口的公共请求参数(如app_id、签名、时间戳等)和业务请求参数(必选的账单类型bill_type、账单日期bill_date及可选的二级商户smid)。接口支持多种账单类型,如交易账单、资金账务账单及营销账单等,并规定了具体的日期格式和数据生成规则。文档提供了cURL、Java、C#和PHP四种语言的请求示例,详细说明了响应参数中下载链接的有效期(30秒)及状态码,并列出了常见的业务错误码及其对应的解决方案,便于开发者排查问题。 ###### 相关资料 - [支付界面规范](https://opendocs.alipay.com/mini/08ayir.md): 本文档旨在为商家和开发者提供支付宝收银台的标准视觉规范与设计资源。为确保接入支付宝收款及相关产品功能时用户体验的一致性,文档明确了一系列界面设计要求,包括采用标准LOGO、将支付方式置于首位选择、设置默认勾选状态,以及配置推荐角标和副标题。同时,文档提供了包含支付宝、花呗及花呗分期等产品的标准Logo、Icon和功能按钮标识素材包供下载,助力开发者实现规范化的功能设计。 - [常见场景码值](https://opendocs.alipay.com/mini/08bg92.md): 该文档主要说明了支付宝个人协议页面签约接口中签约场景(sign_scene)参数的填写规范。支付宝为彩票、医疗、餐饮、出行等常见行业提供了预定义的场景码。若商家的业务未包含在预设列表中,允许根据规则自定义场景码。自定义规则要求格式为“INDUSTRY|业务场景英文大写”,且无空格,支持下划线扩展。文档详细列举了包括数字传媒、教育、生活缴费等在内的二十余种行业对应的场景码参考值,供开发者根据实际业务性质进行选择和填写。 - [常见问题](https://opendocs.alipay.com/mini/0izne6.md): 该文档是支付宝“商家扣款”产品的常见问题解答汇总,主要涵盖签约、扣款规则、额度限制及异常处理等内容。签约方面,同一用户在同一商家下可通过外部签约号和场景参数区分多套协议,但同场景下仅限签约一次,解约可通过接口或用户客户端操作。扣款由商家主动发起,额度受限(单笔≤100元,周期≥7天),且需在约定日期内进行。针对扣款失败,文档规定了预通知及24小时后扣款的重试流程,并建议重试不超过2次。此外,还详细列举了日期不符、超额等错误码的处理方式,以及实名信息Hash生成的技术实现细节。 - [更新日志](https://opendocs.alipay.com/mini/08astd.md): 本文档记录了支付宝产品从2023年至2026年的关键更新日志。核心内容涵盖商家扣款产品的重大升级与全面开放,新接入商家需遵循新版规范,旧版将停止能力更新。文档详细记录了多个核心API接口的调整,包括账单下载、交易查询、交易退款及用户协议签约等,涉及错误码新增、参数描述更新及字段扩展。此外,还涉及商户准入条件的变更(如账号认证时限与活跃用户要求)、App集成签约SDK的标准化以及相关业务规则的优化。整体反映了平台在产品功能、接口规范及准入门槛上的持续迭代。 - [更新日志](https://opendocs.alipay.com/mini/08b7wh.md): 本文档主要记录了商家扣款产品的更新日志,包含两项关键变更。首先,2023年7月15日,商家扣款产品正式全面开放,明确支持“先签约后代扣”和“支付后签约”两种应用场景。其次,2024年11月7日,对产品的准入条件及相关说明内容进行了更新。文档简要回顾了产品的开放历程及后续规则的调整情况。 ##### 预授权支付 - [预授权支付产品介绍](https://opendocs.alipay.com/mini/06de96.md): “预授权支付”是支付宝推出的押金与预存支付产品的升级版,支持在用户消费前冻结资金,消费后按实扣款并解冻余款。该产品适用于住宿、出行及租赁等行业,支持线上(App/H5、小程序)及特定线下类目交易,开通时须严格匹配交易场景。仅限企业账号接入,需提交相应资质。计费方面,预授权阶段免费,转支付阶段按0.6%-1%费率收费,资金T+1结算。退款周期为12个月,支持资金原路退回并退还手续费。产品还支持关联商家分账,退款时自动按比例退分账。 ###### 权限集列表 ###### 预授权支付(必选) - [产品介绍](https://opendocs.alipay.com/mini/064jh5.md): “预授权支付”是支付宝推出的升级产品,旨在替代原有的支付宝预授权与新当面资金授权。该产品支持商家在用户消费前冻结资金作为押金,消费后按实扣款并解冻余额,广泛适用于住宿、出行、租物等行业的线上及特定线下场景。商家需使用企业账号申请,并根据小程序、移动设备或线下场所等不同场景提交相应资质材料。产品在预授权阶段免费,转支付阶段按0.6%-1%费率收费,资金T+1日到账。退款有效期为12个月,手续费可随退款退还。商家需严格按照开通时选定的交易场景进行接入与使用,支付宝将不再维护旧版产品。 - [接入准备](https://opendocs.alipay.com/mini/064jh6.md): 本文档介绍了支付宝预授权支付产品的服务端 SDK 接入流程,支持商家自研和服务商代开发两种模式。商家自研模式需依次完成创建应用、配置应用(接口加签、应用网关等必填项)、上线应用、绑定商家账号及开通产品等步骤;特别强调了资金类接口需证书加签,开通产品时需正确选择交易场景。服务商模式则需创建第三方应用、协助商家开通产品并获取代开发授权。此外,文档详细说明了 SDK 的下载、集成及初始化配置,涵盖公钥模式与公钥证书模式的关键参数设置与代码示例,指导开发者快速搭建接口调用环境。 ###### 接入指南 ###### 线上场景 - [快速接入](https://opendocs.alipay.com/mini/064jh8.md): 本文档为支付宝预授权支付功能的接入指引,适用于自研商家及服务商。核心流程涵盖资金冻结、冻结转支付、资金解冻及撤销等环节。商户首先通过服务端调用冻结接口生成订单,客户端(APP/H5/小程序)唤起支付宝收银台完成用户授权与资金冻结;服务结束时,商户可调用支付接口进行扣款,或调用解冻接口释放剩余资金。文档详细介绍了各业务场景的API调用方法、关键参数配置(如产品码PREAUTH_PAY)、异步通知处理规范,以及查询、退款和对账等辅助功能的实现逻辑,旨在帮助开发者构建安全高效的“先授权、后消费”支付体系。 - [iOS 集成流程](https://opendocs.alipay.com/mini/064jh9.md): 本文档详细介绍了支付宝SDK在iOS平台的接入指南与开发流程。内容涵盖了SDK的两种导入方式(CocoaPods与手动导入)及必要的系统依赖库配置。核心部分阐述了支付流程:建议在服务端组装并签名订单信息,客户端接收后调用`payOrder`接口发起支付,并通过`AppDelegate`中的`openURL`方法处理支付回调。文档还提供了Demo运行配置、URL Schemes设置、Swift项目桥接文件配置等关键步骤,以及针对常见编译错误的解决方案。最后,详细说明了`AlipaySDK`的核心API接口定义、参数说明及同步返回结果的处理逻辑,帮助开发者完成支付功能的集成。 - [Android 集成流程](https://opendocs.alipay.com/mini/08nz3k.md): 本文档主要介绍支付宝SDK从旧版AAR依赖迁移至Maven依赖的流程及接口调用方法。开发者需先在项目中移除旧版AAR文件及依赖配置,随后在主项目和App Module的Gradle文件中分别配置Maven仓库并引入新SDK依赖。文档规范了必要的网络权限配置。在支付接口调用上,强调需在非UI线程中执行PayTask的payV2方法,并建议开启Loading过渡以优化体验。支付结果支持客户端同步返回和服务端异步通知两种获取方式。此外,还提供了获取SDK版本号的方法及联调问题排查指引。 ###### 线下场景 - [快速接入](https://opendocs.alipay.com/mini/09bn1m.md): 本文档详细介绍了支付宝预授权支付的接入指引,涵盖支付、退款及对账三大核心流程。支付流程包括资金冻结、转支付与解冻。资金冻结支持“商家扫用户付款码”和“用户扫商家二维码”两种模式,分别对应免密和验密场景,涉及资金授权冻结和发码接口。服务完成后,商家可调用交易支付接口进行扣款,剩余资金通过解冻接口返还。此外,文档还提供了交易查询、撤销授权、订单信息同步、退款处理及账单下载等接口的详细参数说明、代码示例及异常处理逻辑,帮助开发者实现从授权冻结到资金结算的全链路集成。 ###### API 列表 ###### 预授权 - [my.tradePay](https://opendocs.alipay.com/mini/064jhf.md): 该文档详细介绍了支付宝小程序API `my.tradePay` 的使用方法,主要用于发起JSAPI支付和预授权支付。文档首先强调已接入旧版产品的开发者需在2024年3月1日前完成升级,以免影响功能。针对JSAPI支付,核心流程包括开发配置、产品开通、服务端创建交易获取交易号(tradeNO)、前端唤起收银台,并重点指出需通过服务端异步通知或查询接口确认支付成功,不可仅依赖前端返回码。预授权支付流程类似,区别在于需服务端生成冻结订单参数(orderStr)、前端唤起授权页,后续通过接口完成资金扣款或解冻。文档还详细说明了入参定义、各类错误码的处理逻辑及常见问题解答。 - [线上资金授权冻结接口](https://opendocs.alipay.com/mini/064jhe.md): 该文档详细介绍了支付宝预授权资金冻结接口的功能与使用规范。该接口作为签名数据准备接口,用于生成包含业务参数及商户身份信息的可信签名字符串,主要适用于线上场景(如商户APP)拉起支付宝收银台以完成资金冻结。文档界定了公共请求参数与业务请求参数,重点说明了商户订单号、冻结金额、订单标题等必选参数,以及免押模式、后付费项目、支付渠道限制等可选配置。同时,提供了Java、C#和PHP三种语言的SDK调用示例。此外,文档列举了系统错误、权限校验失败等业务错误码及解决方案,并说明了资金冻结成功、订单关闭等异步通知触发机制,为开发者接入预授权功能提供了完整的技术指导。 - [资金授权操作查询接口](https://opendocs.alipay.com/mini/064jhg.md): 该文档详细介绍了支付宝资金授权操作明细查询接口,用于查询单笔冻结、解冻或支付明细的详细信息。文档重点阐述了不同业务场景下的参数配置规则:查询冻结明细默认类型为FREEZE;查询解冻明细需传入UNFREEZE;查询支付明细需传入PAY类型并使用对应交易单号;针对Complete模式下关联解冻明细的查询也做了特别说明。请求参数分为公共参数和业务参数,支持商户侧或支付宝侧重选。响应结果包含授权订单状态与资金操作状态,需注意区分。文档还提供了多语言调用示例及常见错误码解决方案,指导开发者准确获取资金操作详情。 - [资金授权撤销接口](https://opendocs.alipay.com/mini/064jhh.md): 本文档详细说明了支付宝资金授权撤销接口的使用方法。该接口仅适用于商户因系统超时或授权结果未知需终止业务的场景,若确认冻结成功需解冻应使用解冻接口。撤销操作必须在冻结后24小时内发起,且仅在无法确认操作结果时调用。接口包含公共请求参数和业务请求参数,后者需传入撤销备注及订单号、流水号等标识信息。响应结果包含订单信息及资金动作类型。文档提供了多种语言的代码示例,并列举了系统繁忙、超时、订单不存在等常见错误码及其解决方案。 - [资金授权解冻接口](https://opendocs.alipay.com/mini/064jhi.md): 本文档详细介绍了支付宝资金授权订单解冻接口的功能与使用规范。该接口允许商家在资金授权冻结后,因特定原因通过接口请求将资金按原路解冻。文档核心内容包括:公共请求参数与业务请求参数的定义,重点说明了授权订单号、解冻流水号、金额及备注等必选字段的要求;提供了cURL、Java、C#及PHP多种语言的调用示例;详细列举了响应参数结构、常见业务错误码及其解决方案(如订单不存在、状态非法、金额超限等);最后说明了解冻成功后的异步通知机制。 - [资金授权发码接口](https://opendocs.alipay.com/mini/09bj50.md): 本文档详细介绍了支付宝资金预授权发码接口的功能与使用方法。该接口旨在帮助商户生成二维码,用户扫码后即可完成资金冻结,适用于预授权及免押金场景。文档核心内容包括接口的公共请求参数与业务请求参数配置,重点说明了商户订单号、冻结金额、产品码(PREAUTH_PAY)等必填项,以及免押受理台模式、后付费项目、支付渠道限制等可选配置。此外,文档提供了Java、PHP、C#等多种语言的代码示例,明确了响应参数中二维码码串与图片地址的获取方式,并列出了系统异常、权限不足、余额不足等常见业务错误码及其解决方案,同时支持资金冻结成功及订单关闭的异步通知机制。 - [资金授权冻结接口](https://opendocs.alipay.com/mini/09bk7c.md): 该文档定义了支付宝资金授权冻结接口,用于收银员扫码(付款码或刷脸)后冻结用户资金。请求包含公共参数和业务参数,核心字段包括付款码、商户订单号、产品码(PREAUTH_PAY)和冻结金额,支持配置后付费项目、支付渠道限制及信用预授权扩展参数。响应返回支付宝授权订单号、操作状态及付款人信息,区分资金冻结与信用预授权类型。文档提供了多语言代码示例,详细列举了系统及业务错误码(如余额不足、权限受限)及其解决方案,并说明了异步通知机制,确保交易状态同步。 ###### 交易 - [统一收单交易支付接口](https://opendocs.alipay.com/mini/064jhk.md): 本文档详细说明了支付宝预授权转交易扣款接口的功能与规范。该接口用于商户在用户授权冻结资金后,通过授权单号发起扣款。文档明确了公共请求参数和业务请求参数,其中产品码需固定为PREAUTH_PAY,并规定了预授权确认模式等可选配置。同时提供了Java、PHP、C#、Node.js及cURL的代码示例。在响应处理方面,文档界定了交易成功与失败的返回参数,并列举了涵盖权限、限额、订单状态等维度的业务错误码及其解决方案。此外,还定义了交易状态变更的异步通知机制。 - [统一收单交易关闭接口](https://opendocs.alipay.com/mini/064jhl.md): 该文档详细介绍了支付宝交易关闭接口的使用方法。该接口用于在交易创建后,若用户未在规定时间内付款,商户可调用此接口关闭未支付的交易。文档明确了公共请求参数(如app_id、method、sign等)和业务请求参数(trade_no与out_trade_no二选一)。此外,文档提供了Java、PHP、C#、Node.js等多种语言的SDK调用示例,列出了公共与业务响应参数及正常、异常响应示例。针对接口调用中可能出现的参数无效、交易状态异常、交易不存在等业务错误码,文档给出了具体的解决方案,并说明了交易关闭后的异步通知机制及通知示例。 - [统一收单交易退款查询接口](https://opendocs.alipay.com/mini/064jhm.md): 本文档介绍了支付宝退款查询接口,用于商户查询退款请求的执行结果。核心要点包括:接口返回码10000仅代表查询成功,需依据refund_status字段判断退款是否成功;建议查询间隔10秒以上;重试时需保证参数一致。请求参数包含必填的退款请求号及二选一的交易号或订单号,支持定制返回字段。响应内容涵盖交易信息、退款状态、金额、退分账及银行卡冲退详情。文档还提供了多语言代码示例及常见错误码处理建议。 - [统一收单交易查询接口](https://opendocs.alipay.com/mini/064jhn.md): 本文档介绍了支付宝交易查询接口的使用规范,该接口允许商户主动查询所有支付宝支付订单的状态。主要应用于商户系统未收到支付通知、接口返回系统错误或未知状态、处理支付进行中状态及撤销交易前确认状态等场景。请求参数包含公共参数和业务参数,业务参数中商户订单号与支付宝交易号二选一,支持通过`query_options`定制返回字段。文档详细列举了Java、PHP、C#、Node.js等语言的调用示例。响应结果涵盖了交易状态、金额明细、买家信息、资金渠道及结算信息等核心数据。此外,文档还提供了公共错误码和业务错误码的说明及相应的解决方案,帮助开发者快速集成与排查故障。 - [统一收单交易退款接口](https://opendocs.alipay.com/mini/064jho.md): 本文档详细介绍了支付宝退款接口的功能、规则及接入方法。该接口支持卖家在交易发生后将款项原路退回买家,支持全额及多次部分退款,但累计退款金额不得超过交易总额。使用时需注意:重试需保持退款请求号不变以防重复退款;同一交易退款间隔需3秒以上;不可与其他退款产品混用;退款成功需以返回参数`fund_change=Y`为准。涉及分账的退款需接收方授权。文档还提供了公共请求参数、业务参数(如退款金额、订单号、退分账明细)的详细说明,给出了Java、PHP等多种语言的代码示例,并列举了余额不足、交易状态异常等常见业务错误码及其解决方案。 - [支付宝订单信息同步接口](https://opendocs.alipay.com/mini/09gic4.md): 本文档定义了支付宝接口`alipay.trade.orderinfo.sync`,用于商户向支付宝同步订单业务信息。主要适用于芝麻信用授权及代扣场景,通过`order_biz_info`字段反馈“COMPLETE”(已履约)或“CLOSED”(已取消)状态。文档详述了必选的公共请求参数(如app_id、sign_type)及关键业务参数(trade_no、out_request_no、biz_type),其中`out_request_no`用于幂等控制。同时提供了Java、PHP、C#及cURL的请求示例代码。响应参数包含交易号及买家ID,并列举了参数无效、交易不存在等业务错误码及处理方案,指导开发者正确集成。 ###### 账单 - [查询对账单下载地址接口](https://opendocs.alipay.com/mini/064jhr.md): 该文档介绍了支付宝商户离线账单下载接口,旨在帮助商户快速查账。接口支持获取多种类型的账单下载地址,包括交易、资金、营销活动及直付通相关账单。请求需包含公共参数和业务参数,其中必选的业务参数为账单类型和账单日期,支持下载近6年内的日账单或月账单。文档提供了Java、PHP等多种语言的调用示例。接口返回的下载链接有效期为30秒。此外,文档详细列出了各类业务错误码,如账单不存在、参数不合法或频率限制等,并针对不同错误场景提供了具体的解决方案。 - [常见问题](https://opendocs.alipay.com/mini/064jhs.md): 本文档主要解答支付宝预授权支付及资金授权接口的常见问题。针对接口返回未知错误(code=20000/SYSTEM_ERROR),文档详细说明了针对冻结、查询、撤销及解冻等不同接口的处理策略,强调需通过查询或重试确认状态,不可简单推断成败,持续异常需联系客服。对于预授权冻结报错ALIN1018031或系统异常,需分别检查产品开通状态、功能包挂载及使用正确的SDK调用方法。此外,文档明确了退款有效期与自动解冻期默认均为1年,支持一次授权多次扣款,并对冻结转支付返回10003状态提供了查询建议。 ###### 相关资料 - [对账说明](https://opendocs.alipay.com/mini/064jhb.md): 文档介绍了支付宝的两种常用对账方式:商家平台下载和接口调用。平台下载方式支持用户登录商家平台下载资金账单和交易账单,涵盖日账单和月账单,数据范围始于2013年。接口对账方式通过调用查询接口获取下载地址,支持收款账号接入和主账号接入模式,适用于自动化对账,链接有效期30秒。附录部分详细说明了业务账单与财务账单的结构,列出了业务账单字段与支付接口参数的对应关系,并介绍了自定义账单下载设置的功能。 - [异步通知说明](https://opendocs.alipay.com/mini/064jha.md): 该文档详细阐述了支付宝异步通知机制,涵盖授权与支付两大场景。文档建议商户结合主动查询接口防止因网络问题导致的“丢单”及重复支付。核心内容包括异步通知的触发条件、状态流转及关键参数(如订单号、金额、交易状态)。文档重点说明了RSA/RSA2验签流程,强调需严格校验订单信息与收款方身份以保障安全。此外,明确了服务器通知页面的配置要求,指出必须输出“success”以停止重试,并阐述了系统在接收失败时的重试策略及频率,确保交易结果的准确送达。 - [支付渠道说明](https://opendocs.alipay.com/mini/08gj4x.md): 该文档主要定义了支付渠道代码与具体支付方式名称之间的映射关系。文档以表格形式列出了十二种主流支付渠道的编码信息,涵盖了从第三方支付平台余额、红包、优惠券到银行卡及数字货币等多种资金来源。具体代码包括对应支付宝红包的COUPON、对应支付宝账户的ALIPAYACCOUNT、对应集分宝的POINT、对应折扣券的DISCOUNT、对应预付卡的PCARD、对应商家储值卡的MCARD、对应商户优惠券的MDISCOUNT、对应商户红包的MCOUPON、对应银行卡的BANKCARD、对应余额宝的MONEYFUND、对应券的VOUCHER以及对应数字人民币的DCEP_ASSET。此列表为支付系统识别和处理不同资金渠道提供了标准化的代码参考。 - [沙箱调试说明](https://opendocs.alipay.com/mini/08o704.md): 本文档介绍了支付宝沙箱环境及其预授权支付的调试方法。沙箱环境与生产隔离,支持核心功能,允许开发与商务并行,但需注意数据独立性及与生产环境的差异。文档重点通过业务用例详细阐述了预授权支付的三种核心场景:资金授权解冻、资金授权撤销和预授权支付。每种场景均包含完整的接口调用流程指引,涵盖资金冻结、客户端支付、异步通知、查询、解冻/撤销、转支付及退款等环节,并提供了对应的OpenAPI接口名称及关键参数示例,帮助开发者在沙箱环境下快速完成集成调试。 - [更新日志](https://opendocs.alipay.com/mini/064jht.md): 文档记录了支付宝开放平台2023年7月至2026年1月的接口更新日志。核心内容涵盖:一是预授权支付体系完善,包括产品全面开放、资金冻结与发码接口新增、芝麻免押参数支持及退分账规则调整;二是核心交易接口迭代,涉及退款接口新增指定账号与凭证字段,交易查询参数可选性调整;三是账单与错误处理优化,账单下载接口新增多个流控与数据相关的错误码,并更新字段描述。整体体现了平台在资金管理、交易流程精细化及系统健壮性方面的持续提升。 - [更新日志](https://opendocs.alipay.com/mini/08duar.md): 2023年7月15日,预授权支付产品正式全面开放。该产品定义了一种针对押金场景的支付解决方案:商家可在用户实际消费前提前冻结一定资金作为押金,待消费完成后,系统按实际金额从冻结资金中扣除款项给商家,剩余金额则解冻返还给用户。 #### 私域产品 ##### 支付宝电子发票 - [产品介绍](https://opendocs.alipay.com/mini/0h6vh3.md): 支付宝电子发票为商家和服务商提供三大核心产品:“开通乐企开票”支持一站式税务资质申请与配置;“正向开票”由销售方开具,直连税务系统,适用于餐饮、停车等支付后开票场景;“反向开票”由购买方代开,涵盖报废品收购、灵活用工等场景。用户需先开通乐企服务,再按需开通正反向开票。该服务免费,支持企业、个人及个体工商户账号接入,旨在满足不同商业场景下的合规开票需求。 ###### 权限集列表 ###### 开通乐企开票 - [产品介绍](https://opendocs.alipay.com/mini/0h6pzn.md): “开通乐企开票”产品旨在为服务商及集团型企业提供接口发起的授权流程能力,实现税局乐企联用资质申请与开票配置的一站式完成。该产品支持正向开票与反向开票两种典型场景,均采用接口与页面集成的模式进行开通。核心使用流程包含企业选择产品、商家登录开通页、支付宝人工审核及乐企能力授权四个步骤。准入对象涵盖支付宝企业账号、个人账号及个体工商户。接入方需满足地方税务局试点要求及开发配置规范,该产品目前免费开放。 - [接入准备](https://opendocs.alipay.com/mini/0h6pzu.md): 本文介绍了使用支付宝开放平台服务端SDK接入“开通乐企开票”的流程。接入方式分为商家自研和服务商代开发两种。商家自研需创建应用并配置接口加签、应用网关等参数后上线。服务商模式需创建第三方应用,获取商家授权令牌调用接口。文档详细说明了服务端SDK的集成步骤,重点阐述了公钥模式与公钥证书模式下的AlipayClient初始化方法,提供了Java代码示例及关键参数说明,帮助开发者完成接口调用前的环境配置。 - [接入指南](https://opendocs.alipay.com/mini/0h6pzv.md): 本文档案旨在指导商家或服务商接入“开通乐企发票”产品。该产品仅支持自研或第三方应用代调用方式接入,且暂不支持沙箱调试。接入流程分为四个阶段:首先是创建应用并申请权限的前置准备;其次是拼装包含必要参数的PC端或移动端开通URL;第三是部署HTTPS异步回调接口以接收授权结果;最后是查询开通结果。其中,反向开票仅支持企业支付宝,正向开票支持企业或个人支付宝。服务商需注意关键参数配置及回调接口规范,确保商户能顺利完成授权开通。 ###### API 列表 - [发票产品查询接口](https://opendocs.alipay.com/mini/0hh1vy.md): 本文档定义了支付宝发票产品查询接口 `alipay.commerce.ec.invoice.product.query`,用于查询平台已发布的发票产品信息,支持第三方代理调用。接口请求需传入必选参数 `product_type`,支持基础能力、正向开票、反向开票三种类型。响应包含产品列表,提供产品编号、名称、类型及描述。文档提供了Java、PHP、C#和HTTP请求示例,并定义了系统繁忙、参数有误等业务错误码及解决方案,指导开发者完成接口集成与调试。 - [发票产品开通申请接口](https://opendocs.alipay.com/mini/0hh1vx.md): 本文档介绍了支付宝接口 `alipay.commerce.ec.invoice.merchantproduct.apply`,用于商户或第三方开发者申请开通发票产品。接口请求需包含企业税号、发票产品编号及外部申请ID等核心参数,支持Java、PHP、C#及HTTP调用。响应内容包含申请流水ID、开通状态及办理页面链接。文档详细列出了公共参数与业务参数说明,并针对系统繁忙、参数有误、税号不一致、产品已存在等常见业务错误码提供了具体的解决方案,帮助开发者实现发票产品的顺利开通与异常处理。 - [发票产品开通通知接口](https://opendocs.alipay.com/mini/0hh1vz.md): 该文档详细说明了支付宝发票产品开通通知接口(alipay.commerce.ec.invoice.merchantproduct.notify)的技术规范。该接口用于向商户发送发票产品开通流程的状态变更通知。通知请求包含通知ID、时间戳、签名等公共参数,以及申请ID、开通状态(如待审核、开通成功、失败等枚举值)和开通页面链接等业务属性。商户系统需同步响应“success”以确认处理成功;若返回“fail”或响应失败,系统将在25小时内按特定频率(如2m、10m、1h等)最多重试8次,以确保消息触达。 - [发票产品开通查询接口](https://opendocs.alipay.com/mini/0hh1w0.md): 本文档介绍了支付宝接口`alipay.commerce.ec.invoice.merchantproductopen.query`,用于查询发票产品的开通状态,支持第三方代理调用。接口请求需包含公共参数(如app_id、sign等)及业务参数,其中企业税号为必填,产品开通流水ID与外部申请ID二选一。文档提供了Java、PHP、C#及HTTP的请求示例,详尽说明了请求与响应的参数结构。响应结果包含申请ID、开通状态(如待审核、授权中、开通成功等)及开通页面链接。此外,文档还列举了系统繁忙、参数有误、税号不一致等业务错误码及其对应的解决方案,指导开发者顺利完成接口集成与调试。 - [常见问题](https://opendocs.alipay.com/mini/0h6pzx.md): 本文档概述了商家开通发票产品的准入要求及税局授权校验标准。商家须使用支付宝企业认证账户,法人账户暂不被支持。在提交税局授权时,主要校验两项内容:一是认证信息证件号必须为统一社会信用代码(通常以9开头);二是认证名称必须与税务登记名称完全一致,包括括号等细节。 - [更新日志](https://opendocs.alipay.com/mini/0h6pzy.md): 该文档记录了支付宝开放平台关于发票业务的接口更新与产品发布。主要内容包括:2026年3月24日更新了“发票产品开通查询”与“发票产品开通通知”两个接口,两者均在flow_status字段中新增了“AUTH_FAIL(授权失败)”枚举值,以完善状态反馈。此外,2025年7月14日新增“开通乐企开票全面开放”产品,为服务商及集团型企业提供一站式接口,用于发起授权流程、申请税局乐企联用资质及配置开票服务。 ###### 正向开票 - [产品介绍](https://opendocs.alipay.com/mini/0hkkqe.md): 文档介绍了“正向开票”产品,这是一种基于乐企数字化平台、由销售方为购买方开具电子发票的解决方案。该产品通过支付宝接口直连税务系统,具备高稳定性、安全性与合规性,广泛适用于餐饮、零售、酒店、停车及加油等收银开票场景。核心功能分为“支付即开”与“支付可开”两种模式,分别支持支付后自动开票和消费者手动申请开票。针对停车场景,文档特别说明了需传入车牌号等特定信息的操作要求。此外,该产品支持多种账号类型免费接入,但接入方需满足地方税务局试点要求及开发配置规范。 - [接入准备](https://opendocs.alipay.com/mini/0hkkql.md): 本文档主要介绍使用支付宝开放平台服务端 SDK 快速接入“正向开票”产品的操作指南。文档明确了商家自研和服务商代开发两种接入模式。商家自研模式涵盖创建应用、配置应用(包括接口加签、应用网关等必填项及 IP 白名单等选填项)、上线应用及开通产品等步骤。服务商模式则需创建第三方应用,获取商家授权令牌后协助开通并进行接口调用。此外,文档详细阐述了 SDK 的下载集成及 AlipayClient 初始化配置,重点对比了公钥模式与公钥证书模式下的参数设置与代码示例,指导开发者完成安全高效的接口对接。 - [接入指南](https://opendocs.alipay.com/mini/0hkkqm.md): 本文档为支付宝“正向开票”产品的接入指引,适用于自研商家及服务商。该产品通过API接口实现,暂不支持沙箱调试。核心功能涵盖三大模块:开票申请、企业信息管理与商品管理。开票申请流程包括创建申请、接收状态通知、查询结果及异常重试,支持在48小时内对特定错误码进行重试操作。企业信息管理支持查询企业详情及维护开票员信息。商品管理提供税收分类编码查询及商品的增删改查功能。文档详细阐述了各模块的接入流程、接口说明及注意事项,指导用户实现发票开具的全流程闭环。 ###### API 列表 ###### 开票申请 - [支付开票开票申请创建接口](https://opendocs.alipay.com/mini/0hplph.md): 本文档介绍了支付宝接口`alipay.commerce.ec.industryinvoice.invoiceapply.create`,用于企业发起支付开票申请创建,支持第三方代理调用。接口支持开具蓝票或红票(需关联原蓝票),涵盖增值税专票和普票。核心请求参数包括交易信息、发票基础信息、购买方与销售方详情、商品明细列表及开票员信息等。特殊场景下需录入不动产租赁信息或旅客运输信息。文档提供了Java、PHP、C#及HTTP请求示例,并详细列举了参数校验、额度不足、配置缺失等业务错误码及其解决方案,供开发者在集成时参考。 - [支付开票开票申请重试接口](https://opendocs.alipay.com/mini/0hkmrz.md): 本文档介绍了支付宝接口`alipay.commerce.ec.industryinvoice.invoiceapply.retry`,用于支付开票申请的异常重试,支持第三方代理调用。接口要求传入开票申请ID、发票产品ID和企业税号三个必选业务参数。文档提供了Java、PHP、C#及HTTP的请求示例,详述了SDK初始化、参数构建及响应处理流程。此外,文档列出了正常与异常响应格式,并针对系统繁忙、参数错误、并发冲突、余额不足、重试超限等业务错误码提供了具体的解决方案,指导开发者进行规范的接入与错误排查。 - [支付开票开票申请查询接口](https://opendocs.alipay.com/mini/0hkmry.md): 本文档详细介绍了支付宝接口`alipay.commerce.ec.industryinvoice.invoiceapply.query`,用于企业查询开票申请,支持第三方代理调用。文档明确了请求所需的公共参数(如app_id、sign等)及业务参数(企业税号、产品ID及二选一的申请ID)。响应内容涵盖交易信息、买卖双方详情、发票状态与金额、商品明细及特定条件下的不动产信息。此外,文档提供了Java、PHP、C#及HTTP的代码示例,并列出了常见的业务错误码及其解决方案,指导开发者正确集成与调试。 - [支付开票开票申请状态变更通知接口](https://opendocs.alipay.com/mini/0hkms0.md): 本文档介绍了支付宝接口`alipay.commerce.ec.industryinvoice.invoiceapply.notify`,用于通知商户开票申请状态的变更。文档详细定义了接口的公共请求参数(如通知ID、签名、时间戳等)及消息属性,包括企业税号、交易列表、申请ID和发票状态(初始化、提交、成功、失败等)。接口通过HTTP POST发送通知,商户需同步响应“success”以确认处理成功,否则返回“fail”将触发重试机制。重试策略规定在25小时内进行8次通知,间隔时间逐渐延长,以确保消息送达。 ###### 企业信息 - [企业信息查询接口](https://opendocs.alipay.com/mini/0i5lhq.md): 本文档介绍了支付宝接口`alipay.commerce.ec.industryinvoice.company.query`,用于查询已开通正向发票产品的企业信息,支持第三方代理调用。接口请求需包含应用ID、签名、时间戳等公共参数及必选的业务参数“企业税号”。文档提供了Java、PHP、C#和HTTP的请求示例。响应内容涵盖企业名称、开票员信息及已开通产品列表等关键数据。此外,文档列举了系统繁忙、参数有误、企业不存在、税号不匹配及产品未开通等常见业务错误码及其解决方案,帮助开发者快速集成与排查问题。 - [乐企开票员查询接口](https://opendocs.alipay.com/mini/0i5lhp.md): 本文档介绍了支付宝接口`alipay.commerce.ec.invoice.clerk.query`(乐企开票员查询)的详细规范。该接口支持第三方代理调用,旨在为已开通发票产品的企业查询可用的乐企开票员信息。文档详细列出了公共请求参数(如app_id、method、sign等)和业务请求参数(核心为企业税号tax_no),并提供了Java、PHP、C#及HTTP的请求示例。响应结果包含开票员列表,具体字段涵盖姓名、身份标识及确认状态(如已确认、已拒绝等)。此外,文档还列出了SYSTEM_ERROR、INVALID_PARAMETER等业务错误码及其对应的解决方案,供开发者在集成与调试过程中参考。 - [企业开票员编辑接口](https://opendocs.alipay.com/mini/0i5p7e.md): 本文档介绍了支付宝接口`alipay.commerce.ec.industryinvoice.clerk.modify`,该接口用于企业编辑开票员信息,支持第三方代理调用。接口请求需包含企业税号和开票员身份标识两个核心业务参数。文档提供了Java、PHP、C#及HTTP等多种语言的请求示例,详细说明了SDK初始化与调用流程。此外,文档还解析了正常与异常响应格式,并列举了系统错误、参数无效、企业不存在、产品未开通等业务错误码及其解决方案,帮助开发者快速排查问题。 ###### 商品管理 - [税收分类编码查询接口](https://opendocs.alipay.com/mini/0i5lhr.md): 本文档介绍了支付宝接口`alipay.commerce.ec.invoice.taxcategory.batchquery`,该接口专为已开通发票产品的企业提供税收分类编码查询功能,并支持第三方代理调用。文档指出仅最末级税收叶子节点可用于创建商品。详细说明了公共请求参数与业务请求参数(核心为企业税号),提供了Java、PHP、C#及HTTP等多种语言的调用示例。响应结果包含税收分类编码列表,涵盖商品名称、税率等详细信息。此外,文档还列举了系统繁忙、参数错误、企业不存在等业务错误码及其解决方案。 - [新增商品接口](https://opendocs.alipay.com/mini/0i5kot.md): 该文档详细介绍了支付宝接口`alipay.commerce.ec.industryinvoice.item.add`,旨在为已开通正向发票产品的企业提供新增商品数据的功能,并支持第三方代理调用。接口要求传入企业税号、商品名称、税收分类编码等必选参数,并对商品单位和优惠政策标识设置了特定的条件必填规则。文档提供了Java、PHP、C#及HTTP等多种语言的请求示例,详细说明了请求参数与响应结构。此外,还列举了包括参数校验失败、企业信息不存在、商品名称重复及并发冲突在内的多种业务错误码及其相应的解决方案,辅助开发者顺利接入。 - [删除商品接口](https://opendocs.alipay.com/mini/0i5kou.md): 本文档介绍了支付宝接口`alipay.commerce.ec.industryinvoice.item.delete`,用于删除企业商品库中的指定商品。该接口支持第三方代理调用,适用于已开通正向发票产品的企业。通过传入企业税号(`tax_no`)和企业商品ID(`company_item_id`),可对商品进行逻辑删除,删除后商品不可检索或开票,但不影响历史订单数据。文档详细列出了公共请求参数与业务请求参数,提供了Java、PHP、C#及HTTP的请求示例,并针对系统繁忙、参数有误、商品不存在、默认商品禁止删除等常见业务错误码给出了具体的解决方案。 - [修改商品接口](https://opendocs.alipay.com/mini/0i5lhs.md): 本文档介绍了支付宝接口 `alipay.commerce.ec.industryinvoice.item.modify`,用于修改企业商品信息。该接口支持第三方代理调用,适用于已开通正向发票产品的企业维护商品数据。文档详细定义了公共请求参数(如app_id、sign等)和业务请求参数,其中企业税号、商品ID、名称和税率为必填项。特殊规则包括:特定商品类型需填单位,税率为0时需填优惠政策标识。文档提供了Java、PHP、C#及HTTP的请求示例,并列举了系统错误、参数错误、商品不存在、名称重复等业务错误码及其解决方案,供开发者集成参考。 - [分页商品查询接口](https://opendocs.alipay.com/mini/0i5kov.md): 本文档详细说明了支付宝接口`alipay.commerce.ec.industryinvoice.item.batchquery`,旨在为已开通正向开票产品的企业提供分页查询商品信息的能力,并支持第三方代理调用。接口请求需包含必填的分页参数及企业税号,支持按商品名称、税收分类编码等条件筛选。响应数据包含商品ID、名称、规格、含税单价、税率及优惠政策标识等详细信息。文档提供了完整的公共与业务参数定义,涵盖了Java、PHP、C#及HTTP多种语言的请求示例,并列举了系统繁忙、参数错误、企业信息不存在等业务错误码及其解决方案,为开发者接入提供了全面指导。 ###### 相关资料 - [开票申请创建接口参数枚举说明](https://opendocs.alipay.com/mini/0i32us.md): 本文档详细定义了支付宝支付开票申请创建接口中两个关键参数的枚举值标准。文档首先列出了购买方自然人国籍参数的代码标识,涵盖了全球200多个国家和地区及地区的中文名称对照,明确区分了中国大陆及港澳台地区。其次,文档列举了购买方自然人证件类型参数的枚举值,内容覆盖单位证件(如营业执照)、居民身份证、军警证件、港澳台居住及通行证件、外国人居留证及工作许可等各类身份证明文件。该标准为接口调用提供了严格的数据规范,确保了发票申请中身份信息的准确性与兼容性。 - [开票申请创建接口金额相关参数计算校验逻辑](https://opendocs.alipay.com/mini/0i3ikm.md): 本文详细介绍了支付宝支付开票申请创建接口的金额计算与校验逻辑。内容涵盖明细行和票面两部分:明细行根据含税或不含税金额的传入情况,规定了相应的税额、单价及数量计算公式,明确了四舍五入与银行家舍入法的应用场景,并设定了严格的参数精度与误差阈值。票面部分则规范了价税合计、合计税额等汇总金额的累计计算方式及其精度校验标准,确保开票金额数据的准确性与一致性。 - [常见问题](https://opendocs.alipay.com/mini/0hkkqo.md): 文档主要解答了企业开票过程中的两个关键问题。首先,针对开票额度不足的情况,文档明确指出额度由税务系统及主管税务机关动态管控,企业需联系主管税务机关申请提额。其次,关于交易渠道支持范围,文档说明正向开票目前仅支持支付宝交易单据,第三方交易渠道尚未开放。这些信息为企业处理开票额度限制及确认适用交易范围提供了明确的操作指引。 - [更新日志](https://opendocs.alipay.com/mini/0hkkqp.md): 文档记录了支付宝正向开票产品的更新日志,涵盖三个关键节点。首先,产品已全面开放,核心功能是由销售方为购买方开具电子发票,通过直连税务系统保障稳定性与合规性,广泛适用于餐饮、零售等商家收银场景。其次,新增企业信息及商品管理功能,支持企业信息查询、开票员管理以及商品税收分类编码的维护与查询。最后,支付开票申请创建接口进行了参数扩展,新增字段支持传入旅客运输信息列表,进一步丰富了开票场景的数据维度。 ###### 反向开票 - [产品介绍](https://opendocs.alipay.com/mini/0h6onj.md): 本文档介绍了“反向开票”产品,这是一种由购买方企业代替销售方个人开具发票的特殊开票方式。该产品主要应用于资源回收、农产品收购及灵活用工等场景。核心流程为企业通过支付宝小程序生成付款码,自然人扫码即可完成支付、缴税与开票的一站式操作。产品支持当面付款与远程收款两种订单模式,并允许企业灵活管控订单审核。该产品免费向支付宝企业账号、个人账号及个体工商户开放,接入方需满足地方税务局试点要求并进行相应的开发配置。 - [接入准备](https://opendocs.alipay.com/mini/0h6onq.md): 本文档介绍了使用支付宝开放平台服务端SDK接入“反向开票”的流程,包含商家自研和服务商代开发两种模式。自研商家需依次完成创建应用、配置应用(关键项包括接口加签和应用网关)、上线应用及开通产品。服务商模式需创建第三方应用,获取授权后协助商家开通并调用接口。文档详细阐述了应用配置的各项参数作用,重点讲解了SDK的集成步骤,提供了公钥模式与公钥证书模式下的初始化代码示例及关键参数说明,指导开发者安全、规范地完成接口调用配置。 - [接入指南](https://opendocs.alipay.com/mini/0h6onr.md): 本文档为支付宝“反向开票”产品的接入指引,指导商家或服务商通过API完成系统集成。接入内容涵盖企业信息、营业员、供应商、商品及订单交易五大管理模块。其中,营业员与订单交易管理为必接模块,供应商管理为远程订单必接模块。核心流程包括配置企业信息与营业员身份认证、维护供应商库并确认关系、构建商品库,以及实现订单创建、审核、支付、开票、取消及红冲等全生命周期管理。此外,文档还说明了业务转账授权流程,支持服务商在获企业授权后代为发起转账,确保交易合规高效。 ###### API 列表 ###### 企业信息管理 - [反向企业信息查询接口](https://opendocs.alipay.com/mini/0hdmgm.md): 本文档介绍了支付宝接口 `alipay.commerce.ec.recyclinginvoice.company.query`,用于反向查询商户开票企业信息。接口支持第三方代理调用,核心功能是通过企业税号查询企业详情及反向开票产品配置。请求参数主要包括必填的企业税号和可选的校验信息更新标志。响应数据涵盖企业名称、已开通产品列表(含计税方式、发票种类、税率等配置)以及企业校验异常信息。文档提供了多语言调用示例,并定义了系统错误、参数无效、企业不存在等业务错误码及其处理方案,帮助开发者快速集成与调试。 - [反向企业产品配置变更接口](https://opendocs.alipay.com/mini/0hdmgn.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.companyproduct.modify`,用于变更商户反向开票产品的配置。该接口支持第三方代理调用,主要功能包括修改订单审核开关、发票票种及税率等设置。文档详细规定了公共参数与业务参数(如产品编号、企业税号、计税方式、税率规则等)的填写要求,提供了Java、PHP、C#及HTTP的请求示例,并列出了常见的业务错误码及其解决方案,帮助开发者实现企业产品配置的变更与维护。 - [反向企业转账账户信息查询接口](https://opendocs.alipay.com/mini/0hdmgo.md): 本文档介绍了支付宝接口 `alipay.commerce.ec.recyclinginvoice.companyaccount.query`,用于反向企业转账账户信息查询。该接口支持第三方代理调用,核心功能是通过企业税号和转账账户ID查询商户的转账账户详细信息。请求需包含必选的业务参数(tax_no、company_account_id)及公共参数(如app_id、sign等)。文档提供了Java、PHP、C#及HTTP的请求示例,展示了SDK初始化与调用流程。响应结果包含账户类型及户名、开户行、卡号、余额等详细信息。此外,文档还定义了系统繁忙、参数有误、账户不存在、税号不匹配及未开通产品等业务错误码及其解决方案。 ###### 营业员管理 - [企业乐企可用开票员信息查询接口](https://opendocs.alipay.com/mini/0hdmgf.md): 本文档详细说明了支付宝接口`alipay.commerce.ec.recyclinginvoice.invoiceclerk.query`的功能与使用方法。该接口主要用于商户查询其在税务系统中注册的开票员信息列表,并支持第三方开发者代理调用。请求时需提供企业税号作为核心业务参数,并配合应用ID、签名等公共参数。文档提供了Java、PHP、C#及HTTP等多种语言的请求示例。响应结果包含开票员列表,具体涵盖开票员身份标识、姓名及确认状态(如已确认、未确认等)。此外,文档还列举了系统繁忙、参数有误、企业不存在、税号不匹配及产品未开通等常见业务错误码,并给出了相应的解决方案,指引开发者顺利完成接口对接与故障排查。 - [反向企业营业员创建接口](https://opendocs.alipay.com/mini/0hdmgu.md): 本文档介绍了支付宝接口 `alipay.commerce.ec.recyclinginvoice.companyclerk.create`,用于反向企业营业员创建。该接口支持第三方代理调用,允许商户为企业添加操作员或开票员。请求参数包含企业税号、外部营业员ID、员工名称及角色,其中手机号和身份标识根据角色不同有条件必填要求。成功调用后返回企业营业员ID及认证链接。文档提供了Java、PHP、C#及HTTP请求示例,并列出了系统异常、参数错误、员工重复、税号不匹配等业务错误码及相应解决方案,帮助开发者排查问题。 - [反向企业营业员变更接口](https://opendocs.alipay.com/mini/0hdmgt.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.companyclerk.modify`,用于反向企业营业员变更。该接口支持第三方代理调用,允许商户修改企业营业员的基本信息。核心业务参数包括企业税号、营业员ID、开票人身份标识、员工名称、手机号及权限列表。其中,权限列表采用全量更新机制,特定权限仅适用于操作员角色。文档提供了Java、PHP、C#及HTTP的请求示例,并详细列举了参数校验、员工状态、产品开通及并发控制等场景下的业务错误码及解决方案,指导开发者完成接口集成与调试。 - [反向企业营业员查询接口](https://opendocs.alipay.com/mini/0hdmgj.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.companyclerk.query`,用于查询商户下的企业营业员信息,支持第三方代理调用。接口要求必传企业税号,并需在员工手机号、企业营业员ID或外部营业员ID中三选一进行查询。响应结果包含营业员的ID、姓名、手机号、角色(操作员/开票员)及状态(初始化/在职/离职)。文档提供了Java、PHP、C#及HTTP请求示例,并列举了系统繁忙、参数有误、税号不匹配等常见业务错误码及其相应的解决方案,指导开发者正确接入和使用该接口能力。 - [企业营业员变更结果通知接口](https://opendocs.alipay.com/mini/0j2r9o.md): 该文档定义了支付宝接口`alipay.commerce.ec.recyclinginvoice.companyclerk.notify`,用于企业营业员变更结果的通知。接口规定了`notify_id`、`app_id`、`sign`等公共请求参数,以及包含外部营业员ID、企业营业员ID、税号和操作类型(新增、修改、删除)的消息属性。通知机制要求接收方同步返回“success”确认成功,否则视为失败并触发重试。重试策略为25小时内投递8次,间隔频率从2分钟逐渐延长至15小时,确保消息送达。 - [企业营业员批量查询接口](https://opendocs.alipay.com/mini/0j2r9p.md): 本文档介绍了支付宝 `alipay.commerce.ec.recyclinginvoice.companyclerk.batchquery` 接口,用于批量查询企业商户营业员信息,支持第三方代理调用。接口请求需包含应用ID、签名等公共参数,业务参数中页码、每页条数和企业税号为必填项,支持按员工手机号、ID或角色进行筛选。响应结果包含分页信息及营业员详细列表(如ID、姓名、角色、状态)。文档提供了Java、PHP、C#及HTTP的请求示例,详细说明了请求与响应参数格式,并列举了系统繁忙、参数有误、税号不匹配等业务错误码及其解决方案。 - [反向企业营业员删除接口](https://opendocs.alipay.com/mini/0hdmgs.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.companyclerk.delete`,该接口用于反向企业营业员删除操作。接口支持第三方代理调用,执行时会删除营业员的相关数据,并同步清理其关联权限与角色信息。请求需提供企业税号(`tax_no`)和营业员ID(`company_clerk_id`)两个必选参数。文档提供了Java、PHP、C#及HTTP等多种语言的请求示例,展示了SDK初始化、参数设置及调用流程。同时,文档列举了包括系统错误、参数无效、员工不存在、特定角色(开票员/管理员)不可删除、税号不匹配及产品未开通在内的业务错误码,并给出了相应的解决方案,帮助开发者快速集成与排查问题。 ###### 供应商管理 - [资源回收自然人税务查询接口](https://opendocs.alipay.com/mini/0ithl2.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.scrappednaturaltax.query`,用于查询资源回收自然人的税务信息(如开票金额),支持第三方代理调用。接口请求需提供企业税号(tax_no)和供应商ID(supplier_id)作为核心参数。响应结果包含开票统计月份及月累计开票总金额列表。文档详细规定了公共请求与响应参数的数据类型与格式要求,并提供了Java、PHP、C#和HTTP四种语言的调用示例代码。此外,文档还列举了系统繁忙、参数错误、商户税号不匹配、产品未开通、供应商信息缺失等常见业务错误码及其解决方案,帮助开发者快速集成与排查故障。 - [供应商新增接口](https://opendocs.alipay.com/mini/0hdmgw.md): 该文档详细介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.companysupplier.create`,用于在反向开票场景下新增供应商信息,支持第三方代理调用。接口要求传入外部供应商ID、企业税号、供应商姓名、支付宝账号及类型等必选参数。文档提供了Java、PHP、C#及HTTP的请求示例代码,展示了SDK初始化与参数设置流程。成功调用后返回供应商ID及用于短信和端内通知的激活链接。此外,文档列举了参数错误、账户信息错误、供应商已存在等常见业务错误码及其解决方案,指导开发者进行正确集成与调试。 - [供应商修改接口](https://opendocs.alipay.com/mini/0hdmge.md): 该文档详细说明了支付宝接口 `alipay.commerce.ec.recyclinginvoice.companysupplier.modify` 的功能与使用方法,该接口用于修改供应商信息并支持第三方代理调用。文档核心内容包括公共请求参数和业务请求参数的定义,重点指出了必填参数为供应商ID和企业税号,可选参数为联系电话。同时,文档提供了Java、PHP、C#及HTTP等多种开发语言的请求示例代码,以及正常与异常响应的格式范例。最后,文档汇总了系统错误、参数校验失败、账户信息异常、并发冲突及供应商状态不可编辑等常见业务错误码,并给出了相应的解决方案,帮助开发者高效排查问题。 - [供应商查询接口](https://opendocs.alipay.com/mini/0hdmgx.md): 本文档详细介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.companysupplier.query`(供应商查询)的技术规范。该接口用于查询供应商信息,支持第三方代理调用。文档明确了公共请求参数(如app_id、method、sign等)和业务请求参数(包括必填的page_num、page_size、tax_no),并提供了Java、PHP、C#及HTTP的接入代码示例。响应结果包含分页信息及供应商详细列表(如姓名、账号、状态)。此外,文档还列举了SYSTEM_ERROR、INVALID_PARAMETER等业务错误码及其对应的解决方案,指导开发者完成接口集成与故障排查。 - [供应商删除接口](https://opendocs.alipay.com/mini/0hdmgg.md): 本文档介绍了支付宝接口 `alipay.commerce.ec.recyclinginvoice.companysupplier.delete` 的详细规范,该接口用于在反向开票场景下删除供应商信息,并支持第三方代调用。接口要求必选业务参数包括供应商ID (`supplier_id`) 和企业税号 (`tax_no`)。文档详细列出了包括应用ID、签名、时间戳在内的公共请求参数,并提供了Java、PHP、C#及HTTP的请求示例代码。响应部分区分了正常与异常情况,成功时返回“10000”。此外,文档还定义了SYSTEM_ERROR、INVALID_PARAMETER、SUPPLIER_NOT_EXIST等业务错误码,并提供了相应的解决方案,指导开发者准确调用接口及处理可能出现的权限、参数或系统异常问题。 - [供应商变更结果通知接口](https://opendocs.alipay.com/mini/0hdmh1.md): 本文档定义了支付宝接口`alipay.commerce.ec.recyclinginvoice.companysupplier.notify`,用于通知企业商户供应商信息的变更结果。文档详细说明了公共请求参数,如通知ID、时间戳、接口名称、应用ID、签名及字符集等。消息属性涵盖外部供应商ID、供应商ID、企业税号及确认状态(待确认、已确认、已拒绝)。接口要求商户系统同步响应“success”以示处理成功,否则返回“fail”。若处理失败,系统将在25小时内按逐步递增的频率进行最多8次重试,确保消息送达。 ###### 订单交易管理 - [反向订单创建接口](https://opendocs.alipay.com/mini/0hdmh0.md): 该接口用于企业创建反向订单,以支持后续交易及反向发票开具,支持第三方代理调用。请求需包含企业税号、发票产品ID、营业员ID、外部订单号(用于幂等)及商品明细等核心参数。商品明细需遵循单价、数量、金额三选二的规则,特定开票场景需传个人所得税类型。接口响应提供平台订单号、税务机关提醒及多种场景链接,包括营业员端支付即开票页面URL、二维码URL及自然人端收款即开票页面URL。文档提供了Java、PHP、C#及HTTP调用示例,并详细列举了参数校验、账户余额、企业资质、风控拦截及供应商关系等维度的业务错误码及其解决方案。 - [反向订单查询接口](https://opendocs.alipay.com/mini/0hdmgr.md): 本文档定义了支付宝接口`alipay.commerce.ec.recyclinginvoice.order.query`,用于查询反向订单并同步最新单据信息。该接口支持第三方代理调用,请求需提供企业税号、产品ID及订单号。响应内容涵盖订单状态、发票详情(含蓝字/红字发票信息及文件下载地址)、税务明细、商品列表、支付状态及业务转账记录。文档提供了Java、PHP、C#及HTTP的请求示例,详细说明了请求与响应参数结构,并列出了订单不存在、产品未开通等常见业务错误码及解决方案,帮助开发者集成反向开票订单查询功能。 - [反向订单操作_审核接口](https://opendocs.alipay.com/mini/0hdmgc.md): 本文档定义了支付宝接口`alipay.commerce.ec.recyclinginvoice.order.audit`,用于企业审核营业员创建的反向订单,支持第三方代理调用。接口要求传入企业税号、发票产品ID、订单号及商品明细等核心业务参数,其中商品单价、数量和金额需遵循“三选二”必填规则。文档详细列出了公共请求参数与业务参数规范,提供了Java、PHP、C#及HTTP的请求示例,并展示了正常与异常响应结构。此外,文档还枚举了系统错误、参数错误、余额不足、订单状态异常及并发冲突等业务错误码,并给出了相应的排查与解决方案,为开发者集成反向订单审核能力提供了完整的技术参考。 - [反向订单操作_取消接口](https://opendocs.alipay.com/mini/0hdmgp.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.order.cancel`,用于企业(商户)取消反向订单,支持第三方代理调用。接口请求需包含`app_id`、`method`、`sign`等公共参数,以及`tax_no`(企业税号)、`product_id`(发票产品ID)和`order_id`(订单号)三个必选业务参数。文档提供了Java、PHP、C#及HTTP的请求示例代码,展示了SDK初始化、参数设置及调用流程。此外,文档详细列出了系统繁忙、参数有误、并发冲突、订单不存在或状态异常、产品未开通等多种业务错误码,并给出了相应的排查与重试解决方案,帮助开发者顺利集成及处理异常。 - [反向订单操作_重试接口](https://opendocs.alipay.com/mini/0hdmgz.md): 该文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.order.retry`,用于企业商户在开票或转账失败时对反向订单执行重试操作,支持第三方代理调用。接口请求需包含企业税号、发票产品ID和订单号等核心业务参数。文档提供了Java、PHP、C#及HTTP的请求示例,详细说明了SDK初始化、参数构建及调用流程。此外,文档列举了公共参数规范及丰富的业务错误码,覆盖系统异常、企业资质状态异常、订单状态错误及开票额度限制等多种场景,并给出了相应的解决方案,帮助开发者快速集成与排查故障。 - [反向订单申请红字发票接口](https://opendocs.alipay.com/mini/0hdmgy.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.orderredinvoice.apply`,用于反向订单申请红字发票。该接口支持第三方代理调用,适用于订单交易成功后发现蓝字发票有误需红冲的场景。核心业务请求参数包括企业税号(tax_no)、发票产品ID(product_id)和订单号(order_id)。文档提供了Java、PHP、C#及HTTP的请求示例,详述了SDK初始化与参数设置流程。响应分为成功与失败两类,文档列举了系统错误、参数无效、企业授权状态异常、订单状态不符及产品未开通等多种业务错误码及其解决方案,指导开发者进行正确的接口调用与故障排查。 - [反向订单变更事件消息通知接口](https://opendocs.alipay.com/mini/0hdmh4.md): 本文档定义了支付宝接口`alipay.commerce.ec.recyclinginvoice.order.notify`,用于同步反向订单的状态变更信息。文档详细规定了公共请求参数(如通知ID、时间戳、签名等)及消息业务属性(包括订单号、订单状态、发票状态、支付状态等)。接口要求商户系统同步响应“success”以确认处理成功,否则系统将判定为失败并触发重试机制。重试策略规定在25小时内最多进行8次通知,间隔时间呈阶梯式递增,确保消息最终送达。 - [反向开票业务转账提交接口](https://opendocs.alipay.com/mini/0jo3sj.md): 本文档介绍了支付宝接口 `alipay.commerce.ec.recyclinginvoice.biztransfer.submit`,用于反向开票业务转账提交。该接口支持第三方代理调用,适用于服务费(抽佣)和物流费等关联业务的资金转账,要求服务商预先获得企业授权。请求需包含企业税号、转账账户ID、订单号、业务类型、金额及收款方信息等必选参数。响应结果涵盖转账单据ID、支付流水号、转账状态及凭证文件ID等关键信息。文档还详细列举了系统异常、余额不足、授权缺失、订单状态异常及业务限额超限等常见错误码及其解决方案,确保转账流程的合规与准确。 - [反向开票订单业务转账授权结果通知接口](https://opendocs.alipay.com/mini/0jo3sk.md): 本文档定义了支付宝反向开票订单业务转账授权结果通知接口。该接口用于向商户推送授权结果,包含授权流水ID、授权状态及结果等核心业务参数。文档规定了必选的公共请求参数,如通知ID、时间戳、签名信息等,以确保通信安全。商户系统接收通知后,需同步返回“success”或“fail”标识处理结果。若处理失败,系统将启动重试机制,在25小时内进行最多8次通知投递,间隔频率逐渐增加,以确保消息触达。 - [反向开票订单业务转账授权申请接口](https://opendocs.alipay.com/mini/0jo3sl.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.biztransferauth.apply`(反向开票订单业务转账授权申请)。该接口支持第三方代调用,用于服务商申请业务费用转账授权并由企业确认。请求需提供企业税号(`tax_no`)和企业转账账户ID(`company_account_id`)两个必选参数。成功调用后,接口返回授权流水ID(`auth_id`)、授权链接(`auth_url`)及授权状态(`auth_status`)。文档提供了Java、PHP、C#和HTTP的请求示例,并列出了系统繁忙、参数有误、产品未开通、税号不匹配等常见业务错误码及其解决方案。 ###### 商品管理 - [税收分类编码分页查询接口](https://opendocs.alipay.com/mini/0hdmgq.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.taxcategory.batchquery`,用于分页查询税收分类编码信息,支持第三方代理调用。接口请求需包含企业税号(tax_no)和产品ID(product_id)两个必选业务参数。文档提供了Java、PHP、C#及HTTP等多种语言的调用示例,展示了SDK初始化、参数构建及请求执行流程。响应结果包含税收分类编码列表,详细列出编码、父级编码、商品名称、类目名称及描述。此外,文档还列举了系统繁忙、参数有误、企业不存在、产品未开通等常见业务错误码及其解决方案,帮助开发者快速定位并解决问题。 - [商品库新增商品信息接口](https://opendocs.alipay.com/mini/0hdmh3.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.item.create`,用于在商品库中新增商品信息,支持第三方代理调用。接口要求必填外部商品ID、企业税号、税收分类编码、产品ID、商品名称及单位等参数。新增成功返回商品ID,失败则返回具体原因。文档提供了详细的公共与业务请求参数说明,包含Java、PHP、C#及HTTP的代码示例,并列举了参数校验、企业状态、并发冲突及税收编码异常等多种业务错误码及其解决方案,辅助开发者正确接入。 - [商品库修改商品信息接口](https://opendocs.alipay.com/mini/0hdmgv.md): 本文档介绍了支付宝接口`alipay.commerce.ec.recyclinginvoice.item.modify`,用于修改商品库中已存在的商品信息。该接口支持第三方代理调用,允许修改商品名称、单位及规格型号(支持置空)。文档详细定义了公共请求参数(如app_id、签名、时间戳)及业务必选参数(企业税号、产品ID、商品ID等),并提供了Java、PHP、C#及HTTP的请求示例。响应包含成功标识或错误码。错误处理涵盖系统异常、参数非法、企业或商品不存在、并发冲突及权限问题等多种场景,文档为每种错误提供了具体的排查建议。 - [商品库删除商品信息接口](https://opendocs.alipay.com/mini/0hdmh2.md): 本文档介绍了支付宝接口 `alipay.commerce.ec.recyclinginvoice.item.delete`,用于在商品库中删除商品信息,支持第三方代理调用。接口请求需配置公共参数和业务参数,核心必填业务参数为商品ID(`company_item_id`)和企业税号(`tax_no`)。文档提供了Java、PHP、C#及HTTP的请求示例,详细展示了SDK初始化、参数封装及调用过程。响应方面,文档列出了正常与异常响应格式,并针对系统繁忙、参数错误、企业或商品不存在、权限不足、税号不匹配及产品未开通等业务错误码给出了具体的解决方案,帮助开发者顺利接入与调试。 - [商品库分页商品信息接口](https://opendocs.alipay.com/mini/0hdmgk.md): 本文档详细介绍了支付宝接口 `alipay.commerce.ec.recyclinginvoice.item.batchquery`,用于分页查询商品库信息,支持第三方代理调用。接口要求提供页码、页大小及企业税号作为必选参数,支持按商品ID、名称或税收编码筛选。响应包含分页详情及商品列表(含ID、名称、规格、单位等)。文档提供了Java、PHP、C#和HTTP的请求示例,并定义了系统繁忙、参数有误、企业不存在等业务错误码及其解决方案。 - [常见问题](https://opendocs.alipay.com/mini/0h6ont.md): 本文档主要阐述了企业开通反向开票产品的相关要求与建议。文档明确指出,企业必须使用经过认证的支付宝企业账户作为开通前提。此外,为了确保后续交易的顺畅进行,文档强烈建议企业完成交易打款认证。此举旨在有效预防后续业务中可能出现的交易限额受限及风控拦截等问题,从而保障企业资金流转的安全与高效,确保业务流程的合规性与稳定性。 - [更新日志](https://opendocs.alipay.com/mini/0h6onu.md): 文档记录了平台接口与功能的三次关键更新。2026年4月新增企业营业员批量查询及变更通知接口,实现了对企业下营业员信息的批量获取与变更实时同步。2026年2月上线报废产品收购场景下的自然人开票额度查询接口,支持查询过去12个月的历史数据。2025年7月全面开放“反向开票”功能,明确了由购买方(企业)代替销售方(个人)开具发票的特殊业务逻辑,进一步完善了税务与企业管理能力。 ### 支付宝小程序备案 - [支付宝小程序电脑端备案操作指引](https://opendocs.alipay.com/mini/0apo6l.md): 本文档详细说明了支付宝小程序备案的操作流程与法规依据。依据《反电信网络诈骗法》等法规,境内小程序主办者必须履行备案手续。备案类型涵盖新增、接入、变更及注销四种。用户可通过商家平台或开放平台入口提交申请,流程包括信息填写、平台初审、工信部短信核验、管局审核及结果反馈。文档重点阐述了主体信息(个人/非个人)、小程序信息及负责人信息的填写规范,强调了证件照上传标准、名称合规性、前置审批要求及人脸核验等关键环节。审核通过后,平台将自动展示备案号,未备案小程序不得从事互联网信息服务。 - [支付宝小程序移动端备案操作指引](https://opendocs.alipay.com/mini/0bnpvl.md): 本文档主要介绍了支付宝小程序手机端备案的操作流程与规范。备案流程包括信息填写、平台初审、工信部短信核验、管局审核及结果反馈五个环节。备案前需准备主办单位证件、负责人身份证件等材料,图片需符合格式与尺寸要求,涉及特殊行业需提供前置审批文件。用户需使用管理员账号登录支付宝App进入备案入口,如实填写主体、小程序及负责人信息,部分情况需上传授权书或承诺书。文档特别强调了短信核验需在24小时内完成及备案成功后编号的自动展示规则,指引商家合规完成备案。 - [备案材料及对应质量标准](https://opendocs.alipay.com/mini/0b3if6.md): 本文档详细规定了小程序备案所需的材料明细、证件标准及操作规范。文档明确了主办单位及负责人需提交的证件类型,要求所有证件有效期需大于3个月。核心内容涵盖前置审批流程,重点详述了金融、教育、医疗等特殊行业的资质要求,并针对不同省份制定了差异化的互联网金融关键词审查规则。此外,文档还规定了负责人授权书提交条件、照片与人脸核验质量标准、跨境电商与教育类服务的特殊说明,以及部分省份(如湖北、宁夏)的个性化备案要求,确保备案流程的合规性。 - [小程序备案接口使用指南](https://opendocs.alipay.com/mini/0bbpim.md): 本文档为小程序备案接口对接的操作指引,详细说明了备案流程、接口调用规范及注意事项。备案流程主要包含商家材料上传、人脸核验和备案提交三个核心环节。文档明确了材料上传的图片格式与大小要求,以及人脸核验的触发方式、消息接收逻辑和有效期规定。在备案提交阶段,文中详细阐述了主体信息、小程序信息及负责人信息的填写规范,特别强调了不同省份对授权书的要求、工信部短信核验的时效性以及备注内容的填写标准。此外,文档还介绍了备案提交后的审核流程、撤销备案的条件以及建议服务商优先接入的最快场景,旨在帮助服务商高效、准确地完成备案接口开发与对接工作。 - [备案常见问答](https://opendocs.alipay.com/mini/0apo6m.md): 本文档旨在指导支付宝小程序开发者完成ICP备案工作。根据工信部规定,小程序主办者必须履行备案手续,未备案者将面临标注、限制更新、屏蔽或下架等处置。备案入口位于支付宝开放平台控制台,企业和个人需分别准备相应证件,特定行业需提供前置审批文件。文档详细说明了备案流程、材料规范、审核时效,并针对图片上传、负责人规则、各地管局政策差异、人脸核验及短信校验等常见问题提供了解答。此外,文档还列出了备案期间的官方外呼号码,并阐述了注销备案的三种类型及其具体影响,提醒开发者合理安排时间以保障小程序正常运营。 - [工信部短信核验专题](https://opendocs.alipay.com/mini/0apty3.md): 本文档详细说明了小程序备案的短信核验逻辑及常见问题处理。短信核验规则依据备案场景而定:新增备案需验证主体和小程序负责人手机号;新增服务备案仅需验证主体负责人手机号;新增接入备案需验证工信部预留的小程序负责人手机号;若变更主体信息则需验证双负责人手机号。针对收不到短信或验证失败,主要原因为手机号不匹配,建议核对场景规则、使用移动网络或检查手机拦截。此外,文档针对“验证库无记录”、“链接打不开”及“校验码错误”等常见问题提供了具体的排查步骤与解决方案,如核对号码提交状态、直接访问工信部系统或按序重新验证等。 - [工信部常见驳回指引](https://opendocs.alipay.com/mini/0apvyw.md): 该文档主要针对支付宝小程序备案过程中的常见驳回问题提供解决方案。内容涵盖短信核验失败的原因及补救措施,公安与工商接口证件核验不通过的处理步骤,以及主办者冲突、名称重复等备案冲突的解决方法。同时,详细说明了金融、游戏等特殊行业的前置审批材料要求,广东、重庆等特定省份的备案规范,及负责人授权、人脸核验等操作细节。此外,文档明确了个人主体备案的限制及社保证明要求,指导用户通过核对信息、补充材料或调整类目等方式解决备案障碍,确保顺利通过监管审核。 - [平台审核驳回指引](https://opendocs.alipay.com/mini/0csvpl.md): 本文档针对支付宝小程序备案审核中的常见问题提供了详细的修正指引。核心内容包括:一是规范经营证照与人脸核验图片质量,要求照片清晰、完整、无遮挡,严禁使用复印件或PS件,人脸核验需在严肃环境下进行;二是明确小程序备注填写规则,特别是天津地区需严格按照格式声明紧急电话使用人信息;三是细化地址填写要求,需精确到门牌号且避免重复行政区划;四是说明承诺书与授权书的提交标准,区分广东地区承诺书上传要求及非法人担任负责人的授权规定;五是强调前置审批证件需清晰且含红章。该文档旨在指导用户严格按照规范修改材料,确保备案顺利通过。 ## 工具 ### 概述 - [开发工具概述](https://opendocs.alipay.com/mini/02c7i6.md): 本文档介绍了支付宝开放平台为辅助开发者高效管理应用而提供的一系列 SDK、开发及监控工具。核心工具涵盖研发、搭建与质检三大类:包括支持多端发布的一站式“小程序开发者工具”、适配持续集成的“小程序 CLI”及低代码搭建工具“支搭”。质量保障方面,重点介绍了运行时全面检测的“全息检测”、上线前自动体检的“质检助手”以及实时故障监控的“质量监控中心”。此外,还提及了量化评估应用质量的“小程序分”和 VSCode 插件。这些工具共同构建了完善的研发生态,有效提升小程序的开发效率、质量标准与用户体验。 ### 小程序开发者工具 - [概述](https://opendocs.alipay.com/mini/006l2y.md): 支付宝小程序开发者工具是支付宝开放平台打造的一站式研发工具,集成了编码、调试、测试、上传及项目管理等全流程功能。该工具不仅支持支付宝小程序开发,代码还通用于蚂蚁开放生态,可发布至钉钉、高德等平台。文档按开发流程详细介绍了各阶段功能:开发准备阶段支持项目创建与管理;编码阶段提供模拟器预览、代码补全及扩展插件;调试阶段包含模拟器、真机预览及远程断点调试;测试阶段提供预检测与体验版测试服务。此外,工具还支持一键上传及Git、npm管理,助力开发者高效研发。 #### 界面 - [启动界面](https://opendocs.alipay.com/mini/006l34.md): 本文档介绍了小程序开发者工具(IDE)启动界面的操作指南。主要功能包括新建、打开及删除项目记录。新建项目前需确认发布端,项目类型分为示例模板和空白脚手架两类:示例模板提供入门、UI等四类代码示例;空白脚手架包含基础文件结构,支持配置后端服务。打开项目可通过选择最近项目或选择本地项目文件夹两种方式。此外,用户可右键删除启动界面的项目记录,该操作仅清理显示记录,不删除硬盘源文件。 - [主界面](https://opendocs.alipay.com/mini/006l38.md): 小程序开发者工具主界面由菜单栏、工具栏、功能面板、编辑器、调试器和模拟器六大核心模块组成。菜单栏提供文件、编辑等基础操作;工具栏支持项目类型切换、界面区域显隐控制及真机调试预览;功能面板集成了文件树、搜索、Git与NPM管理等边栏功能;编辑器用于代码编写;调试器支持模拟器与真机调试;模拟器则用于快速预览和初步调试。界面支持灵活布局,但编辑器与调试器无法同时隐藏。 - [工具栏](https://opendocs.alipay.com/mini/006l3c.md): 本文档介绍了小程序开发者工具(IDE)顶部工具栏的功能布局。工具栏分为左、中、右三部分:左侧用于配置运行环境、关联小程序及云开发环境;中部控制编辑器、调试器和模拟器的显隐;右侧集成了核心操作功能,包括自定义编译模式、清除缓存、真机调试与预览、代码上传、项目详情配置及账号登录。其中,详情页支持基础库版本切换、域名白名单设置及编译语法检查,上传功能确保版本号唯一递增,整体工具栏为开发者提供了从编码、调试 to 发布的一站式操作入口。 - [模拟器](https://opendocs.alipay.com/mini/006l3f.md): 本文档详细介绍了小程序开发工具中模拟器的功能与操作。模拟器支持编译后自动运行,通过鼠标模拟触控交互,并可设置代码保存时自动刷新。界面布局默认位于右侧,支持切换至左侧或独立窗口显示。顶部工具栏提供设备尺寸选择、缩放控制、刷新及日志查看等功能,内置苹果、华为等9大品牌50种机型皮肤,支持多种屏幕类型模拟。底部显示页面路径与参数。此外,模拟器提供丰富的小工具,支持模拟首页键、定位、扫码、摇一摇、WebView调试、权限管理、截屏、内存警告及网络状态等场景,助力开发者高效调试。 #### 代码编辑 - [编码](https://opendocs.alipay.com/mini/006l3i.md): 本文介绍了小程序开发者工具在基础功能之外提供的旨在提高编码效率的定制功能。核心内容包括三个方面:一是实时预览,支持在编辑并保存axml、acss、js、json文件后,模拟器即时呈现编译效果;二是AXML自动补全,能在编写AXML文件时自动补全成对标签,减少编排错误;三是API自动补全与语法提示,可在编码时实时提供API选项及语法建议。这些功能共同简化了开发流程,提升了开发效率。 - [Git 管理](https://opendocs.alipay.com/mini/006l4l.md): 该文档介绍了小程序 IDE 中可视化 Git 管理工具的使用方法。自 1.0 版本起,该功能更名为 SCM,操作保持不变。文档详细阐述了代码管理的四个核心步骤:首先是初始化 Git 仓库,用于项目目录无仓库的情况;其次是暂存更改,支持一键全选或单个文件暂存;接着是提交更改,将暂存内容提交至本地并支持查看文件差异;最后是推送到远端仓库,通过添加远程地址实现代码推送。该工具旨在通过可视化界面简化 Git 操作流程。 - [TypeScript 和 Less 编译](https://opendocs.alipay.com/mini/02zko2.md): 文档介绍了小程序开发者工具对 TypeScript 和 Less 的支持情况。自 IDE 3.0.0 和 CLI 1.4.0 起,开发者可使用 TypeScript 和 Less 替代 JavaScript 和 ACSS,以提升编码体验,但目前仅支持支付宝项目。创建新项目可通过 IDE 选择对应模板或 CLI 选择 TypeScript 脚手架实现。对于旧项目迁移,需修改 mini.project.json 开启编译配置,在 package.json 中添加 @mini-types/alipay 类型定义依赖,并配置 tsconfig.json 文件。完成配置后即可进行开发,需注意编译使用的 TypeScript 版本固定为 4.6.3。 #### 代码调试 - [IDE 调试](https://opendocs.alipay.com/mini/006l3q.md): 本文档介绍了小程序开发IDE提供的三种调试方式:模拟器加调试工具、手机端调试面板及远程调试。建议开发者优先使用模拟器进行基础功能与样式调试,其支持设备模拟与API自定义,配合定制版Chrome devtool可实现元素、日志、缓存及网络等维度的排查。真机预览时,可通过调试面板查看日志、缓存、网络请求及页面数据。远程调试则通过连接IDE与手机,支持断点调试、运行时检查及远程日志查看。文档强调最终运行效果以真机为准。 - [真机调试](https://opendocs.alipay.com/mini/006l3t.md): 本文档介绍了小程序真机调试功能的使用方法与环境要求。该功能需IDE 0.24.3-beta.0及支付宝客户端10.1.38以上版本支持。开发者可通过IDE进行远程断点调试、查看AXML结构与样式、监控网络与存储及查看运行日志。文档强调了使用限制:必须采用HTTPS链接并配置域名白名单;体验版不支持IP接口;代码修改后需重新连接调试。操作流程包括选择自动推送或扫码建立连接、在Source面板设置断点及进行断点调试。 - [联调设置](https://opendocs.alipay.com/mini/00tvl8.md): 小程序联调设置功能旨在解决开发调试时的跳转问题,允许开发者在模拟其他小程序、页面入口或扫码跳转场景时,强制跳转至指定的开发版本而非默认的线上版本。该功能需支付宝客户端 10.1.95 及以上版本支持,且仅对当前设置账号生效,不影响线上用户。设置方法为进入小程序开发版,通过右上角菜单开启“联调设置”开关。需注意,同一小程序仅一个开发版开关可生效,关闭后即恢复默认跳转线上版本。 #### 性能分析 - [概述](https://opendocs.alipay.com/mini/06iqj8.md): 本文档阐述了小程序性能分析的重要意义、核心作用及相关工具指标。性能分析旨在了解运行状况、发现问题并优化体验。性能优化主要具有两大作用:一是通过提升速度、优化渲染和资源使用来增强用户体验;二是通过降低流失率来提高小程序的转化率。文档还指出了需关注的FP、FCP、LCP等关键性能指标,并推荐使用开发者工具内置的性能分析面板进行数据录制与报告查看,以便定位代码阻塞点并参考案例进行针对性优化。 - [性能指标](https://opendocs.alipay.com/mini/06igfx.md): 本文档主要阐述了小程序首屏耗时的概念及其关键渲染指标。首屏耗时指页面首次渲染满屏内容的时间,直接影响用户体验与留存,其核心要素包含“首次”、“渲染”、“满屏”及“内容”四个维度。文档详细定义了从小程序加载到页面展示过程中的四个关键性能指标:FP(首次绘制)、FCP(首次有内容绘制)、LCP(最大有内容绘制)及FMP(首次有意义绘制)。此外,还明确了FCP中“内容”的具体范畴,以及判定“页面加载结束”的三种标准,包括页面状态改变、用户交互或10秒内无新内容出现。 ##### 分析工具 - [概述](https://opendocs.alipay.com/mini/06itk0.md): sperma - [数据录制](https://opendocs.alipay.com/mini/06ikay.md): 该文档详细说明了小程序性能分析工具的使用流程。首先需完成准备工作:检查IDE版本(需3.4.3及以上)、确认支付宝客户端版本(建议10.3.10以上)并启用基础库2.0构建。录制时,在IDE点击“性能分析”生成二维码,手机扫码打开小程序。系统会在用户交互、页面失焦或绘制完成时自动上报数据,IDE端同步显示页面路径与获取时间。测试结束后,点击“停止收集”按钮即可完成数据采集。 - [报告查看](https://opendocs.alipay.com/mini/06ikaz.md): 文档介绍了IDE中小程序性能分析面板的使用方法与核心功能。该面板提供八大模块:支持鼠标与键盘快捷键操作的时间轴缩放;按时间顺序展示资源加载详情的网络请求分析;可视化界面骨架绘制过程的渲染帧功能;标记FP、FCP、LCP、FMP等关键启动节点的性能指标;展示渲染层脚本的渲染指令分析;包含框架注入与跨进程通信的逻辑层事件分析;以及用于查看API耗时的接口调用功能。此外,面板底部的摘要与事件日志区域可详细反馈选中标签的具体信息与耗时数据,辅助开发者精准定位性能问题。 - [报告分析](https://opendocs.alipay.com/mini/06is1y.md): 该文档详细介绍了小程序性能分析报告的功能与使用方法。报告涵盖网络请求、渲染帧、性能指标、逻辑层及接口调用等数据,面板采用分层“轨道”展示,支持时间轴同步分析。文档重点阐述了逻辑层事件分析,区分了任务(如框架启动、定时器回调)与事件(如生命周期、setData)类型,并解析了数据批处理流程。此外,介绍了代码堆栈分析、渲染帧变化查看、API接口调用细节及网络请求分析功能。特别强调了异步调用链分析,帮助开发者追踪前序事件,定位耗时瓶颈,有效优化代码性能。 - [分析案例](https://opendocs.alipay.com/mini/06iqj9.md): 本文档介绍了利用性能分析工具优化小程序代码的方法,针对三种常见阻塞场景提出了具体建议。首先,针对API接口串行与频繁调用,建议使用Promise.all实现并行请求,并对接口结果进行缓存或使用细粒度API替代。其次,针对频繁调用setData导致的卡顿,建议精简传输数据体积,合并连续调用以减少跨进程通信开销。最后,在代码注入方面,建议开启按需注入与插件懒加载特性,避免非必要代码的注入与执行,从而有效提升小程序启动速度并降低内存占用。 #### 代码发布 - [打包上传](https://opendocs.alipay.com/mini/006l43.md): 本文档介绍了小程序代码上传至开放平台的完整流程及注意事项。开发者需在本地项目关联后台小程序后,通过工具栏进行上传,系统将自动递增版本号。文档强调了资源限制,建议使用URL链接减少包体大小,并指出仅支持图片上传。核心配置方面,详细说明了服务器域名白名单的设置要求,明确上传后的版本仅能访问已备案的HTTPS白名单域名。此外,针对整包过大、托管小程序权限限制及图片上传报错等常见问题,文档提供了相应的解决方案,如分包加载、第三方接口构建及检查域名配置等。 - [体验版测试](https://opendocs.alipay.com/mini/00939f.md): 本文档介绍了小程序开发完成后生成体验版本的流程,主要包括设置体验人员、设置体验版及开始测试三个步骤。首先,管理员需在成员管理中添加体验成员(上限50人,开发成员默认具备权限),成员需在客户端确认加入。其次,在开发管理中选择相应版本设置为体验版并生成二维码。最后,体验人员使用支付宝客户端扫码即可进行测试。文档特别提示,体验版不支持开启调试功能,且无法查看运行日志。 - [设置](https://opendocs.alipay.com/mini/006l4d.md): 该文档主要介绍了软件系统中四项核心功能的配置入口与操作方法。所有操作均通过界面左下角的设置图标发起。具体功能包括:一是快捷键设置,允许用户自定义按键映射;二是系统设置,提供系统相关参数的调整功能;三是颜色主题设置,支持在“浅色”与“深色”两种视觉模式间切换;四是文件图标主题设置,用于更改文件图标的显示风格。文档旨在指导用户通过统一入口快速访问并个性化配置系统界面与操作习惯。 #### 开发辅助 - [IDE Lite](https://opendocs.alipay.com/mini/01yuyj.md): IDE Lite 是一种功能集中、简约高性能的开发模式,支持与任意代码编辑器协同使用,尤其适配 VS Code 扩展。该功能需 IDE 1.19 及以上版本,可通过项目列表右键或顶部菜单“窗口”选项切换进入。若端侧不支持,系统会提示原因。退出模式可通过菜单或项目配置按钮实现。Lite 模式专注调试,隐藏编辑器,支持全屏、Mac 分屏及窗口置顶,并将上传、清除缓存等低频功能整合至项目配置中,旨在提供更纯粹的调试体验。 - [智能研发](https://opendocs.alipay.com/mini/0i42tx.md): 支付宝小程序开发者工具(IDE)迎来智能化升级,旨在提升开发效率。该功能需IDE 3.9.92及以上版本支持,新增五大核心能力:代码生成、错误排查、代码解释、JSAPI/组件使用指引及代码补全。开发者可通过AI助手输入需求生成代码,利用错误排查功能定位问题,或选中代码查看详细解释。此外,工具支持咨询接口用法及自动代码补全。用户可在编辑器左侧菜单开启智能研发会话,亦可在设置中随时关闭此功能,全方位辅助小程序开发。 - [智能转换](https://opendocs.alipay.com/mini/0iauvz.md): 小程序开发者工具(IDE)推出的“智能转换”功能,利用AI技术实现了从其他框架小程序代码向支付宝小程序项目的一键转换。该功能支持前端代码转换,需IDE 3.10.5及以上版本。用户通过设定原项目与新项目路径发起任务,系统在独立文件夹中生成转换后的工程,不影响原文件。转换过程中需保持网络畅通,AI将逐文件处理并展示进度,支持失败重试。转换完成后,用户可查看代码修改对比,进行服务端适配与功能验证,最终实现版本构建与发布上架。 - [VS Code 扩展](https://opendocs.alipay.com/mini/01yrrz.md): 本文档介绍了支付宝小程序 VS Code 官方插件“Alipay Mini Program Support”。该插件已上架 VS Code 扩展市场,提供语法高亮、组件与 JSAPI 补全、AXML 代码检查与格式化、变量定义跳转及右键新建页面组件等功能。用户可在扩展面板搜索“Alipay Mini Program Support”或“alipay.minicode”进行安装。使用时,插件支持 axml 组件和 snippets 自动补全、API 补全与悬停提示,并能通过文件树右键快速创建页面或组件,有效提升开发效率。 - [快速预览&调试](https://opendocs.alipay.com/mini/01ysmz.md): 该文档介绍了小程序开发者工具(IDE)提供的“快速模式”。这是一种旨在大幅减少构建耗时的加速模式,其产物与原预览产物基本一致,但不支持分包功能。使用上,IDE 2.1版本支持全端真机预览及基础库2.0以上的真机调试,IDE 2.0版本仅支持支付宝端预览。该模式依赖模拟器运行,若模拟器关闭将自动降级为普通模式。操作时需在真机调试面板勾选快速模式。由于该模式仅推送整包,导致无法查看分包大小,需关闭该模式方能查看细分包体信息。 - [包依赖分析工具](https://opendocs.alipay.com/mini/09tgx7.md): 自小程序开发者工具3.8.3版本起,新增包依赖分析功能,支持对真机预览和模拟器代码进行依赖关系与体积分析,助力优化小程序包体。用户可通过模拟器顶部按钮或真机预览码下方入口开启该功能。工具以矩阵树形图展示编译后的包体积构成,通过颜色区分不同模块,并支持悬停查看依赖详情。用户可利用快捷键打开依赖关系图,查看模块的具体依赖、独占体积及文件位置,支持视角跳转与层级展开。需注意,展示体积受编译选项影响可能与上传限制有差异,模拟器分析需清除缓存以解决静态资源统计误差,且插件项目目前仅支持分析插件本身。 - [NPM 包管理](https://opendocs.alipay.com/mini/006l4i.md): 该文档介绍了在 IDE 中管理 npm 依赖的方法。在目录管理方面,IDE 会根据 package.json 文件自动创建默认目录,若无默认目录,用户可点击右上角加号手动添加。在依赖管理方面,支持三种操作:一是安装指定依赖,用户需区分用于生产环境的运行依赖和仅用于开发环境的开发依赖,输入包名回车即可安装;二是点击右上角图标一键安装全部依赖;三是点击删除图标移除特定依赖。 - [开发者助手](https://opendocs.alipay.com/mini/006l4u.md): 开发者助手(原开发者中心)是小程序移动端管理工具,提供首页管理、社区交流、消息通知及等级权益四大核心功能。用户通过支付宝扫码或搜索即可使用。在快捷管理方面,支持小程序版本的全生命周期管理,包括版本查看、提审、灰度发布及上架回滚;提供成员权限管理与用户故障反馈查看。社区板块支持开发者互动与官方答疑,积极贡献者可申请成为问答官。消息中心聚合了审核、系统、互动等多类通知。此外,开发者可通过完成任务提升开发值,获取相应等级权益,实现技能与权益的双重提升。 - [代码静态检查](https://opendocs.alipay.com/mini/00asbs.md): 本文档介绍了小程序代码静态检查扩展的功能与使用方法。该工具通过静态分析手段对axml、js、acss等文件进行全面检查,旨在提升代码质量并确保符合研发规范。其核心优势在于检查标准与支付宝审核一致,支持全代码类型覆盖及ESLint等业界标准工具。功能上,它支持项目全量扫描和单文件实时扫描,并提供灵活的规则配置,允许开发者根据需求调整规则级别或开启特定检查(如无障碍适配)。此外,工具还具备互投扫描能力,可检测JSAPI在支付宝、高德等不同客户端的兼容性,有效帮助开发者规避代码隐患,提升审核通过率。 #### 开发者工具下载 - [开发者工具下载](https://opendocs.alipay.com/mini/006l6m.md): 该文档提供了小程序开发工具的下载指引与版本列表。文档建议在桌面电脑端下载,并列出了最新版本与历史版本的获取方式。最新版本包含 v3.11.0 Beta 测试版和 v3.10.15 稳定版,历史版本则收录了 v3.10.5 稳定版。针对不同操作系统,文档提供了 Windows 10/11(64位)及 MacOS 的安装包选项。特别地,MacOS 版本详细区分了适配 Intel 芯片的 x64 版本和适配 M1、M2、M3、M4 芯片的 arm64 版本,用户可根据设备配置精准选择对应版本,并可查阅更新日志了解详细信息。 - [Beta 版更新日志](https://opendocs.alipay.com/mini/02uhrw.md): 文档为支付宝小程序开发工具多版更新日志(3.11.0 Beta至2.9 Beta),记录了功能新增、优化及问题修复。最新3.11.0版本更新了默认基础库并修复了国际化及预览码生成问题。近几个版本重点强化了AI助手(新增报错诊断、上下文管理),引入项目“受限模式”,并大幅提升了对小游戏(尤其是Unity小游戏)及开发调试(如横屏模拟、局域网调试)的支持。整体持续完善模拟器功能(新增机型、API模拟)、优化编译性能,并修复了大量平台兼容性与稳定性问题。 - [稳定版更新日志](https://opendocs.alipay.com/mini/01qemg.md): 该文档记录了支付宝小程序开发者工具从2021年至2026年的版本更新日志。核心更新聚焦于智能化研发与小游戏支持,新增AI助手功能,提供代码诊断、智能补全及框架转换能力,并全面支持Unity小游戏开发与调试。模拟器能力显著增强,适配iPhone新机型,支持横屏及隐私授权模拟,同时优化了TypeScript/Less编译、热更新机制及真机调试效率。此外,工具在版本管理、插件开发及多端适配(如M系列芯片)方面均有重要迭代,并修复了大量涉及API表现、UI交互及编译性能的问题,大幅提升了开发体验与稳定性。 - [历史更新日志](https://opendocs.alipay.com/mini/006l6g.md): 该文档是小程序开发工具的版本更新日志,记录了从2017年至2021年初的版本迭代。核心更新包括推出IDE Lite模式以支持外部编辑器配合开发,引入可视化辅助编程与新内核提升编码体验。工具拓展了多端研发能力,覆盖支付宝、优酷、UC、IoT及口碑商家等平台。功能方面,新增全息检测、性能调试与预审核机制强化质量监控;深度集成云开发服务,支持云函数、云应用及Serverless管理。此外,还涵盖了对Git和NPM的支持、沙箱环境、模拟器性能优化及大量稳定性修复,旨在全面提效小程序研发流程。 - [IDE 常见问题](https://opendocs.alipay.com/mini/0094jx.md): 本文档主要汇总了小程序开发过程中的常见问题及解决方案,涵盖开发工具、调试打包与上传三个环节。开发工具部分涉及IDE配置、二维码解析限制、登录异常处理及Windows环境下的安装与蓝屏故障修复;调试打包部分重点分析了真机与模拟器的差异,包括网络请求、API支持、域名白名单配置及日志显示问题的排查;打包上传部分则阐述了node_modules处理规则、版本更新机制及第三方授权错误应对。文档旨在为开发者提供全流程的技术故障排查指南,确保开发与发布顺利进行。 ### 小程序 CLI - [小程序 CLI 产品介绍](https://opendocs.alipay.com/mini/02q17h.md): 小程序CLI是一款轻量级开发套件,主要服务于轻量场景的小程序研发及持续集成、持续交付。其核心特色包括:提供简洁的命令式开发体验,支持通过命令快速进行真机预览与调试;支持Node.js API调用,便于开发者编写脚本进行自动化操作;内置Web版轻量模拟器及调试器,可供本地简单预览调试,但功能受浏览器限制与IDE略有差异。此外,文档还提供了开发者社区和钉钉群等技术支持渠道,帮助用户解决使用问题。 #### 基本使用 - [快速开始](https://opendocs.alipay.com/mini/02q17j.md): 本文档介绍了小程序开发工具 minidev 的安装与使用流程。首先需安装 Node 16及以上环境,通过 npm 全局安装 minidev 并使用 login 指令完成支付宝扫码授权。开发时,利用 create 指令创建项目,通过 dev 指令启动开发服务器,支持源码变动自动构建,并可启动 web 模拟器或 IDE Lite 模式进行调试。真机预览需在项目目录执行 preview 指令并指定 APPID,生成的二维码可供支付宝客户端扫描查验。开发完成后,使用 upload 指令将代码上传至开放平台进行提审,文档同时也提供了工具更新及更多指令参考的指引。 - [调用方式](https://opendocs.alipay.com/mini/02q17l.md): 文档介绍了支付宝小程序开发工具的两种调用方式:CLI命令行与Node.js API。CLI工具通过`minidev`指令提供构建、编译、预览、调试及上传等功能,支持通过参数指定项目目录。Node.js API方式更加灵活,便于集成至不同流程,文档提供了调用预览接口的代码示例。两者在功能上相互对应,开发者可依据实际场景自由选择使用。 #### 指令列表 - [指令列表概览](https://opendocs.alipay.com/mini/02q29z.md): 该文档主要介绍了小程序开发及CLI工具管理的命令行指令功能。小程序开发部分涵盖了项目创建、启动开发服务器与开发者工具、源码构建、真机预览调试,以及代码上传、提审和取消审核等全生命周期操作指令。CLI工具管理部分则详细说明了配置信息的设置与查看、资源文件下载以及登录功能。这些指令共同构成了小程序开发与运维的完整工具体系。 ##### 小程序开发 - [app 小程序信息管理](https://opendocs.alipay.com/mini/02s70k.md): 本文档介绍了用于请求开放平台的小程序管理工具,支持CLI和Node.js API两种调用方式。使用前需完成快速授权或指定身份密钥路径。核心功能包括:获取小程序列表(含应用ID、名称及类型);查询指定小程序的最新上传版本或全量版本列表,支持按状态筛选和分页,覆盖开发、审核、上架等多种状态;删除指定版本,若为体验版会自动取消;以及设置和取消小程序体验版,设置成功后可获取体验版二维码地址。所有接口均支持指定端类型等通用参数。 - [build 编译小程序](https://opendocs.alipay.com/mini/02q17m.md): 该文档介绍了 minidev 工具的 build 命令,其核心功能是将小程序源码构建为运行时产物包。文档提供了 CLI指令和 Node.js API 两种调用方式。CLI 支持配置缓存路径、压缩、输出路径、插件 ID 及 SourceMap 等选项。参数说明详细阐述了各配置项:project 指定项目目录;cacheDir 设定缓存路径;minify 控制产物压缩,默认关闭;output 设定输出路径,默认为系统临时目录;sourceMap 默认开启以支持调试。开发者可根据需求灵活配置构建流程。 - [create 新建小程序](https://opendocs.alipay.com/mini/02q998.md): 本文档介绍了用于创建小程序项目的工具指令及API。该工具支持新建空白小程序和空白小程序插件两类项目,默认将当前工作目录作为父级目录。文档提供了CLI命令行和Node.js API两种调用方式,并详细说明了四个核心参数:`type`用于指定项目类型(小程序或插件),`name`定义文件夹名称,`parentDir`设定存放路径,`skipConfirm`用于跳过交互确认。不同调用方式下部分参数的默认值有所差异,如API默认创建小程序,CLI默认询问用户。 ###### dev 启动开发服务器 - [dev 概述](https://opendocs.alipay.com/mini/02q17n.md): 本文档介绍了小程序开发服务器 DevServer 的功能与使用方法。DevServer 通过持续监听源码目录文件变更,实时编译并启动 HTTP 服务,有效减少完整编译耗时,提升开发效率。文档详细阐述了 CLI命令行和 Node.js API 两种调用方式,列举了包括热更新 (HMR)、端口配置、TypeScript/Less 编译支持、多进程编译等核心参数选项。此外,还说明了编译完成后可执行 IDE 调试、真机预览等后续指令,支持参数提前输入以简化操作,并对关键参数如缓存路径、产物压缩及 SourceMap 的配置细节进行了详细说明。 - [ide 打开开发者工具(DevServer)](https://opendocs.alipay.com/mini/02q17o.md): 本文档说明了启动 DevServer 后使用 IDE 调试小程序的方法。支持 CLI 和 Node.js API 两种调用方式:CLI 需在运行 `minidev dev` 后输入 `ide` 指令;API 则调用 `startIdeForDevServer` 方法。文档详细解析了 `appPath`(IDE安装路径)、`projectType`(项目类型)和 `lite`(Lite模式)三个关键参数,指出若未指定路径将尝试自动查找,项目类型默认为支付宝小程序。此外,文档还提供了包含钉钉、高德、优酷等在内的 40 余种小程序项目类型 ID 列表,供开发者在配置时按需选用。 - [preview 真机预览(DevServer)](https://opendocs.alipay.com/mini/02q2a2.md): 该文档介绍了小程序开发中的“快速真机预览”功能。该功能基于开发服务器的模拟器产物运行,无需重新构建,从而实现更快的真机预览速度。文档指出了两项使用限制:需完成授权或指定密钥文件;仅支持整包预览,无法验证分包功能。调用方式支持CLI指令和Node.js API两种。文档详细说明了appId、clientType、identityKeyPath、autoPush等关键参数的类型与用途,帮助开发者配置预览行为。 - [remote-debug 真机调试 (DevServer)](https://opendocs.alipay.com/mini/02q17p.md): 本文档介绍了基于模拟器产物进行快速真机调试的功能。该功能无需重新构建,速度较快,但仅支持整包调试,无法验证分包功能,且需完成工具授权或指定密钥文件。文档提供了CLI和Node.js API两种调用方式,并详细说明了参数配置,包括指定AppID、目标端类型、密钥路径、自动推送、忽略域名校验、设置页面路径与参数、场景值及自动开启调试工具等选项,旨在帮助开发者高效进行真机调试。 - [web Web 模拟器](https://opendocs.alipay.com/mini/02q17s.md): 本文档介绍了在启动开发服务器后运行 Web 版调试器和模拟器的两种调用方式:CLI 命令行和 Node.js API。CLI 方式需在执行 `minidev dev` 后输入 `web` 指令,支持配置自动打开、应用 ID、入口页面、页面参数及场景值等选项。Node.js API 方式通过 `minidev.devWebSimulator` 方法调用,返回集成或分离的模拟器与调试器地址。文档详细说明了各参数的类型、默认值及具体用法,为开发者提供了灵活的调试环境配置指导。 - [ide 启动小程序开发者工具](https://opendocs.alipay.com/mini/02q3ak.md): 本文档介绍了启动小程序开发者工具的方法,明确要求工具版本需在2.3及以上。文档提供了CLI和Node.js API两种调用方式:CLI通过`minidev ide`指令执行,支持指定IDE路径、Lite模式、项目类型等参数;Node.js API通过`minidev.startIde`方法调用。文档详细说明了`appPath`(安装路径)、`projectType`(项目类型)和`lite`(Lite模式)参数的定义与默认值。此外,列举了支付宝、钉钉、高德、口碑、菜鸟、优酷等数十种小程序项目类型的ID,供开发者配置使用。 - [preview 真机预览](https://opendocs.alipay.com/mini/02q3al.md): 该文档介绍了构建小程序并发起真机预览的方法及参数配置。使用前需完成快速授权或指定身份密钥文件。文档提供了CLI指令和Node.js API两种调用方式。CLI通过 `minidev preview` 命令执行,支持配置应用ID、端类型、入口页面、参数及忽略域名校验等选项。Node.js API通过 `minidev.preview` 方法实现相同功能。执行成功后,系统将返回预览二维码供手机扫描,或自动推送小程序至客户端。文档详细说明了appId、clientType、autoPush等关键参数的含义与用法。 - [remote-debug 真机调试](https://opendocs.alipay.com/mini/02q3am.md): 本文档介绍了使用支付宝小程序CLI和Node.js API构建并发起小程序真机调试的方法。使用前需完成快速授权或指定身份密钥路径。运行后,CLI会构建真机调试版并发布至平台,返回二维码供手机App扫码查看,部分端支持自动推送。同时,CLI会输出浏览器调试链接。文档详细说明了CLI指令格式及Node.js API调用示例,并解释了关键参数:appId用于指定应用ID(必填),clientType指定目标端,autoPush控制自动推送,ignoreHttpDomainCheck等参数用于忽略域名校验,以及page、query等参数用于模拟页面路径、参数和场景值,帮助开发者高效进行真机调试。 - [upload 上传项目](https://opendocs.alipay.com/mini/02q3an.md): 本文档介绍了小程序项目版本上传功能的操作指南,旨在支持提审流程。使用该功能需完成快速授权或指定身份密钥文件。文档提供了CLI命令行与Node.js API两种调用方式,核心操作包含指定应用ID(必填)、项目路径、版本号及版本描述等参数。其中,版本号需遵循x.y.z数字格式,若未指定则系统自动基于最新版本递增。此外,开发者可通过参数配置在上传成功后自动将版本设置为体验版。文档详细列出了各参数的类型、默认值及使用限制,为开发者提供了明确的接口调用规范。 - [audit 提审小程序](https://opendocs.alipay.com/mini/0a3ehy.md): 该文档介绍了用于提审小程序的 minidev 工具。使用前需完成快速授权或指定密钥路径,且仅应用管理员及以上角色密钥生效。工具支持 CLI 命令行和 Node.js API 两种调用方式。核心操作需提供小程序 APPID、版本号及版本截图等必填参数,并支持配置自动上架、测试账号、端类型等可选项。文档详细说明了各参数的类型、限制及用法,帮助开发者实现小程序审核提交的自动化配置。 - [cancel-audit 取消提审小程序](https://opendocs.alipay.com/mini/0a2ywr.md): 该文档介绍了用于取消小程序提审的 minidev 工具的使用方法。使用前需完成快速授权或指定密钥文件,且仅应用管理员及以上角色有权操作。文档提供了 CLI 命令行和 Node.js API 两种调用方式。CLI核心指令为 `minidev cancel-audit`,必填参数为版本号和应用ID,可选参数包括端类型和身份密钥路径等。Node.js API 通过 `minidev.cancelAudit` 方法调用。文档详细说明了各参数的类型与要求,强调版本号必须符合 x.y.z 数字格式。 ##### CLI 工具管理 - [config 配置 CLI](https://opendocs.alipay.com/mini/02q3ap.md): 本文档介绍了 minidev 的配置管理功能,主要用于设置和展示配置信息。核心功能包括 `set`(设置配置值)和 `get`(获取配置值)两个基础指令。文档详细说明了通过 CLI 命令行和 Node.js API 两种调用方式的具体用法、参数及选项。CLI 模式下支持通过参数设置作用域和目标项目路径;Node.js API 模式下除基础存取方法外,还支持 `useRuntime` 方法注入运行时配置。参数说明部分阐明了 `scope` 参数用于区分全局或项目级设置,`project` 参数用于指定目标项目目录。 - [download-assets 下载 CLI 资源](https://opendocs.alipay.com/mini/02pzeh.md): 本文档介绍了支付宝小程序 CLI (minidev) 的离线资源下载功能。该指令用于下载 CLI 运行所需的资源文件,默认保存于用户目录下的 `.minidev/assets` 文件夹,且重复执行时默认跳过已下载文件。文档说明了 minidev 在安装时自动下载资源的机制,并建议离线环境用户手动执行带 `--with-compiler` 参数的指令以确保离线可用。文还提供了 CLI 命令行调用方式及 Node.js API 示例,并详细解释了 `cleanPrevious`(清除重下)和 `withCompiler`(同时下载构建器)两个关键参数的作用与配置方法。 - [login 授权 CLI 工具](https://opendocs.alipay.com/mini/02q3ao.md): 本文档主要介绍了通过 minidev 进行工具快捷授权的两种调用方式。第一种是 CLI 方式,通过执行 `minidev login` 指令完成授权操作。第二种是 Node.js API 方式,调用 `minidev.login()` 方法,该方法返回 Promise 对象,并通过回调函数获取 loginTask 实例。借助 loginTask,开发者可以监听二维码生成、轮询状态、用户扫码以及授权成功等关键事件,从而实现对授权流程的精细化控制与状态反馈。 #### 使用场景 - [开发工具密钥](https://opendocs.alipay.com/mini/02q29w.md): 支付宝小程序开发工具CLI在进行应用管理、调试及上传等功能时需依赖开发工具密钥。密钥获取包含两种方式:一是通过命令行执行`minidev login`自动在本地生成;二是登录开放平台网页手动生成并下载。密钥文件为JSON格式,包含工具ID和私钥。文档强调同一用户同一时刻仅有一份密钥有效,新操作会导致旧密钥失效。针对CI/CD等多机器场景,建议通过分发配置文件、设置环境变量或使用Node.js API注入授权信息,避免重复登录导致密钥失效。 - [端类型](https://opendocs.alipay.com/mini/02q29x.md): 该文档介绍了小程序开发指令中端类型的配置方法。开发者在使用 `preview`、`remote-debug` 及 `upload` 指令时,可通过传入 `clientType` 参数来指定端类型,以适配不同平台的小程序开发。文档详细列举了当前支持的12种端类型,涵盖了支付宝、高德地图、天猫精灵、阿里车、UC浏览器、夸克浏览器、口碑、菜鸟等,涉及移动应用、车载系统、智能设备及医疗物流等多个场景。该参数设置确保了小程序在多端环境下的预览、调试与上传功能顺利实现。 - [工具配置](https://opendocs.alipay.com/mini/02q3aq.md): 支付宝小程序 CLI 配置项采用键值对存储,支持字符串、布尔值或 JSON Object 类型,可通过指令进行读写。配置项支持 JSON 对象的解构与聚合,允许使用点号分隔或嵌套对象形式定义。工具实行四级配置管理,优先级从高到低依次为 RUNTIME、PROJECT、GLOBAL 和 DEFAULT,上级配置覆盖下级。此外,支持通过环境变量修改 RUNTIME 配置,或在 Node.js API 中使用 `useDefaults` 和 `minidev.config.useRuntime` 分别设置默认与运行时配置。 - [使用代理](https://opendocs.alipay.com/mini/02pzei.md): 文档介绍了支付宝小程序命令行工具(CLI)的代理配置功能。CLI支持通过环境变量`HTTPS_PROXY`和`HTTP_PROXY`分别为HTTPS和HTTP请求设置代理。用户可在执行命令(如预览)时直接指定代理地址。此外,CLI不仅支持HTTP代理,还兼容Socks代理,满足不同网络环境下的调试需求。 - [沙箱环境](https://opendocs.alipay.com/mini/02q3ar.md): 该文档介绍了支付宝小程序CLI在沙箱环境下的使用方法。核心操作是在执行命令时传入`MINIDEV_ENV=sandbox`环境变量,文档同时提供了具体的预览命令示例。此外,文档指出了一项关键限制:由于沙箱环境与生产环境的支付宝APP授权信息独立存储,用户在沙箱环境下调试时需要重新进行授权操作,无法复用生产环境的授权状态。 - [支持的场景值](https://opendocs.alipay.com/mini/02q3as.md): 本文档介绍了小程序 CLI工具中 `preview` 和 `remote-debug` 指令支持通过传入 `channelId` 参数来模拟小程序场景值的功能。该功能目前仅限于支付宝客户端使用,其他端传入无效。文档详细列举了支持的场景值列表,包括场景值名称、ID 及说明。涵盖的场景主要包括首页宫格、朋友栏入口、搜索结果、扫码、分享消息卡片、模版消息、生活号、小程序互跳、系统桌面以及城市服务、芝麻信用、车主服务、医疗服务等各类支付宝内置服务频道,还包括第三方 APP 打开等共计二十余种场景,为开发者调试不同入口的逻辑提供了标准参数参考。 - [更新日志](https://opendocs.alipay.com/mini/02q29v.md): 文档记录了支付宝小程序CLI工具(minidev)从1.1.0至2.0.6版本的更新日志。核心更新包括:CLI 2.0大版本升级了构建核心、模拟器与调试器,支持全局对象策略与ES5转码配置,并要求Node版本不低于16。功能方面,陆续新增了小游戏分包构建、网络错误TraceId透出、云构建日志显示,以及支持通过身份密钥路径进行真机预览、调试与上传。同时,修复了包括dev模式无法停止、真机预览异常、Windows路径错误在内的多项Bug,优化了系统稳定性与开发体验。 ### 支搭 #### 支搭 - [支搭介绍](https://opendocs.alipay.com/mini/0f9xx0.md): 文档介绍了“支搭”这一小程序搭建工具。该工具通过图形化界面与拖拉拽组件的操作方式,使用户无需编写代码即可快速构建小程序。文档展示了其搭建能力,并提供了“搭建线上卖货小程序”和“搭建家政预约等留资小程序”两个快速开始的场景指引,旨在帮助用户高效完成不同类型小程序的构建工作。 - [更新日志](https://opendocs.alipay.com/mini/0g2sob.md): 文档记录了2025年上半年支付宝低代码小程序平台的更新动态。核心更新包括:新增美甲预约与家政模板,升级租赁及电商模板,支持线上邮寄、批量发货等功能;重磅上线支付组件与四大广告组件,简化收款接入与流量变现流程;编辑器全面焕新,优化视觉交互,新增数据管理、公式编辑器及搭建指引功能。整体更新显著提升了小程序的搭建效率与商业化运营能力。 #### 搭建逻辑复杂的行业小程序 ##### 搭建线上卖货小程序 - [功能介绍](https://opendocs.alipay.com/mini/0fzjn7.md): 该文档介绍了电商小程序模板的核心功能与使用规范。模板旨在连接用户与商家,支持用户在线浏览商品、选择规格下单、填写地址邮寄及申请售后;商家端则具备商品信息配置、优惠券管理、订单处理及售后支持等功能。值得注意的是,当前模板仅支持线上发货,暂不支持门店自提与核销,且支持商品同步至公域商品库。使用门槛要求账号主体必须为企业或个体工商户,小程序需具备“购物”类目资质,特定商品类目需提交相应经营资质,确保了平台的合规性与标准化运营。 - [搭建流程](https://opendocs.alipay.com/mini/0e8z7m.md): 本文档介绍了支付宝小程序支搭项目的创建、搭建与运营全流程。首先,用户需在开放平台创建小程序,选择电商模板并开通云环境。其次,搭建流程涵盖商品管理、编辑器配置及发布。用户需配置首页、分类页和详情页,包括Banner、商品展示及购物车等功能,完成后经过预览、检测、构建及审核即可上架。最后,运营管理包括商品投放公域、订单与售后处理、消息通知设置(如钉钉Webhook)、邮费模板管理、员工权限配置及客服设置等,帮助商家高效管理小程序后台数据与业务。 #### 搭建简单小程序 - [功能介绍](https://opendocs.alipay.com/mini/0fzb8m.md): 支搭是一款无代码应用开发平台,旨在帮助用户在无技术背景下通过组件拖拽快速构建复杂业务应用。平台具备上手门槛低、开发周期短、配置管理便捷等优势,支持多种组件、公式计算及丰富场景模板,满足个性化需求。主要应用场景涵盖官网介绍、信息聚合展示及预约类小程序。其编辑器界面布局清晰,分为顶部操作区、左侧面板区、中部可视化画布及右侧配置区,提供从属性设置到数据源管理的全流程支持,有效提升团队开发效率,赋能企业经营。 ##### 小程序开发流程 - [创建项目](https://opendocs.alipay.com/mini/0fzb8o.md): 本文档主要介绍了在支付宝开放平台创建小程序并使用模板搭建项目的完整流程。首先,用户需登录控制台,填写名称并绑定商家账号以创建小程序。随后,在总览页点击“去搭建”进入项目创建环节。在模板选择阶段,用户可查看详情并选用合适模板。最后,通过支付宝扫码绑定云环境以开启服务端能力,刷新确认后即可完成创建。文档还提供了家政预约和美甲预约模板的关联参考。 - [搭建小程序](https://opendocs.alipay.com/mini/0fzft1.md): 文档介绍了小程序搭建平台的核心功能模块,旨在帮助用户通过实践完成大部分业务场景的小程序搭建。核心功能涵盖八大模块:应用设置用于配置基本信息;页面设置管理页面属性;搭建指引提供全链路状态查看;画布与大纲树支持可视化页面设计;数据管理处理前端用户数据;动作与事件配置交互行为;公式编辑器支持函数计算;变量列表统一管理变量。这些模块共同构成了小程序开发的基础工具体系。 - [预览与发布](https://opendocs.alipay.com/mini/0fzcfk.md): 本文档主要介绍了小程序搭建完成后的预览与发布流程。在预览阶段,开发者可通过编辑器右上角的“预览”按钮进行模拟器预览或使用支付宝App扫码进行真机预览,且支持添加成员协同测试。在发布阶段,预览无误后需点击“发布”进行版本构建并提审,随后在控制台的版本管理中提交上架审核,审核通过后即可正式发布。 ##### 模板介绍 - [家政预约模板](https://opendocs.alipay.com/mini/0gguea.md): 本文档介绍了一款家政预约模板,旨在通过小程序端收集预约信息并由后台统一管理。该模板基于展示型组件、表单型组件及公式编辑器构建核心能力。业务场景涵盖用户端的预约页面与管理端的后台系统,主要功能是便捷收集客户信息并助力商家快速获客,为家政服务行业提供了完整的线上预约解决方案。 - [美甲预约模板](https://opendocs.alipay.com/mini/0haysw.md): 本文档介绍了一款美甲预约小程序模板,旨在帮助商家实现从服务展示、预约到核销的完整业务流程。该模板具备多页面联动、表单留资及管理后台等核心能力,支持门店、服务和预约记录的综合管理。文档详细说明了操作流程:首先在编辑器中选中组件并跳转后台配置数据;其次通过搭建预览或真机预览检查页面效果,其中真机预览需扫码体验真实数据;最后,用户端与管理端均可对预约记录进行查看与管理,分别支持取消预约和记录管理功能。 ##### 小程序页面搭建 - [应用设置](https://opendocs.alipay.com/mini/0fzuvv.md): 本文档介绍了应用配置功能,旨在协助搭建者调整应用参数以适应不同环境和业务需求。核心功能包含应用信息查看、全局配置及云环境绑定。用户点击左下角图标即可查看项目小程序信息。在全局配置中,可自定义底部导航栏的颜色与栏目数量,且每个栏目须配置名称及对应页面。文档特别提示,配置在Tabbar中的页面不可通过“跳转链接”访问,仅支持Tabbar切换,以避免冲突。此外,支持通过扫码或刷新绑定云环境,并可在多环境间进行选择。 - [页面配置](https://opendocs.alipay.com/mini/0fzwy0.md): 本文档主要介绍编辑器的页面管理功能,支持搭建者进行多页面的创建、配置及删除操作。用户可在编辑器顶部点击“+”号,基于空白页或展示类、表单类模板快速创建页面。通过顶部的“页面切换”下拉列表,用户可查看、搜索并选择页面。选中页面后,可在右侧面板配置主题色、布局、外观及生命周期。利用列表内的快捷操作,用户还能对页面进行重命名、设为首页及删除(需二次确认),实现了对应用页面的高效管理与维护。 - [搭建指引](https://opendocs.alipay.com/mini/0ggydc.md): 本文档主要介绍了小程序搭建指引的功能概述及面板操作方法。该功能旨在通过可视化的流程展示,帮助用户直观掌握从“准备工作”到“小程序发布上架”各阶段的状态,以便进行针对性调整。在面板操作方面,用户点击右上角图标即可打开指引面板,系统通过绿色和红色标识分别显示状态的正常与异常。面板还提供三个核心功能按钮:“重新检测”用于刷新步骤状态,“去绑定”用于扫码关联云环境,“去管理”则用于跳转至版本管理页面。 - [画布与大纲树](https://opendocs.alipay.com/mini/0fzlyr.md): 本文档主要介绍画布和大纲树的功能与操作说明。画布是开发者设计页面布局的核心工作区域,支持放置文本、图片等UI元素。其底部快捷操作区提供组件选择、只读模式切换及画布缩放功能。大纲树位于编辑器左侧,用于展示页面组件结构。用户选中组件时,画布会高亮显示且配置面板同步切换。支持通过右键菜单对组件进行删除或重命名,但需注意删除父组件会连带删除嵌套的子组件,操作需谨慎。 - [数据管理](https://opendocs.alipay.com/mini/0h0xhx.md): 本文档主要介绍小程序管理中心的定义、入口及操作功能。管理中心是小程序上架后进行长期数据管理的平台,支持搭建和运维阶段使用,并允许配置运营成员代管理。用户可通过控制台总览页或编辑器顶部进入。平台提供完整的数据管理功能,包括切换菜单栏目、点击按钮新增数据、通过字段筛选查询数据、进入详情页编辑数据以及带二次确认的删除操作。此外,支持员工管理,主账号可添加或更换员工,赋予项目管理员查看和管理数据的权限。 - [公式编辑器](https://opendocs.alipay.com/mini/0ggzn1.md): 文档介绍了系统公式功能的应用方法,旨在通过计算字段值保障数据准确性与提升效率。用户可在右侧属性面板点击“Fx”开启公式编辑。公式面板包含函数区、变量区和代码区,支持搜索、新增变量、代码编写、校验提示及全屏复制。文档详细说明了基础运算符(如加减乘除、比较运算)及七种常用函数的语法与用法,包括文本拼接(CONCAT)、空值判断(ISEMPTY)、长度计算(LEN)、文本截取(SLICE)、集合取值(GET)、日期转换(DATETEXT)及条件运算(IF),并提供了具体的参数定义与应用示例。 - [变量列表](https://opendocs.alipay.com/mini/0fzxst.md): 本文档介绍了变量功能的核心概念、配置方法及使用方式。变量用于处理页面的数据获取、转换与状态管理,定义于特定范围内。新增变量时需设置不可修改的类型,系统将在使用阶段强制校验,并支持通过Mock值在编辑器中模拟数据。使用时,可通过组件配置面板的“fx”按钮进行绑定,支持表达式、固定值、自定义变量和表单变量四种形式。 - [动作与事件](https://opendocs.alipay.com/mini/0fzrhq.md): 本文档介绍了小程序开发中构建交互逻辑的核心概念:动作和事件。首先说明了“是否显示”属性用于控制组件运行时的可见性。接着详细阐述了“行为动作”配置,以按钮为例,支持点击触发“跳转链接”、“变量赋值”和“加载远程变量”。重点解析了“跳转链接”功能,包括应用内跳转和跳转外部小程序的配置方法、参数设定及路径规范。文档特别指出,已配置在应用底部Tabbar中的页面无法通过跳转链接访问,只能通过Tabbar切换,以避免交互冲突。 ###### 组件 - [组件总览](https://opendocs.alipay.com/mini/0fzz76.md): 该文档详细介绍了“支搭”平台提供的小程序搭建组件库,旨在帮助用户构建多样化的界面。组件被划分为六大类:布局组件支持复杂结构与数据循环展示;展示组件涵盖文本、图片、轮播图、表格及按钮等,用于内容呈现与交互;输入组件提供搜索功能;导航组件支持视图切换;表单组件包括各类输入、选择、上传及评分控件,用于数据收集;业务组件则集成了多种广告形式、支付功能及服务门店列表,满足商业化需求。这些组件共同构成了搭建小程序的核心工具集。 - [容器](https://opendocs.alipay.com/mini/0fzkyw.md): 本文档介绍了“普通容器”组件的功能与用法。普通容器主要用于页面布局,将页面分隔为独立逻辑单元,支持多样化外观配置。常规用法涵盖内部组件的横向与纵向布局、滚动设置、对齐方式调整及区块管理。文档详细列举了属性配置,包括控制溢出显示的常用配置、控制可见性与点击事件的交互属性、支持固定与自适应的尺寸设置、定义间距与排列方向的布局属性,以及包含背景、边框、圆角和阴影的外观属性。该组件通过灵活配置实现了页面结构的有效管理。 - [循环容器](https://opendocs.alipay.com/mini/0fz906.md): 本文档介绍了循环容器组件,其核心功能是支持配置数据源,对数组类型数据进行循环展示。与普通容器不同,它允许内部组件通过数据域共享数据。常规用法包括创建数组变量、绑定数据源及配置内部组件属性,支持item变量提示,但目前暂不支持嵌套。文档详细列出了其属性配置:包括数据源绑定、交互显隐与点击事件;尺寸支持固定与自适应;布局涵盖边距、堆叠方向及主副轴对齐方式;外观支持字体、背景、边框、圆角及阴影等详细样式设置,为动态列表渲染提供了完整的解决方案。 - [文本](https://opendocs.alipay.com/mini/0fzo2d.md): 本文档介绍了小程序中的文本组件,这是一个用于文字内容编辑与展示的工具。常规用法涵盖纯文本展示和多行文本省略号设置。组件属性主要包含常用配置、交互、尺寸、布局和外观五个部分。常用配置支持文本内容与最大行数设置;交互属性控制组件显隐及点击事件;尺寸属性支持固定值或内容适配,单位默认转换为rpx;布局属性包含内边距与外边距;外观属性支持详细的字体样式、背景、边框及圆角配置,满足多样化的文本展示需求。 - [图片](https://opendocs.alipay.com/mini/0fzpiq.md): 本文档详细介绍了小程序图片组件的功能与配置。该组件核心用途是展示图片,支持图片上传及渐进加载以优化性能。组件提供拉伸、适合、铺满三种填充模式,并具备交互、尺寸、布局及外观等丰富属性配置。用户可自定义组件的显示与点击事件,通过rpx单位设置宽高以适配不同机型,还能灵活调整外边距、背景、边框及圆角样式,满足多样化的界面展示需求。 - [图标](https://opendocs.alipay.com/mini/0h1407.md): 本文档介绍了一款用于展示语义化矢量图形的图标组件,支持用户从 iconfont 图标库中选择图标。使用时,用户需将组件拖入画布,并通过配置面板进行模糊搜索或点选图标。文档详细说明了组件的属性配置:常用配置支持填充设置;交互属性支持控制组件在预览和发布时的显示与隐藏;外观属性提供了详细的字体样式设置,包括颜色、字号、字重、行高、字间距、水平与垂直对齐方式,以及斜体、下划线等修饰样式,并对各项参数的默认值和取值范围进行了明确界定。 - [轮播图](https://opendocs.alipay.com/mini/0fzpir.md): 本文档介绍了小程序营销场景中常用的轮播图组件,该组件主要用于展示多张图片并支持页面跳转。文档涵盖了组件概述、常规用法及详细的属性配置说明。核心功能包括图片轮播展示、样式修改、跳转配置及图片管理。属性配置方面,详细列举了数据源、指示器、循环与自动播放、时间间隔等常用设置,以及交互显示控制、尺寸定义(支持rpx单位)、布局内外边距调整和外观样式(背景、边框、圆角)的自定义。开发者可通过配置面板灵活调整组件的展示效果与交互逻辑,以满足多样化的营销需求。 - [表格](https://opendocs.alipay.com/mini/0fzuvw.md): 本文档详细介绍了数据表格组件的功能与配置方法。数据表格用于以行列结构有序展示数组数据,核心用法是通过列配置的“唯一标识”与数据源字段键名进行匹配,以实现数据的正确读取。文档重点解析了五大属性配置板块:常用配置支持普通或斑马风格,定义列标题、宽度及颜色;交互属性控制组件显隐;尺寸属性支持固定值或自适应高度;布局属性调整内外边距;外观属性涵盖背景、边框样式及圆角设置,所有尺寸单位均采用rpx。 - [步骤条](https://opendocs.alipay.com/mini/0g00km.md): 本文档介绍了步骤条组件的定义、用法及配置属性。步骤条组件用于展示任务流程和当前进度,引导用户分步完成任务。用户可动态增减步骤项,单独配置标题与描述。核心属性配置涵盖五个方面:常用配置支持步骤数据编辑、当前步骤高亮、水平/垂直方向切换及点状/序号类型选择;交互属性控制组件显隐及点击事件;尺寸与布局属性支持固定或自适应宽高及内外边距调节;外观属性提供详尽的字体样式、背景填充、边框设置及圆角调节,尺寸单位默认采用适配小程序的rpx。 - [按钮](https://opendocs.alipay.com/mini/0fztwg.md): 该文档详细介绍了按钮组件的定义、用法及属性配置。按钮用于标记操作命令,响应点击行为,主要样式包括主要、次要、危险、禁用和文本五种,分别对应不同的交互场景。文档重点阐述了常用配置、交互逻辑、尺寸设置、布局参数及外观样式。尺寸支持固定与适配模式,采用rpx单位;外观支持字体、背景、边框及圆角的深度定制。该指南为开发者提供了完整的配置参考,确保组件在功能与视觉上的灵活实现。 - [城市](https://opendocs.alipay.com/mini/0fzkyx.md): 该文档介绍了一款用于收集和展示地理位置信息的城市选择组件。该组件目前仅支持城市选择功能,使用时需创建包含城市代码、名称及经纬度的对象类型数据源,并通过属性面板进行绑定。文档详细说明了组件的各项属性配置,包括数据源的绑定格式、交互行为(显示隐藏与值改变事件)、尺寸设置(固定与适配模式)、布局调整(内外边距)以及外观样式(字体、背景、边框、圆角)。通过这些配置,用户可实现对组件功能、布局与视觉效果的灵活控制,满足不同场景下的交互需求。 - [入群](https://opendocs.alipay.com/mini/0fzlys.md): 本文档介绍了入群组件,该组件主要用于营销场景引流,点击后跳转私域群,常用于商家粉丝群推广。组件需配置在商家平台工作台获取的进群链接。文档详细说明了组件的五大属性配置:常用配置(标题、图标、按钮文案、链接)、交互(显隐、点击事件)、尺寸(固定/自适应,单位rpx)、布局(内外边距)以及外观(字体、背景、边框、圆角)。外观设置支持字体颜色、大小、字重、对齐方式等多种样式,以及背景图、边框类型和圆角调整,满足个性化展示需求。 - [搜索](https://opendocs.alipay.com/mini/0g01e1.md): 本文档介绍了搜索组件的定义、用法及属性配置。搜索组件集成了输入框、搜索按钮和结果展示功能,支持关键词检索与条件筛选。常规用法需结合字符类型数据源,通过创建并绑定变量实现用户输入值的同步与后续数据请求。属性配置涵盖常用配置、交互、尺寸、布局和外观五大类。常用配置包括提示文本、默认值及清除按钮设置;交互支持显隐控制及值改变或确定时的动作触发;尺寸与布局支持固定或自适应设置,采用rpx单位;外观支持字体样式、背景、边框及圆角的详细定制,满足多样化界面需求。 - [选项卡](https://opendocs.alipay.com/mini/0fzkyy.md): 该文档全面介绍了选项卡组件的功能定义与配置方法。选项卡组件主要用于分类展示内容面板,支持分栏管理、组件拖入、标题切换及动态新增栏目。属性配置涵盖五大维度:常用配置支持样式类型(胶囊、文本、混合)及默认选中设置;交互属性控制组件显示状态;尺寸属性支持固定数值与内容自适应,并采用rpx单位适配小程序;布局属性可调整内外边距;外观属性提供背景、边框、圆角及阴影的精细定制,满足多样化界面设计需求。 - [文本输入](https://opendocs.alipay.com/mini/0gh107.md): 文档介绍了文本输入组件的功能与配置。该组件允许用户在文本框内输入及编辑文字,支持键盘输入、编辑操作、光标定位及占位符显示。组件属性分为常用配置、交互与尺寸三部分。常用配置包括标题、默认值、占位提示、组件状态(普通、只读、禁用)及必填校验设置。交互属性控制组件在发布时的显示与隐藏。尺寸属性支持固定宽高设置,并在小程序端自动转换为rpx单位以适应不同机型屏幕。整体功能完善,适用于各类表单填写场景。 - [数值输入](https://opendocs.alipay.com/mini/0gh2g3.md): 该文档介绍了一个数值输入框组件,主要用于用户输入和编辑数字。常规用法支持键盘输入、粘贴复制等编辑操作、光标定位及占位符显示。组件属性配置丰富:常用配置包括标题、默认值、数值范围限制、数据格式(数值或百分比)、状态(普通、只读、禁用)及必填校验;交互属性支持控制组件显隐;尺寸属性支持设定宽高,并在小程序中自动转换为rpx单位以适配屏幕。该组件提供了完善的数值录入与校验功能。 - [单选](https://opendocs.alipay.com/mini/0gh3ws.md): 该文档介绍了一个用于单选场景的表单组件。其核心功能是在一组互斥可选项中允许用户进行唯一选择。关键配置包括:自定义标题、动态管理选项内容及排序、设置默认值。组件支持普通、只读和禁用三种状态,并具备必填校验功能以确保表单提交有效。交互上支持组件的显示与隐藏控制。尺寸方面提供固定宽高设置,并在小程序环境下自动转换为rpx自适应单位,确保在不同机型上的布局兼容性。 - [多选](https://opendocs.alipay.com/mini/0ggxkx.md): 本文档介绍了一个多选组件,用于在一组选项中进行多项选择,适用于收集用户偏好场景。文档详细说明了组件的属性配置:常用配置包括标题修改、选项的增删改排序、默认值设定、组件状态(普通、只读、禁用)及必填校验;交互配置支持组件的显示与隐藏;尺寸配置允许设置固定宽高,并说明了在小程序环境下转换为rpx单位的规则。整体内容涵盖了组件的基础定义、功能设置与样式调整,为构建多选表单提供了完整指引。 - [日期选择](https://opendocs.alipay.com/mini/0ggw9k.md): 该文档介绍了日期选择器组件,主要用于选择年、月、日,常与弹出层配合使用。用户可通过可视化日历或直接输入选择日期。组件属性涵盖常用配置、交互和尺寸三方面。常用配置包括标题、默认值、占位提示、显示格式,以及控制编辑权限的状态属性(普通、只读、禁用)和表单验证的必填属性。交互属性控制组件在发布时的显示状态。尺寸属性提供固定宽高设置,并在小程序中转换为rpx响应式单位以适配屏幕。文档全面概述了该组件的功能与配置方法。 - [上传图片](https://opendocs.alipay.com/mini/0ggw9l.md): 该文档介绍了一个图片上传组件,主要用于将图片上传至服务器,并提供文件信息展示及预览功能。组件配置包含常用配置、交互和尺寸三大类。常用配置支持自定义标题、设置上传数量上限、切换状态(普通、只读、禁用)及设定必填校验。交互属性可控制组件在发布端的显示与隐藏。尺寸属性支持固定宽高设置,数值在小程序中会转换为rpx单位,确保多机型适配,如宽度设为750可撑满屏幕。 - [开关](https://opendocs.alipay.com/mini/0gh3wt.md): 该文档详细介绍了“开关”组件的功能定义与配置属性。开关组件用于在两种状态(启用/禁用)间进行直观切换。文档核心内容涵盖五大属性模块:常用配置支持设置标题、默认值、状态(普通、只读、禁用)及必填校验;交互属性控制组件显隐;尺寸属性通过rpx单位定义宽高以适配屏幕;布局属性调整内外边距;外观属性支持自定义字体样式、背景填充、边框类型及圆角设置。这些配置为构建符合业务需求的交互控件提供了灵活支撑。 - [计数器](https://opendocs.alipay.com/mini/0ggxky.md): 该文档介绍了一种用于数值增减修改的两段式计数器组件。该组件包含输入框与调节按钮,适用于精确数值输入场景。文档详细说明了其五大属性配置:常用配置支持标题、默认值、数值范围、步长及状态(普通、只读、禁用)设定;交互属性控制组件显隐;尺寸属性定义宽高并支持rpx单位;布局属性调整内外边距;外观属性提供字体、背景、边框及圆角的精细化设置。整体内容为开发者提供了完整的组件功能定义与参数配置指南。 - [评分](https://opendocs.alipay.com/mini/0gh108.md): 该文档介绍了一个评分组件,用于展示事物评级及收集用户快速打分。用户通过点击或滑动星形图标选择分数。组件属性包含三部分:常用配置支持设置标题、默认值、最大分数,并提供普通、只读、禁用三种状态及必填校验;交互属性控制组件的显示与隐藏;尺寸属性支持固定宽高,在小程序中自动转换为rpx单位以实现屏幕适配。该组件为产品或服务评价提供了标准化的表单解决方案。 - [图文广告](https://opendocs.alipay.com/mini/0gr67h.md): 文档介绍了支付宝官方图文广告组件的功能、使用门槛及配置属性。该组件以图片模式展示广告,通过拖拽即可使用。接入前需满足准入条件,包括近30天日均UV≥100、营业执照注册资金≥10万且注册时间≥90天。同时,必须前置开通广告产品,否则预览和发布将被拦截。组件属性方面,支持自动创建展位;交互属性控制组件显隐;布局属性支持设置内外边距,单位为rpx;尺寸属性支持固定宽高,宽度设为750rpx可撑满屏幕。 - [信息流广告](https://opendocs.alipay.com/mini/0grob9.md): 该文档介绍了支付宝官方信息流广告组件的功能、用法及配置规范。该组件采用电商Feeds模式展示广告,使用时拖入即可,但需满足准入条件:近30天日均UV达100以上,且签约营业执照注册资金≥10万、注册时间≥90天。此外,必须前置开通广告产品并订购插件,否则将被拦截发布。组件支持广告展位自动创建,交互上可控制是否显示,尺寸支持固定宽高并自动转换为rpx单位,宽度设为750可撑满屏幕。 - [全屏广告](https://opendocs.alipay.com/mini/0gzj0f.md): 该文档介绍了支付宝数字推广平台的全屏广告组件。该组件支持三方广告位,用于在小程序入口或特定页面展示广告,用户可随时手动跳过或于5秒后自动跳过,使用时直接拖入组件即可。接入门槛包括准入条件和产品开通:需满足近30天日均UV达100以上,且营业执照注册资金≥10万、注册时间≥90天;同时须前置开通广告产品并订购插件,否则真机预览与发布将被拦截。组件属性中广告展位由系统自动创建。 - [插屏广告](https://opendocs.alipay.com/mini/0gzjvg.md): 本文档介绍了支付宝数字推广平台的插屏广告组件。该组件用于在小程序页面自动展现插屏广告,使用时仅需将组件拖入页面。接入该组件需满足特定门槛:小程序近30天日均UV需达100以上,且签约营业执照注册资金需≥10万、注册时间≥90天。此外,开发者必须前置开通广告产品并订购广告插件,否则将在真机预览和发布阶段被拦截。组件属性支持广告展位自动创建,简化了配置流程。 - [支付按钮](https://opendocs.alipay.com/mini/0hau1y.md): 该文档介绍了一款支付组件,旨在封装支付命令并接入JSAPI支付产品。组件支持响应用户点击触发下单,支付金额可配置为固定数值或通过公式编辑器绑定页面变量。功能上支持自定义支付状态跳转链接,并可与表单组件组合实现留资下单。数据管理方面,支付数据可在管理中心查看,支持后台退款。使用该组件需先完成JSAPI支付产品的开通,并关联当前小程序APPID,确保业务逻辑正常运行。 - [纯金额支付](https://opendocs.alipay.com/mini/0haysk.md): 本文档介绍了一款预封装的支付业务组件,旨在帮助用户通过选择或输入金额并点击支付按钮快速完成支付。常规用法包括拖入组件、配置金额选择方式(如默认选项或自定义金额)、设置备注信息以及配置支付按钮的跳转逻辑。支付数据可在管理中心查看,并支持后台退款操作。使用该组件前需满足特定门槛,即完成JSAPI支付产品的开通并将其与当前小程序AppID进行关联配置。 - [服务列表](https://opendocs.alipay.com/mini/0hez9u.md): 本文档介绍了服务列表组件的核心功能与配置操作。该组件主要用于动态绑定后台服务数据,并实现前端数据展示。配置流程主要包含三个步骤:首先将服务列表组件拖入设计界面;其次点击“配置数据”进入后台完成数据源设置,使前端能够渲染数据;最后,用户可通过左侧大纲树选中组件,根据需求自定义修改组件样式。整体操作逻辑清晰,帮助用户快速实现前后端数据关联与界面美化。 - [门店列表](https://opendocs.alipay.com/mini/0hfkkf.md): 本文档介绍了门店列表组件的功能及配置方法。该组件支持动态绑定后台门店数据,实现前端展示。配置流程分为三步:首先将组件拖入页面;其次点击“配置数据”前往后台设置数据,配置后前端即可显示;最后可通过左侧“大纲树”选择组件,根据需求自定义修改组件样式。操作简便,实现了数据管理与展示的有效联动。 ### 全息检测 - [简介](https://opendocs.alipay.com/mini/03lp13.md): 全息检测是一款针对小程序质量与体验问题的综合检测工具。它在小程序运行过程中,从性能、源码质量、稳定性及体验等多个维度进行全面分析,并提供解决方案,旨在帮助开发者发现定位问题,提高审核通过率和用户体验。该工具仅限管理员及开发体验成员使用,需支付宝客户端10.1.95及以上版本。其特色功能包括线上启动页场景复现、报告分享及非源码环境支持。操作流程涵盖选择版本、扫码实测、生成报告及保存分享。报告状态通过颜色区分严重程度,红色代表阻断审核,橙色影响体验,绿色表示通过。 - [稳定性](https://opendocs.alipay.com/mini/03liks.md): 该文档详细说明了可能导致小程序审核被驳回或存在驳回风险的问题等级及对应的优化建议。首先,文档列出了七项直接导致驳回的严重问题,包括请求异常、JSAPI调用异常、弱网白屏、页面空白率过高、web-view权限缺失、SSL证书过期及服务不可用。其次,指出了JS异常和使用废弃API两类存在驳回风险的隐患。最后,建议开发者使用HTTPS请求资源以保障安全性。开发者需根据这些等级提示进行针对性优化,以确保小程序顺利通过审核。 - [源码质量](https://opendocs.alipay.com/mini/03ldop.md): 本文档详细列出了小程序开发中可能导致审核被驳回或存在驳回风险的各类问题,依据严重程度分为“检测不通过”、“有驳回风险”及“建议改进”三个等级。首先,检测不通过项涉及16条核心规范,包括JSAPI权限验证、变量声明、语法错误(如重复键值、运算符优先级)、跨分包资源限制、组件与样式规范、生命周期管理及数据绑定规则等。其次,有驳回风险项涵盖域名配置缺失、无效页面、逻辑漏洞(如控制流误用、不可达代码)、正则表达式错误、数据设置异常及废弃API调用等。最后,文档建议避免在正则中使用特殊控制字符。开发者应据此优化代码以符合审核标准。 - [性能](https://opendocs.alipay.com/mini/03ldoq.md): 该文档详细介绍了支付宝小程序全息报告的性能分析体系,主要分为启动性能和页面性能两大类。启动性能以用户体感为核心,标准要求首页启动耗时不超过4500ms。优化手段涵盖三个层面:一是通用方案,建议升级基础库至2.x;二是代码包体积检测,限制包大小与图片体积,清理未引用资源;三是页面根因检测,通过网络请求、图片加载、JSAPI调用、setData数据交互及页面结构等多维度的具体指标(如请求数量、耗时限制、并发控制等)定位性能瓶颈。页面性能复用启动性能中的页面根因检测指标,关注非启动页的表现。文档为每项指标提供了明确的标准值和具体的优化解决方案。 - [体验](https://opendocs.alipay.com/mini/03ldor.md): 该文档主要阐述了小程序体验评估中关于HTTPS请求与图片显示的优化建议。此类问题虽不影响审核通过,但直接关系线上用户体验与用户留存。文档涵盖三个核心检测点:一是HTTPS请求资源检测,建议使用HTTPS以提升安全性,规避HTTP明文传输的内容篡改风险;二是图片加载异常检测,指出占位符存在但图片无法加载的现象会损害用户体验,应予以避免;三是保持图片大小比例检测,强调需通过设置image组件的mode属性防止图片变形,确保美观与识别度。 ### 质检助手 - [质检助手介绍](https://opendocs.alipay.com/mini/0g17ra.md): 质检助手是一款面向小程序研发阶段的自动化质检工具,旨在上线前通过“体检”发现页面功能可用性问题并提供解决方案。其核心功能涵盖三维质量审核标准、自动化触发机制及即时可视化报告。工具基于功能质量、完备度、最佳实践三个维度,利用模拟运行与UI识别算法对预设tabbar页进行检测。开发者在开发工具上传版本时,系统自动激活质检,通常在2分钟内生成详尽报告以便快速优化。目前该功能仅支持自研小程序通过开发工具上传触发,暂不支持第三方接口调用、移动端提审及CLI工具。 - [使用说明](https://opendocs.alipay.com/mini/0g1j0r.md): 本文档介绍了小程序质检助手的使用说明,旨在帮助开发者确保代码质量。主要流程包括:首先完成小程序的创建与开发;其次使用开发者工具上传版本,此时系统将自动触发异步质检,该功能默认开启且不可关闭。最后,开发者可在支付宝开放平台的版本管理页面查看结果。若质检通过,可查看详情并进行设为体验版或提交审核;若不通过,需在提审前修复问题以降低驳回风险,修复后可重新提审。 - [常见问题](https://opendocs.alipay.com/mini/0g1ki2.md): 本文档主要解答“小程序质检助手”的使用疑问。首先,该助手目前仅覆盖部分审核规则,预检通过不代表最终审核通过,结果以版本审核为准。其次,若遇误报,开发者可在报告详情页反馈后刷新页面重提;检测中通常需等待2至3分钟,超时5分钟可自动打断并提审;报告丢失可忽略。此外,开发者可通过报告详情页、平台客服或社区反馈建议。最后,助手侧重研发阶段的问题排查,与侧重上线后闭环处理的质量监控中心互为补充。 ### 小程序分 #### 小程序分 - [小程序分规则](https://opendocs.alipay.com/mini/0i4bg4.md): 文档主要阐述了支付宝小程序分的定义、评估体系及管理规则。小程序分是对商家小程序综合能力的百分制评估,涵盖性能质量、风险违规和功能完备三大维度,基于真实数据每日更新,直接影响公域推广资格。评分低于60分将面临搜索屏蔽、禁用推广等处罚,新小程序首次获分后有20天公示期以平稳过渡。针对新上架小程序设有7天观察期,低流量时按规则赋予初始分,随后转为实际数据评分。商家可在PC端开放平台查询具体分数及详情。 ### 质量监控工具 - [质量监控中心](https://opendocs.alipay.com/mini/03ldoo.md): 质量监控中心是面向小程序线上运维环节的质量管理平台,旨在针对白屏、支付异常等质量问题,提供从发现、分析到解决的闭环能力支持。平台基于实时数据监控,提供分钟级异常告警和多维度分析功能,包含性能分析、异常监控、异动管理和运维工具四大模块。功能覆盖启动与网络性能优化、14类质量问题监控、告警订阅与治理、以及挂维护、限流等运维手段。平台支持PC端和移动端访问,并详细定义了流失率、首屏耗时等性能指标及JS异常、资源异常等故障指标,助力开发者精准定位问题,保障小程序稳定运行。 ### 开发助手 - [VSCode 开发助手](https://opendocs.alipay.com/mini/030tp7.md): 该文档介绍了由支付宝官方维护的 VSCode 插件“支付宝小程序开发助手”。用户可在 VSCode 扩展市场搜索该插件名称进行安装。其核心功能包括:支持支付宝小程序 JS API 和 JSON 配置文件的代码补全与悬停提示;为 axml 和 acss 文件提供语法高亮、代码诊断、格式化、自动补全及悬停信息展示;支持通过文件树右键菜单快速新建小程序页面和组件。文档还提供了详细信息查看链接及 GitHub 问题反馈渠道。 ## 设计 ### 白皮书 - [支付宝小程序核心体验白皮书](https://opendocs.alipay.com/mini/00mry2.md): 为构建友好的支付宝生态体验,支付宝发布《小程序设计体验白皮书》,将设计体验纳入小程序综合质量考核,优质设计可获得流量等奖励。白皮书明确了六大核心设计要素:LOGO需清晰可识别;功能ICON风格应统一简洁;图片素材须高清以保证质感;严控非主动触发弹窗数量(每页上限1个);导航配置需合理,适配深浅配色方案;页面体验需保证视觉统一、动效适度(单屏不超2个)、缺省状态完善及排版合理。不符合标准的页面将影响评分并面临下架风险。 ### 设计指南 - [导航:架构清晰,指引明确](https://opendocs.alipay.com/mini/00mpje.md): 本文档介绍了小程序框架提供的统一页面导航能力,主要包含顶部导航栏和底部标签栏两部分。顶部导航栏默认由框架提供,不支持自定义位置和样式,但提供深浅两套配色方案,并具备菜单操作、关闭退出及返回等交互功能;在调用位置、录音或蓝牙等权限时,会动态显示状态图标。底部标签栏用于首页导航切换,固定于屏幕底部,支持2至5项配置。开发者可自定义底部标签栏的图标、文字及背景颜色,但需严格遵守icon输出标准以防变形,并确保界面的可读性与可用性。 - [界面:明辨主次,重点明确](https://opendocs.alipay.com/mini/00mpjf.md): 文档阐述了页面设计的核心原则,主张根据内容重要性设计主次关系,以帮助用户快速获取信息并减少干扰。首先,设计需确保信息层级清晰,使用户能辨析主次信息,控制层级数量并有效拉开层次差距。其次,界面操作应保持清晰,旨在辅助用户快速理解,剔除与决策无关的干扰因素,从而提升用户体验与决策效率。 - [流程:流程明确,避免打扰](https://opendocs.alipay.com/mini/00mry3.md): 本文档旨在指导开发者优化用户体验,核心原则是确保用户操作流程的流畅性,避免目标流程之外的内容打断用户。具体措施包括:严格控制首页弹窗数量在1个以内,且授权弹窗应在相应业务节点弹出,而非进入首页时立即弹出,以防阻断用户使用核心服务。此外,文档强调体验需流畅以防用户分心,并要求交互设计符合用户预期,杜绝预期外事项造成的干扰,从而保障用户连贯、高效地完成操作目标。 - [引导:操作向导,降低成本](https://opendocs.alipay.com/mini/00mpjg.md): 本文档主要阐述了用户引导提示的设计目标与应用分类。引导提示旨在培养用户操作习惯及指导功能使用,确保用户在不中断操作的前提下完成任务。文档详细介绍了五种引导形式:标签式引导通过强化界面元素提供提示;遮罩式引导利用页面遮罩进行新功能教学,以帮助用户上手并降低出错率;模态式引导涉及支付宝小程序跳转,建议减少使用频次以保障体验;上滑式引导专用于授权场景;嵌入式引导则适用于不影响用户的弱引导场景。 - [反馈:反馈及时,减少焦虑](https://opendocs.alipay.com/mini/00mry4.md): 本文档规范了支付宝小程序的反馈设计准则,旨在通过及时反馈舒缓用户等待情绪并明确操作结果。加载反馈分为启动页(展示品牌,样式统一)、下拉加载(整体刷新)、局部加载(针对性强,干扰小)及模态加载(全屏覆盖,需慎用)四种形式。结果反馈遵循单一显示原则,依据强弱程度分为:轻量级且自动消失的消息提示框、用于重要状态确认的模态对话框、包含官方与业务入口的扩展功能面板,以及用于流程终点或重要反馈的全屏结果页。设计者需依据具体场景选择适配样式。 - [容错:用户可控,来去自由](https://opendocs.alipay.com/mini/00mqu3.md): 本文档规定了界面设计中异常状态的处理原则与分类,核心在于出现异常时需向用户提供明确的状态提示与解决方案,以缓解负面情绪并提供帮助。文档详细划分了三种提示类型:一是轻提示报错,包含顶部告知、操作区提示及对话框引导,适用于表单填写等场景;二是全局异常提示,针对网络或服务器故障,提供处理按钮;三是局部异常提示,用于页面特定区块的异常反馈。这些规范旨在通过清晰的反馈机制确保用户操作有路可退,提升整体用户体验。 - [文案:简单易懂,友好礼貌](https://opendocs.alipay.com/mini/00murg.md): 文档主要阐述了文案沟通的核心原则,指出文案风格应秉持简单、一致和普适的特点。在用词选择上,要求使用用户熟悉且易于理解的词汇,严格避免使用专业用语。文档强调,文案设计的最终目标是确保界面文字清晰简洁,从而有效避免用户产生误解,提升沟通效率与用户体验。 ### 视觉规范 #### 小程序设计规范 - [小程序 LOGO](https://opendocs.alipay.com/mini/00mpjh.md): 该文档规定了支付宝小程序Logo的设计规范与要求。Logo在支付宝首页等场景以圆形展现,实际展示尺寸为56px,需保证清晰与可识别性。设计上要求主体完整不被裁切,单体元素建议占比72%,图片主体需在特定辅助线内;允许图形化文字但禁用图文上下组合,背景不可有轮廓。安全方面,Logo须原创无法律风险,严禁侵权、低俗、政治倾向内容及二维码,不得使用红点、认证等标签。此外,平台提供Logo生成工具辅助设计。 - [服务 ICON](https://opendocs.alipay.com/mini/00mqu4.md): 该文档规定了小程序图标的设计规范与输出要求。图标设计需简洁、辨识度高,并在同一服务主体下保持风格一致,广泛应用于小程序私域、搜索及公域展示场景。输出规格方面,单位统一为像素,核心图形标准尺寸为106px,最大不超过130px;背景须为圆形且撑满180*180px。安全性方面,图标须原创且无法律风险,严禁出现黄赌毒、烟草及政治倾向内容,禁止使用红点、NEW等营销标记,不得使用二维码或“认证”等属性标签。 - [图片素材](https://opendocs.alipay.com/mini/00mqu5.md): 本文档规定了商家小程序运营配图的使用规范。首先,图片应清晰美观以提升页面质感,主要应用于辅助说明小程序服务内容。其次,输出规格要求素材格式为PNG、JPG或GIF,外观保持四角方形,大小不超过120KB,背景须不透明且填满。再次,内容规则严禁黄赌毒及无版权图片,要求景象清晰、色彩鲜明,主体居中完整展示,且不得裁剪人物头部。最后,针对网络加载问题,建议图片占位使用#F5F5F5背景色填充。 - [页面布局](https://opendocs.alipay.com/mini/00mqu6.md): 本文档主要阐述了小程序的视觉设计规范。首先建议使用官方标准控件,以保障界面统一稳定,降低用户学习成本并减轻页面跳转不适感。其次,明确基础布局基于750px宽度,内容区左右边距需保持24px以确保可读性。在间距方面,强调规范统一以保证界面美感,并涉及图文间距设置。此外,文档提出圆角设计应具规律性以体现秩序感,图标大小则需依据展示场景进行选择。整体规范旨在提升小程序的视觉一致性与用户体验。 - [色彩](https://opendocs.alipay.com/mini/00mpji.md): 本文档主要介绍了支付宝小程序的官方配色方案,旨在确保视觉连续性与良好的色彩体验。文档列出了五个关键色彩规范分类:官方色板、背景色、文字色、分割线及蒙层色。由于具体的色彩样式与数值均以图片形式展示,文档未提供具体的文字描述或色值代码,需查看者参照文档内的示例图片获取详细视觉规范。 - [字体](https://opendocs.alipay.com/mini/00mry6.md): 支付宝小程序内使用的字体与所运行的系统字体保持一致,常用字号及使用场景可查看下方示例。 ## 行高 ![](https://mdn.alipayobjects.com/afts/img/A*Q1miSbuhkp8AAAAARTAAAAgAeq8wAA/original?bz=openpt_doc&t=v8nVWHLmeslfCmdQMuXI7hrwnMKlr1-TS68dkqVPJzADAAAA #### 小程序适配规范 - [大屏适配设计规范](https://opendocs.alipay.com/mini/088bw9.md): 该文档旨在提升小程序在大屏设备上的体验,提供了全面的适配规范。首先界定了常见大屏尺寸范围,建议依据宽高比选择横竖屏响应布局。其次,提出内部布局四大建议:按宽度分级采用8、12或24栅格系统;区分内容与背景元素,在不同宽度区间实施不缩放、等比缩放或宽度伸缩策略;利用换行排列优化展示密度;采用横向拓展与隐藏调整元素数量。最后,通过案例分析指出了等比缩放和拉伸适配中的常见错误及正确做法。 ### 支付宝小程序官方组件 - [基础控件](https://opendocs.alipay.com/mini/00mqu7.md): 文档介绍了支付宝小程序提供的一套标准基础控件,旨在通过统一的设计风格和稳定的性能,降低用户学习成本并提升使用体验。核心控件包括:用于图形化展示的系统图标;触发交互操作的按钮;固定于顶部显示标题与操作的导航栏;位于底部实现模块切换的标签栏;用于自动消失式轻量反馈的轻提示;用于构建列表页面的表单组件;用于重要信息告知与操作确认的对话框;用于选项滚动选择的选择器;以及用于获取用户身份标识和建立用户体系的授权功能。开发者可根据业务需求灵活调用这些组件。 - [基础控件组合样式](https://opendocs.alipay.com/mini/00mpjj.md): ## 框架 ![](https://mdn.alipayobjects.com/afts/img/A*DitHTJav62AAAAAAZ2AAAAgAeq8wAA/original?bz=openpt_doc&t=RBB_cDA0K37rJeze3dESbZcrw8GKX8XdTr4Onr1KV8oDAAAAZAAAMK8AAAAA) ## 表单 ![](https://mdn.alipayob - [官方组件下载](https://opendocs.alipay.com/mini/00mqu8.md): 本文档主要为支付宝小程序开发团队的视觉设计师提供设计资源下载指引。文档包含两部分核心内容:一是提供官方基础控件库下载,用于辅助小程序设计;二是推荐下载Kitchen Sketch插件,以便获取最新的支付宝组件及设计资源。此外,文档还提供了钉钉群号(35097715),供用户在下载遇到疑问时咨询交流。 ### 设计检查 - [体验设计走查表](https://opendocs.alipay.com/mini/00mqu9.md): 该文档提供了一份小程序体验设计走查表,旨在协助设计者提升设计效率与质量,确保设计体验的完成度与准确度,未达标的设计将影响小程序体验评分。文档详细列出了六大核心检查维度:核心体验关注点(如Logo清晰度、弹窗频次控制)、架构与流程(如信息层级、路径一致性)、界面呈现(如布局规范、字体统一)、数据与展示(如缺省状态、极值处理)、文案规范(如无错别字、通俗易懂)以及过程与特殊场景(如操作反馈、网络与登录状态应对)。设计者需依据此表逐项排查标记,以优化小程序的整体用户体验。 ## 数据 ### 经营分析 - [功能概述](https://opendocs.alipay.com/mini/02h2f3.md): 商家数据中心是支付宝面向商家提供的数据分析工具,旨在通过经营数据、问题诊断及策略支持驱动业务增长。用户登录商家平台即可使用。2021年9月版本进行了重大升级:整合流量概况等模块为“流量分析”,合并营销效果为“优惠券分析”,将安心充等归入“会员卡分析”;新增用户、小程序及智能设备分析模块;下线超值商家券等旧模块。核心功能涵盖数据概览、交易、流量、用户、小程序、营销(优惠券与券包)、会员卡(安心充、基础卡、省卡)及专题分析(智能设备等),支持多维度数据查看。文档还提供了钉钉群技术支持联系方式。 - [数据概览](https://opendocs.alipay.com/mini/069m5n.md): 本文档主要阐述了商家小程序的数据指标定义、功能应用及统计逻辑。在指标方面,详细定义了流量、用户资产与资产活跃三大模块,涵盖了总访问用户数、私域与公域渠道流量、各类累计用户资产及活跃率等关键数据的统计口径,均强调去重计算。在功能方面,介绍了“我关注的数据”看板的个性化定制与详情分析功能,以及基于流量、沉淀、活跃三层逻辑的“商家运营全视图”。此外,文档还针对渠道流量加总与总访问数不符、每日与周期数据差异等常见问题,依据去重逻辑与归因限制提供了具体解释。 - [流量分析](https://opendocs.alipay.com/mini/02h2f5.md): 本文档主要阐述了支付宝小程序流量分析模块的指标定义、功能应用及常见数据问题。首先,详细定义了概览、转化、分渠道及访问明细四类核心数据指标,明确了用户去重与统计口径,涵盖访问人数、交易转化及渠道效果评估。其次,介绍了流量总览、来源Top5、渠道效果明细及访问明细等分析功能,支持商家查看流量趋势与激励数据。最后,针对渠道流量汇总与总数不匹配、平台与自测数据差异等常见问题,基于去重逻辑与归因规则进行了详细解答。 - [用户分析](https://opendocs.alipay.com/mini/02h18i.md): 该文档是用户分析功能的指标解释与使用指南,旨在帮助商家通过四大用户分层模型掌握用户资产状况。文档详细定义了用户资产数据指标,涵盖访问、互动、会员、交易四类用户的各类状态统计口径;阐述了用户行为与画像指标,包括交易特征、访问习惯及基础属性分布,并设定了标准的数值区间。功能应用方面,提供了总览、用户流转、核心数据来源分析及行为画像展示等模块,辅助商家进行精细化运营。此外,文档明确了数据T+2更新、隐私保护展示规则(用户数大于50)及资产计算逻辑等常见问题。 - [交易分析](https://opendocs.alipay.com/mini/02h2f4.md): 本文档阐述了支付宝商家交易分析的数据指标定义与功能使用方法,旨在助力商家高效经营。首先定义了交易概览与小程序交易两类核心指标,包括交易金额、用户数、笔数、客单价及笔单价,两者区别在于统计账号范围不同。其次,介绍了交易概览和小程序交易两大功能模块,支持查看实时数据、核心数据趋势、载体分布及渠道分布,并提供时间与用户类型筛选功能。最后,文档解答了T+1数据更新机制、不同模块数据差异原因等常见问题,并提供了咨询渠道。 #### 小程序分析 - [功能概述](https://opendocs.alipay.com/mini/02h18j.md): 小程序分析是面向开发者和运营人员的数据分析工具,旨在辅助产品迭代与运营推广,支持从灰度测试阶段开始统计用户数据。用户可通过PC端商家平台和移动端小程序助手两个入口访问,两端数据实时同步。该工具提供全方位的数据分析功能:数据概况展示实时核心数据与自定义看板;经营诊断分析拉新、复访、交易的同行排名与趋势;访问分析涵盖总览、留存及用户画像;营销分析追踪营销券效果;搜索、收藏、消息及扫一扫运营分析分别提供各场景下的流量、效果及用户特征数据,助力商家全面掌握运营状况。 - [概览数据](https://opendocs.alipay.com/mini/01snke.md): 本文档主要阐述了小程序数据分析的指标定义、功能使用方法及常见统计问题。首先,详细定义了流量、交易、运营效果及用户反馈四大核心模块的数据指标,涵盖了从访问用户数、交易转化到用户留存与互动的全方位数据口径,明确了去重统计原则。其次,介绍了“我关注的数据”看板定制功能与“小程序运营全视图”,助力运营者高效分析业务状况。最后,针对渠道流量加总与总数不一致、平台数据与自测数据差异等常见疑问,依据去重逻辑与归因溯源原理进行了专业解答。 - [实时数据](https://opendocs.alipay.com/mini/069g60.md): 该文档主要说明了“今日数据”模块的功能定义与数据逻辑。该模块展示从当日0点至最新更新时间的实时业务数据,并提供与昨日环比及上周同比的对比分析。核心监测指标涵盖访问人数、访问次数、交易金额、交易笔数及交易人数。文档特别指出了两点数据说明:一是图表展示的是每日数据趋势,而非周或月的聚合趋势;二是针对需要去重计算的指标(如人数、用户数),因跨时间维度去重逻辑的存在,趋势图单日数据的累加和与指标区的汇总数据不相等。 - [流量数据](https://opendocs.alipay.com/mini/01snkg.md): 本文档主要阐述了支付宝小程序数据分析的指标定义、功能使用方法及常见数据问题解答。文档详细定义了概览、转化及分渠道三大类数据指标,涵盖总访问用户数、私域与公域流量来源、收藏订阅及交易转化等关键数据。功能模块包括流量总览趋势、来源转化Top5、渠道效果明细、页面访问分析及用户留存画像分析,并支持时间筛选与页面名称备注。针对常见的数据差异问题,文档解释了渠道与页面流量加总与总数不符的去重统计逻辑、无法归因流量的存在原因,以及支付宝与商家自埋点数据差异的识别精度区别,为商家提供了完整的数据分析参考依据。 - [交易数据](https://opendocs.alipay.com/mini/07wohg.md): 该文档主要阐述了支付宝小程序交易分析的指标定义、功能使用及常见问题。首先定义了交易金额、用户数、客单价等核心指标,明确了新老客划分、支付金额分布及复购率的统计口径。其次介绍了交易分析功能,包括核心数据概览、渠道效果分析、交易画像及复购率展示,支持商家通过时间与用户类型筛选查看数据。最后解答了数据T+1更新机制、画像排序规则及复购率具体计算示例,助力商家精准掌握经营数据。 - [扫一扫数据](https://opendocs.alipay.com/mini/04qle4.md): 该文档详细定义了小程序“扫一扫”功能的指标体系与数据看板应用。指标体系涵盖三大维度:核心数据指标包括扫码访问用户数、占比、新增数及访问次数;用户关系积累指标涵盖引导收藏、消息订阅及交易的转化率;用户画像指标包含年龄、性别及地域分布。功能使用部分对应展示了数据总览、关系积累及画像分析三大模块。这些内容旨在帮助商家全面监测扫码流量规模,评估用户转化与沉淀效果,并通过画像深入洞察用户特征。 - [搜索数据](https://opendocs.alipay.com/mini/01sm77.md): 该文档旨在说明小程序搜索数据的指标定义、功能模块及常见问题。首先,文档定义了曝光、点击、引导访问及交易相关的核心统计指标,区分了用户数与次数的统计维度。其次,介绍了功能使用模块:“搜索概况”展示整体效果、关键词及来源分布;“搜索直达”区分了当前小程序品牌直达效果与品牌整体效果,并涵盖模块数据与券推广效果;“小程序搜索”则关注子服务和普通展示带来的效果。最后,文档解释了sug推荐含义,并说明了因仅展示前50个高效关键词而导致已配置词不可见的原因。 - [商家粉丝群分析](https://opendocs.alipay.com/mini/09e78l.md): 该文档主要介绍商家粉丝群数据分析的指标定义及使用指引。在指标解释方面,文档详细定义了概览、群组列表、用户、流量、互动及交易六大类核心指标,明确了群聊数、用户数、交易金额等数据的统计口径与去重逻辑。在使用指引方面,文档说明了分析功能的入口路径,并阐述了群数据概览、用户分析、流量分析及互动转化四大模块的功能。这些模块支持核心数据监控、异常诊断建议、用户漏斗转化分析及来源渠道定位,旨在帮助商家全面掌握群运营状况,精准定位问题环节,从而制定差异化的运营策略以提升转化效果。 #### 营销分析 - [优惠券](https://opendocs.alipay.com/mini/02h18k.md): 文档主要阐述了优惠券分析平台的指标定义、功能操作及技术支持。核心内容包含三大指标体系:券触达指标关注领取数量与用户规模;券核销指标衡量核销数量、金额及各类转化率;券带动交易指标评估交易笔数、金额及ROI。功能上,平台分为核心数据趋势展示、推广渠道效果对比及优惠券明细查询三大模块,支持时间维度筛选。此外,文档说明了渠道曝光数据缺失的常见问题,并提供了钉钉群联系方式以获取技术支持。 - [支付券](https://opendocs.alipay.com/mini/03pkle.md): 本文档详细介绍了支付宝平台支付券产品的数据指标定义与分析功能。支付券涵盖满减、折扣及特价券类型。文档界定了三大核心指标体系:券触达指标(如领取数量、累积领取)、券核销指标(如核销金额、累计核销率)及券带动交易指标(如交易金额、ROI)。功能模块包含核心数据看板、用户画像分析及券详情查询。其中,券详情支持分析单券效果及不同推广渠道表现,渠道被划分为公域、私域及其他三类。此外,文档说明了渠道曝光数据不准的原因,并提供了技术支持的钉钉群联系方式。 - [商家券](https://opendocs.alipay.com/mini/03prqw.md): 本文档主要介绍了商家券产品的定义、数据指标体系及分析功能。商家券是由商家创建核销的直领券,包含满减、折扣和特价券。文档详细定义了三大类指标:券触达指标(如领取数量)、券核销指标(如核销率、核销金额)及券带动交易指标(如交易笔数、金额)。功能上,平台提供核心数据展示、用户画像分析及券详情查询。其中,券详情支持分析单个商家券效果及多渠道推广表现,渠道涵盖公域、私域及其他类型。文档还解答了曝光数据不准的常见问题,并提供了技术支持联系方式。 - [团购券](https://opendocs.alipay.com/mini/03pklf.md): 本文档主要介绍团购券产品的数据定义、分析功能及支持服务。团购券指商家自建核销的兑换券,其数据指标体系涵盖订购、核销、退款三个维度,具体包括订购数量与金额、核销率及退款金额等。分析功能包含核心数据趋势展示、用户画像分析及券详情查询。其中,券详情支持分析公域、私域及其他渠道的投放效果。针对渠道曝光数据不准等常见问题,文档建议优先关注领取核销数据或联系技术支持,并提供了相应的钉钉群联系方式。 - [会员卡分析-安心充](https://opendocs.alipay.com/mini/02h5zc.md): 本文档主要定义了安心充业务的统计指标并说明了分析功能的使用方法。在指标方面,详细界定了充值、核销、退款的相关用户数、笔数及金额口径,明确了本金与总金额的区别;同时定义了活跃、累计、复充及拉新等会员状态指标,并对老用户转化与拉新会员的判定时间窗口(180天)进行了区分。在功能方面,安心充分析包含核心数据、效果分析、充值方案详情及开卡渠道四大模块,支持日期筛选与明细查看,旨在帮助商家分析锁客效果、会员转化、套餐表现及渠道投放效率,辅助运营决策。文档末尾提供了技术支持的钉钉群联系方式。 - [会员卡分析-基础会员卡](https://opendocs.alipay.com/mini/02h37w.md): 该文档主要介绍支付宝基础会员卡的数据指标定义、功能操作及常见问题。首先明确了累计会员数、交易相关指标及曝光点击率等十个关键数据的定义。其次阐述了功能模块,包括展示核心趋势的“核心数据”和监测卡包引流效果的“会员卡活跃分析”,支持日期筛选。文档还区分了基础会员卡与安心充,前者侧重会员管理,后者侧重储值锁客。最后提供了技术支持的联系方式。 - [专题分析-绿色能量](https://opendocs.alipay.com/mini/02iky2.md): 本文档介绍了蚂蚁森林绿色能量看板的功能定义、核心指标及使用说明。该看板用于统计消费者在合作商家进行环保行为(如免塑、电子小票等)并完成交易后的能量发放数据。核心指标包括绿色订单数、能量发放数及发放用户数。用户可通过商家平台数据中心查看数据趋势与实时订单明细(保留90日)。文档澄清了发放数与用户领取数的区别,说明了多小程序按账号(PID)累加统计的规则,以及能量需24小时成熟、成熟后72小时未领取即失效的机制,并提供了技术支持联系方式。 - [流量类型及渠道说明](https://opendocs.alipay.com/mini/069g5z.md): 本文档详细定义了支付宝小程序的流量类型与流量渠道,并阐述了相关的数据统计逻辑。流量被划分为私域渠道、公域日常推广、流量激励及商业化推广四大类,涵盖扫码、搜索、首页推荐、生活号等具体入口。文档逐一说明了首页宫格、支付成功页、应用中心等渠道的具体范围与含义。针对数据统计差异,文中解释了渠道流量加总大于总访问用户数是由于跨渠道用户去重计算,小于总访问数则是由于存在少量无法归因的流量,并明确了商业推广流量在常规渠道数据中不予包含的统计原则。 ### 友盟+ 数据服务 - [产品概述](https://opendocs.alipay.com/mini/006l1i.md): 友盟+作为国内领先的第三方全域数据智能服务商,以“数据智能,驱动业务增长”为使命,通过AI赋能的一站式服务体系帮助企业实现用户洞察与业务增长。其推出的U-MiniProgram小程序统计平台,专为开发者提供微信及支付宝小程序的数据统计能力。该平台核心特色包括支持支付宝小程序数据统计、提供用户从获客到转化的全链路行为分析、极简接入流程以及免费使用。该服务适用于拥有多平台小程序的开发者,集成后可一站式查看各平台数据,助力精细化运营。 - [功能说明](https://opendocs.alipay.com/mini/006l1m.md): 本文档介绍了小程序数据分析平台的核心功能模块与使用限制。主要涵盖四大方面:一是数据概览,包括全部小程序汇总、概况统计及实时统计,支持多维度查看用户数据与趋势;二是来源与用户分析,通过场景来源、推广来源追踪用户路径,利用用户趋势、参与度及留存分析评估用户粘性与拉新效果;三是分享与转化,包含分享概况及转化漏斗,用于衡量裂变价值与关键步骤转化率;四是自定义事件,支持交互行为埋点统计。文档还明确了各功能的具体配置上限,如小程序数量、推广活动及自定义事件数量等限制。 - [支付宝小程序 SDK 集成教学视频](https://opendocs.alipay.com/mini/00hs5c.md): 友盟学院全新推出产品操作实操教程。7 分钟搞定 支付宝小程序 SDK 集成+自定义事件,快来学习吧! [此处为语雀卡片,点击链接查看](https://opencms-web.alipay.com/open/md/repo/article?spaceCode=00a4pi&repoCode=04 - [更新日志](https://opendocs.alipay.com/mini/00ho4j.md): 本文档是支付宝小程序统计平台的SDK更新日志,记录了从1.0.5至2.2.2版本的迭代详情。核心更新包括:新增手动分享统计接口、自定义事件及漏斗分析功能;实现对微信小游戏及uniapp、Taro等主流转译框架的兼容;优化集成方式与发送策略。同时,修复了query参数覆盖、回调指向错误及部分机型方法未定义等问题。文档还提供了通过package.json文件查看SDK版本的方法。 ## 更新日志 ### 基础库更新日志 - [v2.x 版本](https://opendocs.alipay.com/mini/01inev.md): 该文档详细记录了支付宝小程序基础库从 2.6.0 至 2.10.29 版本的更新日志。主要涵盖了四大类更新:API 新增与优化、框架能力增强、组件功能拓展及问题修复。重点更新包括引入窗口尺寸监听、路由观察器、设备文件选择等新 API;框架层面支持 Mixin 机制、分包异步化、骨架屏及自定义组件懒加载;组件方面优化了 Native 渲染能力,新增共享元素与页面容器组件。此外,版本迭代中修复了大量涉及 iOS/Android/鸿蒙系统兼容性、自定义组件生命周期及样式隔离等关键问题,持续提升小程序的开发体验与运行稳定性。 - [v1.x 版本](https://opendocs.alipay.com/mini/00mmyu.md): 该文档记录了支付宝小程序基础库从v1.0.8至v1.25.4版本的更新日志。核心更新涵盖框架、组件与API三大层面:框架上引入了自定义组件机制、完善生命周期(如onUnhandledRejection)、支持全局分享配置及rpx适配;组件上重点增强了swiper、map、video、scroll-view等核心组件的属性与交互能力,并新增了rich-text等组件;API上扩充了网络请求、地图计算、媒体控制及小程序跳转等接口。同时,文档详细记录了大量针对iOS与Android双端的Bug修复,解决了手势冲突、样式渲染、输入交互及插件兼容性等问题,全方位提升了小程序的开发能力与运行稳定性。 --- llms.txt:用于快速了解预览 llms-full.txt:建议先阅读llms.txt,再查看llms-full.txt获取详细说明