SDK 运行在宿主页面的浏览器环境。卡片、凭据与 3DS 都由 Clink 托管的 iframe 处理,宿主只接收标识和事件。
安装
new AgentElements(options)
创建 SDK 实例,并解析当前环境对应的 Clink 应用地址。
使用哪个 Clink 应用地址,见 环境映射。
外观与语言设置,见 预设项。
预设项
预设项在 SDK 发送init 时应用。运行期只能用 setLocale 切换语言;主色和圆角创建后不可更改。
元素凭据
凭据在createElement 时按元素类型传入:
方法
创建
type 对应的元素并传入该元素的凭据:paymentMethods 传 { token },vault 传 { vaultId }。一个实例只能创建一个元素,重复调用会抛错;凭据为空也会抛错。元素在调用 mount() 之前不会渲染。错误
AgentElement
元素由 createElement 创建,事件订阅挂在元素上。
仅
paymentMethods 可用。更新元素内的 card-session token:mount 之前调用会在下一次 init 下发;mount 之后调用会发送 set-token 并重新加载卡片数据。空值会抛错。vault 的凭据是一次性 vaultId,不支持刷新。挂载 iframe。
target 可以是 CSS 选择器或 HTMLElement,容器必须存在。见 挂载选项。挂载选项
传给mount() 的展示开关与主操作按钮外观,只在下一次挂载时生效。选项类型由元素类型决定,传错字段会在编译期报错。
paymentMethods
主操作按钮外观,见 按钮选项。
vault
主操作按钮外观,见 按钮选项。
按钮选项
主操作按钮指元素底部的「添加银行卡」「解锁银行卡」或「继续」按钮。height。非数字或超出区间的值(高度 16–200、字号 8–40、圆角 0–100)会被忽略。卡列表行内的「设为默认」「删除」按钮与失败重试按钮不受影响。
事件
事件按元素划分,事件名与 payload 由元素类型推导。paymentMethods 事件
vault 事件
error.source 取值:
unmount() 不会清除订阅,只有 destroy() 会。
环境映射
environment 必传:接入联调用 sandbox(UAT),上线后用 production。
模块导出
version 由构建时注入。直接引用源码时返回 0.0.0-dev。
类型
构建产物
包不提供 CommonJS 产物。内部的 iframe bridge 会在构建时打入产物,发布后的包没有私有运行时依赖。
Script 标签
<script> 标签加载时,SDK 挂载在全局变量 ClinkAgentElements 下。生产环境请把 @<version> 固定为实际版本号。