海岸部件 SDK
在您的网络应用程序中嵌入海岸 .
开始
npm install @coastpay/embedded-widget-sdk
装入 SDK并初始化 :
import { loadCoast } from '@coastpay/embedded-widget-sdk';
const coast = await loadCoast();
const widget = coast.initialize({
container: 'coast-container', // element id or HTMLElement
embedToken,
onReady: () => {
// the embedded app has finished loading and is ready to be used
console.log('Coast widget is ready');
},
onError: (error) => {
console.error('Coast widget error:', error);
},
});
API 密码
coast.initialize(options)
将部件 iframe 挂入容器元素并返回 a CoastWidget 举个例子.
单倍限 : 一次只有一个部件可以活动 。 通话
initialize()当一个部件已经存在时,会自动销毁上一个部件.
| 选项 | 类型 | 需求 | 说明 |
|---|---|---|---|
container | string | HTMLElement | 对 | 元素 id 或直接 HTMLElement 参考文献 |
embedToken | string | 对 | 从您的后端嵌入的 Token API 呼叫中生成的不透明会话符号 |
onReady | () => void | 没有 | 当嵌入式应用程序装入完成并准备使用时调用 |
onError | (error: Error) => void | 没有 | 在初始化失败或嵌入式应用程序在30秒内无法装入时调用 |
onLogin | () => void | 没有 | 一旦用户在嵌入式应用程序中被认证, 就会被调用 。 恢复会话的起火也可能会不止一次地为同一个用户起火——使您的处理器具有一能性. 只有客户端通知——在录制状态前确认服务器端 |
onLogout | () => void | 没有 | 当用户从嵌入的应用程序中日志出时( 如会话过期) 调用 |
widget.logout()
通知宿主用户已登录的嵌入式应用程序. 当您自己的会话结束时,请打电话.
widget.destroy()
删除 Iframe 并清理所有事件听众.