loadAntom()

loadAntom() 是加载 Antom SDK 实例的入口函数,通过传入配置参数,异步加载并返回 antom 实例,用于创建 Element、更新配置参数、发起支付或绑卡等后续操作。

注意

  • SDK 内部采用单例模式,多次调用 loadAntom() 会返回同一个实例。
  • loadAntom() 是异步函数,必须使用 await.then() 获取实例。
  • loadAntom() 在使用 npm 方式时,如果由于网络问题导致脚本加载失败,方法会返回 reject。建议检查网络连接后刷新页面重新尝试,或直接访问对应的 CDN 链接以确认资源是否可正常加载。

方法签名

调用此方法时,请使用以下标准方法签名格式:

copy
loadAntom(config)

参数

此方法接收一个配置对象,用于初始化 SDK 的运行环境与核心行为。

参数类型是否必需描述
configObject

SDK 配置对象,用于设置环境、语言、调试模式等。

config

参数类型是否必需描述
envString

环境配置选项,有效值包括:

  • sandbox:沙箱环境,用于测试。
  • prod:默认值。生产环境,用于线上业务。
environmentString

env 的别名,若两者同时设置,以 env 的值为准。有效值包括:

  • sandbox:沙箱环境,用于测试。
  • prod:默认值。生产环境,用于线上业务。

注意envenvironment 参数功能相同,推荐统一使用 env 参数。

debugBoolean

是否开启调试模式。开启后 debugger 调试工具会输出详细日志,便于开发者排查问题。有效值为:

  • true:开启调试模式。
  • false:默认值,不开启调试模式。
localeString

设置 SDK 内部显示语言(如错误信息和提示文案)。有效值为:

  • en_US:默认值。英语
  • pt_BR:葡萄牙语(巴西)
  • pt_PT:葡萄牙语
  • es_ES:西班牙语
  • ko_KR:韩语
  • zh_CN:简体中文
  • zh_HK:繁体中文
  • ms_MY:马来西亚语
  • in_ID:印度尼西亚语
  • th_TH:泰语
  • vi_VN:越南语
  • tl_PH:菲律宾语
  • it_IT:意大利语
  • de_DE:德语
  • fr_FR:法语
  • nl_NL:荷兰语
  • ja_JP:日语
  • ro:罗马尼亚语
  • pl_PL:波兰语
  • ar_SA:阿拉伯语
  • tr_TR:土耳其语
  • hi_IN印度语

注意:如果不传或传入的语言值不在以上列出的范围内,系统将默认使用英语。

返回值

此方法返回一个 Promise 对象,解析后可获得一个 antom 实例,该实例提供以下主要方法:

方法名描述
antom.createElement()创建 Element 实例,如 CVVElementVaultingElement 等。
antom.confirmPayment()发起支付确认,用于已存卡场景。
antom.confirmCardSetup()确认绑卡信息,用于绑卡场景。
antom.updateConfig()更新 SDK 配置参数。

antom.destroy()

销毁 antom 实例,释放所有相关资源。

使用示例

CDN

copy
const antom = await window.loadAntom();

通过 CDN 引入 SDK 时,建议在页面添加最新的 antom sdk 的 CDN 链接,若项目使用 Typescript,可在 tsconfigcompilerOptions.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();