@crvouga/ 嘲笑鸟 - 服务 - 客户

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

状态模拟器 顾客.io 测试套房,服务所有三个主机 我们的代码谈话从 一个进程: 与段相兼容 发展政策委员会 (单位:千美元)identify, (中文(简体) ), track, (中文(简体) ), batch,与 @customerio/cdp-analytics-node 员额) 应用 API 交易发送(电子邮件、短信、, 、收件箱信息、信息目录、配置属性读取、发送者选择退出调节、交付状态读取、以及 链接跟踪 点击结束点。 在一个发包箱中发送一个套件(并读取链接) (一) 报告活动(unsubscribed, (中文(简体) ), subscribed, (中文(简体) ), spammed,订阅偏好, clicked并签署客户签名的方式.

• 行动范围: 支助
• 合同openapi.yaml)由Customer.io的CDP(分块谱)和App API手写 参考书目,与我们的消费者寄送的东西相对应.

安装

npm install -D @crvouga/mockingbird-service-customerio

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-customerio serve, (中文(简体) ), createServer 从 ./server (节点),或 createRuntime 与任何获取服务器.

使用量

应用程序硬码为Customer.io的每个区域主机(customer-io.config.ts,接合G-Y1):一次 它们被env驱动,指向 CDP 主机(SDK's host, App API 主机和链接 跟踪模拟器中的域。 顾客.io只运行当 CUSTOMERIO_RUNTIME_ENABLED 开始和 舞台已经进入 CUSTOMERIO_ALLOWED_STAGES。 。 。 .

npx mockingbird-customerio serve --port 8810 \
  --webhook-url http://127.0.0.1:3000/v1/customer-io/reporting-webhook \
  --webhook-secret "$CUSTOMERIO_REPORTING_WEBHOOK_SIGNING_KEY"

import { Analytics } from "@customerio/cdp-analytics-node"
import { createServer } from "@crvouga/mockingbird-service-customerio/server"

const cio = await createServer({
  webhooks: { url: "http://127.0.0.1:3000/v1/customer-io/reporting-webhook", secret: "k".repeat(32) },
})

// The application's CDP client. Only its host changes.
const analytics = new Analytics({ writeKey: "wk", host: cio.url, maxEventsInBatch: 1 })
analytics.identify({ userId: "42", traits: { email: "[email protected]" } })
await analytics.closeAndFlush()

// Test control. The member unsubscribes in Customer.io: the signed reporting event reaches the backend.
await fetch(`${cio.url}/__admin/reporting-events`, {
  method: "POST",
  headers: { "content-type": "application/json" },
  body: JSON.stringify({ metric: "unsubscribed", userId: "42", objectType: "customer" }),
})
await cio.close()

交易发送通过 App API 客户端(customerio-node),指出这一点 模拟器。 测试内容是:

import { Analytics } from "@customerio/cdp-analytics-node"
import { APIClient, SendEmailRequest } from "customerio-node"
import { createServer } from "@crvouga/mockingbird-service-customerio/server"

const cio = await createServer()

// The application's clients. Only the CDP host and the App API url change.
const analytics = new Analytics({ writeKey: "wk", host: cio.url, maxEventsInBatch: 1 })
const api = new APIClient("app-key", { url: `${cio.url}/v1` })
analytics.identify({ userId: "42", traits: { email: "[email protected]" } })
await analytics.closeAndFlush()
await api.sendEmail(
  new SendEmailRequest({ transactional_message_id: 1, identifiers: { id: "42" }, to: "[email protected]" }),
)

// Test assertions read the emulator's state.
const profiles = await (await fetch(`${cio.url}/__admin/profiles`)).json()
const deliveries = await (await fetch(`${cio.url}/__admin/outbox?userId=42`)).json()
await cio.close()

路线

汇报网点

POST <webhook-url> 与 x-cio-timestamp: <unix seconds> 财务报告和审定财务报表 x-cio-signature: <hex HMAC-SHA256(secret, "v0:<timestamp>:<body>")> (墙-钟时间戳. 车身 : {event_id, object_type, metric, timestamp, data: {identifiers: {id, email, cio_id}, customer_id, email_address, delivery_id?, transactional_message_id?, href?, link_id?, content?}}· ; content 是订阅首选项的 JSON 字符串. timestamp 永远不要赶在时分前跑 (我们的接收器拒绝事件 > 5分钟). 报复, GET /__admin/webhooks, (中文(简体) ), …/events, (中文(简体) ), …/replay, (中文(简体) ), …/flush 财务报告和审定财务报表 PUT /__admin/webhook-endpoints 工作如常.

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}· ; GET /__admin/faults/presets: transactional_message_missing (400元误差: trigger_name_missing然后退后,不交付, transactional_404, (中文(简体) ), request_timeout_408 (408) 排队前,不交货,含糊不清, server_error (500后再排队,不交付,含糊不清), accepted_but_500 (排好,然后500), rate_limited (429 有数字) Retry-After当然,没有交付, invalid_app_key, (中文(简体) ), send_drop 财务报告和审定财务报表 send_drop_before_accept (口袋在排队前关闭:模棱两可,不交货), send_drop_after_accept (交货记录,然后插座关闭:模棱两可,一次交货), cdp_unavailable (503; SDK 重试),, cdp_bad_request (400;没有重试), cdp_slow (15 s,过去) 10s的交货暂停, transactional_list_unavailable, (中文(简体) ), omit_trigger_names (单位:百万 trigger_name,或仅 params.ids, (中文(简体) ), webhook_duplicate, (中文(简体) ), webhook_drop, (中文(简体) ), webhook_reorder。 。 。 . 人工断层可以注射403或503或429个 Retry-After 是一个 HTTP 日期。 终止 (肯定失败)是被停止的仿真器,而不是预设. 401号 {error} 政策发展协调委员会 {meta: {error}} 在应用API。 映射到相同名称空间的密钥共享配置和交付; 两个命名空间不包含断层和时钟相冲。 重置一个命名空间 留下另一个.

命名空间

x-mockingbird-namespace页:1 /__admin/ns/<name> 在主机或按键上设置前缀: CDP 写入密钥( Basic 用户名)或 App API 密钥 (Bearer) 通过 PUT /__admin/credentials {"credentials": {"<key>": "<namespace>"}}。点击端点不带证书:使用页眉或前缀.

故意不模拟

• Opt-out通过公共PUT API,电话标识工作空间配置,Twilio发件人身份外壳恢复,以及自动载体停止回调. 使用管理员控制来脚本调和器状态;它不模拟承运人的交付执行.
• 渲染: 未提供模板; 发件箱持有 message_data,而不是HTML. 翻译:.
• 运动、片段、出行、广播和轨道 APItrack.customer.io) (中文(简体) ).
• 发展政策委员会 page, (中文(简体) ), screen, (中文(简体) ), group 财务报告和审定财务报表 alias 电话(我们的消费者不发送).
• 附件仅用文件名记录 。 客户.io文件a {filename: base64} 地图; 我们的后端发送 [{filename, content, content_type}]二者均被接受;是否真实 API接受阵列形式未经验证(没有沙盒证书).
• 持发委东道机构{success: true})和准确的 App API 错误字符串 transactional_message_id not found 未经证实.

API 密码

部分 嘲笑鸟。 。 。 .