yizun-sdk/README.md

易尊前端SDK - 用于集成前端埋点追踪的JavaScript库

# 易尊 SDK 使用文档

## 简介

易尊 SDK 是一个用于集成前端埋点追踪的 JavaScript 库。它支持多种引入方式，并提供了 Vue 插件集成功能。

## 安装

### NPM 安装

```bash
npm install yizun-sdk
```

### CDN 引入

```html
<script src="https://static.ejcop.com/static_file/yizun-jssdk/yizun-jssdk.umd.js"></script>
```

## 使用方法

### 基础用法

1. 初始化插码
```javascript
window.yiZunSdkInit({
    type: '1_shandong',
    data: {
        // 自定义数据 定义
    }
});
```

2. 追踪事件
```javascript
window.yiZunSdkTrack({
    type: '1_shandong',
    step: '页面浏览',
    data: {
        // 自定义数据
    },
    extend: {
        // 扩展数据
    }
});
```

### Vue 集成

SDK 同时支持 **Vue 2.6+** 和 **Vue 3.x**，会自动检测Vue版本并使用相应的API。

#### Vue 3

```javascript
import { createApp } from 'vue'
import YiZunSDK from 'yizun-sdk'

const app = createApp(App)
app.use(YiZunSDK)
```

#### Vue 2
```javascript
import Vue from 'vue'
import YiZunSDK from 'yizun-sdk'

Vue.use(YiZunSDK)
```

在组件中使用：
```javascript
export default {
    methods: {
        trackEvent() {
            this.$yiZunTrack({
                type: '1_shandong',
                step: '页面浏览'
            })
        }
    }
}
```


## 支持的事件类型

以下是支持的步骤类型：

- `页面浏览`：页面访问追踪
- `输入手机号`：手机号输入事件
- `获取验证码`：验证码获取事件
- `输入验证码`：验证码输入事件
- `立即办理`：办理操作事件
- `确认办理`：确认操作事件
- `办理成功`：成功状态事件
- `办理失败`：失败状态事件

## API 参考

### init(params)

初始化插码的主要方法。

参数说明：
- `type`：插码类型（目前支持 '1_shandong'）
- `data`：自定义数据对象,定义插码初始化数据（object，可选）

### track(params)

追踪事件的主要方法。

参数说明：
- `type`：插码类型（目前支持 '1_shandong'）
- `step`：事件步骤名称（string）
- `data`：自定义数据对象（object，可选）
- `extend`：扩展数据对象（object，可选）

## 构建输出

SDK 提供以下几种模块格式：
- ESM: `dist/yizun-jssdk.mjs`
- CommonJS: `dist/yizun-jssdk.cjs`
- UMD: `dist/yizun-jssdk.umd.js`

## 注意事项

1. 确保在使用前先进行初始化（yiZunSdkInit）
2. 在非浏览器环境下某些功能可能不可用
3. 需要确保页面上存在 id 为 "tellphone" 的输入框以获取手机号,如没有的话请自行在data里传参数

## 错误处理

SDK 会在控制台输出相关错误信息，建议在生产环境中进行适当的错误处理。

```javascript
try {
await window.yiZunSdkTrack({
type: '1_shandong',
step: '页面浏览'
})
} catch (error) {
console.error('追踪事件失败:', error)
}

```