@subscriber.dev / sdk
的TypeScript SDK subscriber.dev：添加订阅者并从你的应用程序中触发工作流。
npm install @subscriber.dev/sdk
获取API密钥
subscriber keys create "Acme app"
键属于一个环境，因此请求不会命名它。它只显示一次：将其存储为 SUBSCRIBER_API_KEY 把它保存在你的服务器上。
关键是 limited 默认情况下：它可以创建和更新订阅者并触发工作流。通过 --access full 为了其他的一切。看到 身份验证.
使用它
import { Subscriber } from "@subscriber.dev/sdk";
const client = new Subscriber(process.env.SUBSCRIBER_API_KEY);
await client.workflows.trigger({
key: "welcome",
subscriber: { email: "[email protected]", firstName: "Jane" },
payload: { plan: "pro" },
});
new Subscriber() 没有参数的情况下读取 SUBSCRIBER_API_KEY． 每次调用返回 { data, response }.
错误
失败的请求会抛出 SubscriberError 与API的消息和状态：
import { SubscriberError } from "@subscriber.dev/sdk";
try {
await client.workflows.trigger({ key: "welcome", subscriber: { email } });
} catch (error) {
if (error instanceof SubscriberError && error.status === 404) {
console.warn(error.message);
}
}
error.errors 列表上的无效字段 400.
选项
new Subscriber(apiKey, {
baseUrl: "https://api.yourdomain.com",
fetch: customFetch,
});
使用 baseUrl 如果你 self-host.
许可证
麻省理工学院