官方无蜂 SDK 包装器

一个简单的模块 无蜂 SDK

为什么是Beefree SDK?

选择一个可靠,易入的多内容类型数字平台,您可以在此基础上建立. 无蜂 SDK 不仅仅是一个嵌入式可视化的构建器, 拥有巨大的拖放用户体验。 它是一个可靠且高度自定义的电子邮件、登陆页面和弹出构建器.

从概念证明到生产 几天,而不是几个月. 无蜂 SDK 它可以被高度定制 如何外观,它做什么, 以及如何与您的应用交互。 以小的发展努力完成你的工作.

你可以把它嵌入你的申请!

访问我们的开发者文档[https://docs.beefree.io/ 页面存档备份,存于互联网档案馆[ . ]

怎样用

• 转到开发者门户 https://developers.beefree.io/ signup 页面存档备份,存于互联网档案馆
• 加入自由计划
• 创建您的应用程序
• 获取客户端ID 和客户端Secret

演示

免费使用 "https://beefree.io" (英语):你甚至不需要创建任何账户.

你想尝试融入本地社会吗?

这个项目有一个实例集成,可以在当地运行SDK建设器. 它使用来自 /src 文件夹.

1. 安装 Nodejs( 也是 npm, 应该已经带了 nodejs) 或 Yarn .
2. 复制此寄存器 :
   • git clone https://github.com/BeefreeSDK/beefree-sdk-npm-official.git
3. npm install 或者说 yarn install (如果你已经安装) 复制到文件夹中
4. 重新命名本地名称 .env.sample 文件为 .env
5. 运行 npm start 或者说 yarn start
6. 在您最喜欢的浏览器中打开 http://localhost:8081 .
7. 玩得开心点!

这种示范性整合主要是为了发展目的,如果是无蜜蜂SDK国家防范机制一揽子计划的话.

如何为您自己使用此模块

安装

你要么安装它 无 或者说 线条。 。 。 .

npm install --save @beefree.io/sdk

或者说

yarn add @beefree.io/sdk

初始化构建器

获取令牌( 客户身份、 客户身份)

您需要授权开始使用编辑器: Beefree 帮助文档门户 有个好职位 解释如何做到这一点

重要安全通知

从v9.0.0起 getToken 方法已改名为 UNSAFE_getToken。 。 。 . 这一变化表明,这种方法的用意是 仅限 用于快速启动教程,POC,以及本地测试. 为了保护你的密钥 我们强烈建议执行 getToken 编辑 服务器侧 在所有生产环境中.

把你的证书上 UNSAFE_getToken 在返回承诺中启动 SDK。 以下示例:

import BeefreeSDK from '@beefree.io/sdk'

// Put your credentials in the .env file
const clientId = process.env.CLIENT_ID
const clientSecret = process.env.CLIENT_SECRET
const beeConfig = {...}

const template = {...}
const beeTest = new BeefreeSDK(token, authConfiguration)

beeTest.UNSAFE_getToken(clientId, clientSecret)
  .then(() => beeTest.start(beeConfig, template))

新蜜蜂( 托肯, authConf )

初始化 BEE 实例, 并创建服务器侧面

import BeefreeSDK from '@beefree.io/sdk'

const authConf = {...}
const beeConfig = {...}
const template = {...}

// You can add your personal configuration, if you omit some properties, the builder will use its default configuration
const authConf = {
  authUrl: process.env.YOUR_AUTH_URL,
  beePluginUrl: process.env.YOUR_HOST_URL
}
const builder = new BeefreeSDK(token, authConf)
builder.start(beeConfig, template)

配置编辑器( BeeConfig)

它需要一个配置来使用编辑器, 无蜂帮助文档门户 有个好职位 解释如何做到这一点

以下是配置的一个例子;只需读取扩展版本的正式文件即可.

const beeConfig = {
  container: 'beefree-sdk-container', // Identifies the id of div element that contains the Beefree SDK builder
  language: 'en-US',
  onSave: (jsonFile, htmlFile) => {
    console.log('onSave', jsonFile, htmlFile)
  },
  onSaveAsTemplate: (jsonFile) => {
    console.log('onSaveAsTemplate', jsonFile)
  },
  onSend: (htmlFile) => {
    console.log('onSend', htmlFile)
  },
  onError: (errorMessage) => {
    console.log('onError ', errorMessage)
  }
}

替代用途 container 作为 HTML 元素 :

const containerElement = document.getElementById('beefree-sdk-container')

const beeConfig = {
  container: containerElement,
  ...
}

模板 JSON

它需要一个初始模板开始编辑. 学多点 这里

来点Json活泼的 https://github.com/ BeefreeSDK/beefree-sdk-assets-templates (原始内容存档于2018-09-28) (英语)

在你开始建造后,可以启动这种方法

方法

开始( BeeConfig, 模板, 终点, 选项)

在初始化后,您可以调用开始在页面上加载构建器;该方法需要两个参数:

• BEE 配置( 需要 - js 对象)
• 模板( 需要 - JSON)
• 终点( 可选的 - 字符串 或 无效)
• 选项( 可选的 - js 对象, 例如 ). { shared: true }(中文(简体) )

这个返回一个承诺, 将在我们调用构建者的启动功能后解决

装入( 模板)

此更改模板; 调用 load 带有新模板

重新装入( 模板)

这可以通过刻入加载对话框来修改模板; 只要调用 reload 带有新模板

保存()

这叫无蜂SDK save 方法,进而触发回调 onSave 定义用于获取更新邮件和JSON模板的 HTML 的配置.

保存 AsTemplate ()

这叫无蜂SDK saveAsTemplate 方法,它反过来将触发在配置中定义的 SaveAsTemplate 上的回调,只获取实例中当前 JSON .

发送( )

这叫无蜂SDK send 方法,这反过来将触发配置中定义的调回发送,只获取实例的当前html.

预览( )

这叫无蜂SDK preview 方法,它触发编辑器内部的预览模式.

切换结构( C)

这叫无蜂SDK toggleStructure 方法,它可以切换编辑器舞台上的结构帮助.

切换Comments ()

这叫无蜂SDK toggleStructure 方法,可以切换编辑器侧边栏上的评论部分.

切换Preview ()

这叫无蜂SDK togglePreview 方法,打开/关闭编辑器内的信息预览行为.

显示Comment( uuid)

这叫无蜂SDK showComment 方法,它打开一个特定的注释,并滚动舞台到相关的元素。 该方法需要一个参数,一个"uuid"作为字符串的评论.

加载Config( 客户端Config)

这叫无蜂SDK loadConfig 方法,它重新装入用于初始化构建器的JSON配置.

加入( BeeConfig, 会话) (d) 国家

初始化后,您可以调用加盟以加载页面上的构建器并加入协作编辑会话;该方法需要两个参数:

• BEE 配置( JS 对象)
• 会话ID( 从 onSessionStarted 调用)

返回一个承诺, 在我们调用建设者的启动功能后, 已经解决了 。 访问 文档 更多关于共同编辑的细节.

装入工作空间( 类型)

这叫无蜂SDK loadWorkspace 方法,它接受下列参数之一 : “ 默认 ” 。 “ 混合 ” “ amp only ” 。 访问 文档 更多关于工作空间的细节.

加载模式( arg)

这叫无蜂SDK loadStageMode 方法,它接受一个对象参数,其结构如下:{模式:'desktop'|'mobile',显示:'blur'|''hide'}。 访问 文档 关于设计模式的更详细信息.

加载Config( 客户端Config)

这叫无蜂SDK loadConfig 方法,它重新装入用于初始化构建器的JSON配置.

更新 Token( 更新 TokenArgs)

这叫无蜂SDK updateToken 方法,并允许刷新访问符.

获取Config ()

这叫无蜂SDK getConfig 方法并返回SDK使用的客户端Config.

翻译 Template( arg)

这叫无蜂SDK translateTemplate 方法,它接受包含语言的对象并返回承诺。 访问 文档 更多关于自动翻译的细节.

重置 Template 翻译( arg)

这叫无蜂SDK resetTemplateTranslation 方法,它接受包含语言的对象并返回承诺。 访问 文档 更多关于自动翻译的细节.