mcpField
L
loops-api

loops-api

github.com/loops-so营销与增长121.6k 次安装今天更新
代码仓库

关于 loops-api

loops-api 面向开发者,帮助在应用代码、后端服务和 Webhook 处理中集成 Loops。它指导 SDK 与 HTTP API 的选择,并涵盖受众、邮件、活动和工作流操作。

主要功能

  1. 01选择 SDK 或 HTTP API
  2. 02管理联系人、列表和事件
  3. 03执行邮件与活动 API 操作
  4. 04管理工作流及其节点
  5. 05接收并验证 Webhook

适用场景

  1. 01将 Loops 集成到应用后端
  2. 02通过 API 管理联系人和邮件
  3. 03创建活动或配置工作流
  4. 04接收并验证 Loops Webhook

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/loops-so/skills --skill loops-api

安装后在 Claude Code 中输入/loops-api确认已加载。

附带文件references/http-api.md

详细介绍

Loops API 和 SDK 技能

此技能可帮助你在应用代码中完成 Loops 实现工作流。可用于后端集成、精确的请求指导,以及 SDK 或 HTTP 的选择。

何时使用

当用户需要进行以下操作时,请使用此技能:

  • 将 Loops 集成到应用、后端、Webhook 或自动化流程中
  • 在官方 SDK 和原始 HTTP 请求之间做出选择
  • 管理联系人、联系人属性、邮件列表、事件或事务性邮件
  • 发送事务性邮件,或通过 API 创建、编辑和发布事务性邮件模板
  • 管理联系人的抑制状态或移除联系人
  • 创建草稿营销活动,并设置受众定位(邮件列表、细分群组或筛选条件)、群组和发送时间
  • 将营销活动和事务性邮件归入群组
  • 列出或创建用于营销活动/工作流定位的受众细分群组
  • 更新邮件消息内容(主题、发件人、CC/BCC、格式、回退内容、LMX)、发送预览并运行 Guardian 检查
  • 列出、创建、更新和获取主题与组件,以构建 LMX 负载
  • 上传邮件内容所需的图片
  • 创建、更新、检查和删除工作流及工作流节点(包括邮件列表变更、分支、重新路由和排队联系人的处理)
  • 列出工作流事件触发器的事件模式
  • 接收并验证 Loops 入站 Webhook(联系人、邮件发送和互动事件)
  • 验证凭据,或排查代码中的 Loops 请求行为

此技能用于实现和运营,不用于广泛的邮件策略或送达能力审查。

工作方式

启用此技能时:

  1. 首先选择合适的接口:SDK 或原始 HTTP 请求。
  2. 对于应用代码,如果该语言有官方 SDK,则优先使用。
  3. 仅在没有可用 SDK,或用户需要精确控制负载时,才优先使用原始 HTTP 请求。
  4. 在服务端发送 Loops 请求。
  5. 细节至关重要时,请根据官方文档或 OpenAPI 规范核实具体行为。
  6. 对于 LMX 邮件设计或品牌相关工作,请使用 references/http-api.md 中的主题/组件端点;LMX 设计策略位于 loops-lmx 技能中。
  7. 如果任务主要涉及 Loops CLI 的安装、身份验证、Shell 用法或命令帮助,请使用单独的 loops-cli 技能。

官方参考资料:

  • 文档:https://loops.so/docs
  • API 参考:https://loops.so/docs/api-reference/intro
  • 营销活动示例:https://loops.so/docs/api-reference/examples/campaigns
  • JavaScript SDK:https://loops.so/docs/sdks/javascript
  • Webhook:https://loops.so/docs/webhooks
  • OpenAPI 规范:https://app.loops.so/openapi.json

选择接口

  • SDK 或 HTTP API:
    • 应用代码
    • 后端服务
    • Webhook 处理程序
    • 可重复使用的集成 阅读 references/http-api.md

如果用户是在终端中操作,而不是编写应用代码,请使用 loops-cli 技能。

分类路由

  • 身份验证、基础 URL、速率限制、联系人、抑制、属性、列表、事件、上传、Loops 入站 Webhook、SDK 示例和 HTTP 错误: 阅读 references/http-api.md
  • 营销活动、营销活动群组、事务性邮件群组、受众细分群组、工作流、工作流节点、事件模式、事务性邮件、邮件消息、主题、组件和确保修订安全的更新: 阅读 references/http-api.md。对于 LMX 标记语言本身,也请使用 loops-lmx 技能。

输出检查清单

请尽量让用户获得以下内容:

  • 适合该任务的 API 接口选择
  • 精确的负载结构或 SDK 用法
  • 任何会影响行为的 Loops 特定注意事项
  • 下一步验证操作,例如发送小型测试请求或检查 API 密钥

评论

支持 Markdown