使用文档

快速开始

本指南将帮助您快速完成 AntDock SDK 的接入。

步骤 1: 获取 App ID

  1. 登录 AntDock 控制台
  2. 创建新网站/应用
  3. 复制生成的 App ID

步骤 2: 安装 SDK

根据您的平台选择对应的安装方式:

Web (Script 标签)

最简单的方式,直接在 HTML 中添加:

<script defer src="https://你的域名/static/tracker.js"
  data-app-id="your-website-id">
</script>

微信小程序

  1. 下载 SDK 源码到项目 utils/antdock/ 目录
  2. 初始化:
// app.js
const AntDockTracker = require('./utils/antdock/index')

App({
  onLaunch() {
    AntDockTracker.init({
      appId: 'your-website-id',
      endpoint: 'https://你的域名'
    })
  }
})

iOS (Swift)

  1. 将 SDK Swift 文件添加到 Xcode 项目
  2. 初始化:
AntDockTracker.shared.initialize(
    appId: "your-website-id",
    endpoint: "https://你的域名"
)

Android (Kotlin)

  1. 将 SDK Kotlin 文件复制到项目
  2. 添加依赖并初始化:
AntDockTracker.initialize(
    context = this,
    config = AntDockConfig(
        appId = "your-website-id",
        endpoint = "https://你的域名"
    )
)

React Native

  1. 将 SDK 源码复制到项目
  2. 安装 @react-native-async-storage/async-storage
  3. 初始化:
import { AntDockTracker } from './lib/antdock'

AntDockTracker.init({
  appId: 'your-website-id',
  endpoint: 'https://你的域名'
})

Flutter

  1. 将 SDK 源码复制到项目
  2. 添加 shared_preferences 和 http 依赖
  3. 初始化:
await AntDockTracker.init(
  appId: 'your-website-id',
  endpoint: 'https://你的域名',
);

步骤 3: 追踪事件

初始化完成后,您可以开始追踪事件:

页面访问

// Web SDK 会自动追踪页面访问
// 手动追踪可使用:
antdock.trackPageView('/custom-path')

自定义事件

// 追踪按钮点击
antdock.trackEvent('button_click', {
  button_id: 'submit-form',
  button_text: '提交'
})

// 追踪购买
antdock.trackEvent('purchase', {
  order_id: 'ORD-12345',
  amount: 99.99
})

用户标识

// 用户登录后调用
antdock.identify('user-123', {
  email: 'user@example.com',
  name: '张三'
})

步骤 4: 验证数据

本地地址默认不统计,请在线上地址或隐身窗口验证。

  1. 打开浏览器开发者工具 (F12)
  2. 切换到 Network 标签
  3. 筛选 /api/collect
  4. 执行一些操作,查看请求是否正常发送

常见问题

数据没有出现?

  1. 检查 App ID 是否正确
  2. 检查 endpoint 地址是否可访问
  3. 检查浏览器控制台是否有错误
  4. 广告拦截器可能会阻止追踪请求

如何禁用自动追踪?

antdock.init({
  appId: 'your-website-id',
  autoTrack: false
})

SDK 获取与许可

使用控制台提供的接入脚本或下载包。SDK 尚未公开发布到 npm 或公共 GitHub 仓库;分发和修改权限以下载包附带的许可及平台说明为准。

下一步