Nudgen API

将你的产品连接到 Nudgen

使用个人访问令牌验证的 REST API。以编程方式管理联系人、活动、模板和设置。

线上应用

https://app.nudgen.com

PAT 验证

使用标准的 Bearer 标头通过个人访问令牌进行验证。在 Nudgen 控制面板中生成。

规范的 REST

可预测的、面向资源的 URL,使用标准的 HTTP 方法和响应代码。

速率限制

针对每个团队和端点内置速率限制,以保护您的工作流并确保公平性。

安全访问

在 设置 → API Keys 创建个人访问令牌,并在每次请求中携带。

curl -X GET https://app.nudgen.com/api/v1/user/me \ -H "Authorization: Bearer <your-pat>"

API 参考

你的应用和 Agent 现在可用的资源。

验证与身份

获取当前通过验证的用户信息。

GET/api/v1/user/me

列出当前用户的所有团队。

GET/api/v1/teams

切换活动的团队上下文。

POST/api/v1/teams/switch

联系人

通过分页、搜索和标签过滤器列出联系人。

GET/api/v1/contacts

创建新联系人。

POST/api/v1/contacts/add

检索特定联系人。

GET/api/v1/contacts/:id

更新现有联系人。

PATCH/api/v1/contacts/:id

删除联系人。

DELETE/api/v1/contacts/:id

营销活动

列出当前团队中的营销活动。

GET/api/v1/campaigns

创建新营销活动。

POST/api/v1/campaigns

获取营销活动详情。

GET/api/v1/campaigns/:id

获取营销活动交付统计数据。

GET/api/v1/campaigns/:id/stats

模板

列出邮件模板。

GET/api/v1/templates

创建新邮件模板。

POST/api/v1/templates

设置

获取品牌配置。

GET/api/v1/settings/brand

更新品牌设置。

PATCH/api/v1/settings/brand