通过 Papo 的 REST API，您可以列出账户中所有可用的 flows，以编程方式激活或停用旅程并将联系人注册到自动化中 — 所有操作都通过经过身份验证的请求完成，无需打开面板。这是将 flows 引擎与外部系统、n8n 工作流、CRM 或内部脚本集成的方式。
Papo API 公开了 flows 资源，使您可以像管理收件箱或联系人一样管理自动化。通过它，开发团队、集成商和白标经销商可以批量控制哪些旅程处于活动状态，将联系人启动到序列中，并将自动化状态与业务流程同步。
通过 API 的 Flow 操作摘要
| 操作 | 描述 | 使用示例 |
|---|---|---|
| 列出 flows | 返回可用的 flows 和序列，包含标识符、名称、类型和状态（活动/不活动）。 | 审计自动化、与外部仪表板同步或检查正在执行的内容。 |
| 激活/停用 flow | 更改特定 flow 的状态，释放或暂停联系人的接收和处理。 | 在维护期间暂停旅程、调整后释放或停用已结束的活动。 |
| 注册联系人 | 将现有联系人插入活动 flow 的开头，开始配置的旅程。 | 包含来自外部 CRM 的潜在客户、在集成后触发欢迎流程或纠正手动输入。 |
API 身份验证如何工作
所有 API 调用，包括涉及 flows 的调用，都需要账户的密钥。它必须作为 Bearer 令牌在 Authorization 标头中发送。账户的公钥是可选的，但如果发送，它必须与密钥的账户相同。
API 的基本 URL 是 https://app.papo.global/api/v1。密钥在 Papo 面板的开发者区域生成。密钥在创建时只显示一次；请将其保存在安全的地方，如果怀疑泄露，请撤销。
身份验证模式与所有端点使用的模式相同：
curl https://app.papo.global/api/v1/me \
-H "Authorization: Bearer sk_live_…" \
-H "X-Papo-Public-Key: pk_live_…"
通过 API 实际管理 flows
尽管每个端点和参数的确切细节在官方 API 文档中，但一般工作流程遵循以下概念步骤：
- 进行身份验证 使用密钥（如果需要，也可以使用公钥）来验证账户。
- 列出 flows 以获取当前的旅程列表，包括其标识符和状态。这允许您映射已存在的内容，并为后续操作选择正确的 flow。
- 更改状态 如果需要，更改特定 flow 的状态。发送请求将 flow 设置为活动（可接收联系人）或不活动（暂停）。只有活动的 flows 处理联系人和接受注册。
- 注册联系人 到活动 flow。提供联系人的标识符和所需 flow 的标识符，将其插入旅程的开头。联系人在 CRM 中的历史记录将保留。
- 与外部系统集成 — 通过 webhooks 或直接调用，您可以启动来自外部表单、另一系统中的事件或数据管道的联系人。
该平台还支持通过 API 创建空的和不活动的 flows，并填充其节点，从而能够以编程方式提供完整的自动化。有关确切的 payload 格式、必填字段和代码示例，请参阅 Papo API 文档中的 flows 部分。
这种集成对谁有意义
- 操作多个自动化的 IT 团队 需要批量暂停、重新激活或监控 flows，而无需手动访问面板。
- 白标经销商 希望自动为每个新客户提供标准化的旅程，注册初始联系人并保持平台之间的一致性。
- 集成商和开发人员 将 Papo 连接到 CRM、ERP 或 n8n 等工具，通过外部事件（购买、注册、预约）触发 flows。
- 处理条件注册的操作，其中联系人只有在通过其他系统中定义的业务规则后才会被包含在 flows 中。
常见问题
我需要密钥来列出 flows 吗？
是的。列出 flows 以及任何返回账户数据的操作都需要使用密钥进行身份验证。模式与所有其他端点相同：在 Authorization 标头中发送 Bearer 令牌。
我可以通过 API 激活或停用 flow 吗？
是的。API 允许在活动和不活动之间更改 flow 的状态。您需要 flow 的标识符和密钥。不活动的 flows 不接收联系人，即使尝试注册，也不会在旅程中前进。
如何通过 API 将联系人注册到 flow？
在注册调用中提供联系人的标识符和活动 flow 的标识符。联系人将被插入旅程的开头，而不会删除对话历史或个人资料数据。官方文档详细说明了参数的确切格式。
可以通过 API 从零开始创建 flow 吗？
是的。API 允许创建一个空的（仅包含 Start 节点）且不活动的 flow，并用问题、消息和条件填充其节点。这对于可扩展地提供自动化非常有用，特别是在经销或新客户入职场景中。
API 在列出时是否返回每个 flow 的状态？
是的。列表包括每个 flow 和序列的状态（活动或不活动），以及标识符、名称和类型，允许外部系统监控哪些正在运行，哪些已暂停。
我在哪里可以找到 flows 路由的完整文档？
官方文档可在 https://papo.global/pt/docs 找到。在那里您可以找到所有端点、接受的参数、错误代码和多种语言的示例。flows 路由遵循与其他模块相同的 REST 模式和身份验证。
另请参阅
在 Papo 创建免费账户，访问 API 密钥，并将您的自动化与外部世界连接起来。