loadAntom()
loadAntom() 是加载 Antom SDK 实例的入口函数,通过传入配置参数,异步加载并返回 antom 实例,用于创建 Element、更新配置参数、发起支付或绑卡等后续操作。
注意:
- SDK 内部采用单例模式,多次调用
loadAntom()会返回同一个实例。loadAntom()是异步函数,必须使用await或.then()获取实例。loadAntom()在使用 npm 方式时,如果由于网络问题导致脚本加载失败,方法会返回 reject。建议检查网络连接后刷新页面重新尝试,或直接访问对应的 CDN 链接以确认资源是否可正常加载。
方法签名
调用此方法时,请使用以下标准方法签名格式:
JavaScript
TypeScript
copy
loadAntom(config)参数
此方法接收一个配置对象,用于初始化 SDK 的运行环境与核心行为。
| 参数 | 类型 | 是否必需 | 描述 |
| config | Object | 否 | SDK 配置对象,用于设置环境、语言、调试模式等。 |
config
| 参数 | 类型 | 是否必需 | 描述 |
| env | String | 否 | 环境配置选项,有效值包括:
|
| environment | String | 否 | env 的别名,若两者同时设置,以 env 的值为准。有效值包括:
|
| debug | Boolean | 否 | 是否开启调试模式。开启后 debugger 调试工具会输出详细日志,便于开发者排查问题。有效值为:
|
| locale | String | 否 | 设置 SDK 内部显示语言(如错误信息和提示文案)。有效值为:
|
返回值
此方法返回一个 Promise 对象,解析后可获得一个 antom 实例,该实例提供以下主要方法:
| 方法名 | 描述 |
antom.createElement() | 创建 Element 实例,如 CVVElement、VaultingElement 等。 |
antom.confirmPayment() | 发起支付确认,用于已存卡场景。 |
antom.confirmCardSetup() | 确认绑卡信息,用于绑卡场景。 |
antom.updateConfig() | 更新 SDK 配置参数。 |
销毁 |
使用示例
CDN
copy
const antom = await window.loadAntom();通过 CDN 引入 SDK 时,建议在页面添加最新的 antom sdk 的 CDN 链接,若项目使用 Typescript,可在 tsconfig 中 compilerOptions.types 中加入 @alipay/ams-checkout/antom,即可在代码编写时获得 typescript 输入提示。以下为配置示例:
copy
{
"compilerOptions": {
"types": ["@alipay/ams-checkout/antom"]
}
}npm
copy
import { loadAntom } from '@alipay/ams-checkout';
// 加载生产环境 SDK
const antom = await loadAntom();