Frigade Javascript SDK (英语)

安装

从命令行安装软件包 .

用纱线

yarn add @frigade/js

与 npm 关系

npm install @frigade/js

使用量

简单 import { Frigade } from '@frigade/js' 并使用它。 示例

import { Frigade } from 'packages/js-api'

const frigade = new Frigade('FRIGADE_API_KEY')

await frigade.identify('USER_ID', {
  name: 'USER_NAME',
  email: 'USER_EMAIL',
  signed_up_at: 'USER_SIGNED_UP_AT' // ISO 8601 format
})

// Optional: send organization/group id
await frigade.group('ORGANIZATION_ID', {
  name: 'COMPANY_NAME',
})

API 参考

见 完整 API 引用

获取流量 :

const flow = await frigade.getFlow('FLOW_ID')
// Flow data defined in config.yml in the Frigade dashboard
console.log('Flow status:', flow.isCompleted)
console.log('Flow data:', flow.rawData)

将流量标为已完成 :

const flow = await frigade.getFlow('FLOW_ID')
await flow.complete()

将流量中的一步标为已完成 :

const flow = await frigade.getFlow('FLOW_ID')
const step = flow.steps.get('STEP_ID')
await step.start()
await step.complete()

发送跟踪事件 :

await frigade.track('EVENT_NAME', {
  property1: 'value1',
  property2: 'value2',
})

事件处理器

全球事件处理器可以在任何流量发生状态变化时被注册以通知. 例如,当流量完成时通知:

// This callback will be called when a the current user/group changes state in any flow
const callback = (updatedFlow, previousFlow) => {
  console.log('Flow state changed:', flow.isCompleted)
  console.log('Step state changed:', flow.steps.get('STEP_ID').isCompleted)
};

frigade.onStateChange(callback);
// To remove the callback use:
frigade.removeOnFlowStateChangeHandler(callback);

当特定流量变化状态时,可以注册特定事件处理器以通知. 例如,当流量完成时通知:

// This callback will be called when a the current user/group changes state in the flow with id FLOW_ID
const flow = await frigade.getFlow('FLOW_ID')
const callback = (updatedFlow, previousFlow) => {
  console.log('Flow state changed:', flow.isCompleted)
  console.log('Step state changed:', flow.steps.get('STEP_ID').isCompleted)
};
flow.onStateChange(callback);

仅针对流动中的特定步骤,使用:

// This callback will be called when a the current user/group changes state in the flow with id FLOW_ID and step with id STEP_ID
const flow = await frigade.getFlow('FLOW_ID')
const step = flow.steps.get('STEP_ID')
const callback = (updatedStep, previousStep) => {
  console.log('Step state changed:', step.isCompleted)
};
step.onStateChange(callback);

跨平台支持

SDK的所有非UI相关功能在所有JavaScript环境中工作(Node.js,浏览器,React Introduct等).

类型脚本支持

此套件包含类型脚本定义 frigade 对象.

关于弗里加德

果冻 是一个开发商先行的平台,用于在机上建造优质产品。 一个强大的, 灵活的 API 和本地的 SDK 允许您更快地在 10x 上建机, 更容易的实验, 并驱动客户 成功吗.

Frigade支持一系列的使用案例,例如:

• 登记: 尽量增加用户通过您签名的流量, 并使用美丽的解释器, 进步 条条和表格.
• 激活: 转换更多的客户,方法是通过一系列适合其角色的键入项目, 权限,或目标.
• 收 养: 向受众介绍与本地热点、工具提示、旅游和 交互式产品指南.
• 参与:保持活跃客户的接触,宣布新的产品特性,并创建特定生命周期 休眠或休眠的客户重新登船.
• 保留: 通过在正确的时间提供正确的内容,并通过要求用户 对产品的反馈.

特征

构成部分库

用于搭载高质量用户的无型即成组件,速度快. 登入清单、工具提示、, 产品走过,还有更多. 见组件

一体化

与分会,Mixpanel,Posthog的结合,以及更多对动力瞄准,分析,和通信的结合.

内容管理

轻量级CMS内置以更新并测试登机副本和内容.

版本

Frigade使得管理多个版本的搭载在中转和生产之间变得容易. 重审以前的版本 上岗看他们的表现和做的改进.

客户行程

Frigade 自动跟踪状态管理和登入进度. 让你的团队全心全意进入 客户旅行,并使用Frigade来启动自动化工作流程.

要多学多学,就去参观 frigade.com (英语)