SuperAPI AI 工具集

klaviyo-hello-world

编程与开发

查看项目

更新于 10-15 23:26

技能介绍

用途:这是一个 Klaviyo 集成的冒烟测试示例,在正式开发前验证 API 密钥、SDK 安装和网络路径是否全部可用。

主要能力:脚本按顺序完成四件事——用 profilesApi.createProfile 创建 profile;用 eventsApi.createEvent 追踪事件(metric 首次使用时创建,通过 email 关联 profile);用 profilesApi.getProfiles 查询确认写入成功;最后整体运行脚本。

使用方式:需先完成 klaviyo-install-auth 配置,在环境中导出 KLAVIYO_PRIVATE_KEY(具备 Profiles 和 Events 权限的私有 API 密钥),项目中安装 klaviyo-api(npm install klaviyo-api),并可用 tsx 运行 TypeScript 文件。将代码写入单个 hello-klaviyo.ts,然后执行 npx tsx hello-klaviyo.ts。

SDK 约定:属性使用 camelCase(如 firstName、phoneNumber、lastName);所有请求体采用 JSON:API 的 { data: { type, attributes } } 结构;响应通过 response.body.data 读取;profile 可用 email、phoneNumber 或 externalId 标识。

输出与错误:运行后每个操作打印一行,profile ID 为 26 位 ULID,Verified 行回显 firstName 以证明往返成功。常见错误包括重复 profile(409,可改用 createOrUpdateProfile)、邮箱格式错误(400)、缺少 metric 名称(400)、密钥无效(401)。

适用场景与限制:适合新集成起步、环境自检和学习基础 profile 与事件调用;资料未提供更完整的业务工作流、收费或平台细节,后续可参考 klaviyo-local-dev-loop 与 klaviyo-core-workflow-a。