为了将您的账户与外部系统（如 CRM、ERP 或自动化平台 n8n、Zapier）集成，Papo (https://papo.global/) 提供了 API（应用程序编程接口）密钥，您可以在控制面板中直接生成和管理这些密钥。这些密钥作为安全凭证，授权其他软件以编程方式访问您的 Papo 账户并执行操作。
Papo 的 API 允许您构建互联的工作生态系统，自动化从发送 WhatsApp 消息到提取合格潜在客户等任务。为确保安全，Papo 采用双密钥系统：一个公共密钥用于身份识别，一个秘密密钥用于身份验证。
| 密钥类型 | 描述 | 安全级别 | 使用示例 |
|---|---|---|---|
公共密钥 (pk_live_...) |
您的 Papo 账户的唯一固定标识符。 | 低。可公开暴露。 | 在您网站的前端脚本中识别您的账户。 |
秘密密钥 (sk_live_...) |
API 的“密码”。用于验证您的请求并授权以您的账户名义执行操作。 | 高。必须绝对保密。 | 从您的服务器（后端）验证 API 调用以发送消息。 |
如何生成和查找您的 API 密钥
API 密钥在您的 Papo 账户的特定区域进行管理。请按照以下步骤访问它们。
- 访问您的 Papo 控制面板并导航至 设置。
- 在设置菜单中，查找 开发者 或 API 部分。
- 在此页面上，您将找到您的 公共密钥 (
pk_live_...)，它是固定的，可以随时复制。 - 对于 秘密密钥，您需要生成一个新的。点击按钮创建新密钥。
- 为密钥提供一个描述性名称，指明其用途（例如：“CRM 集成”、“N8N 自动化”）。这有助于在需要时识别和撤销特定密钥。
- 创建后，秘密密钥 (
sk_live_...) 将仅显示一次。请复制并将其保存在安全位置，例如密码管理器或服务器上的环境变量中。出于安全原因，Papo 不会存储密钥的原始值，也无法再次显示它。
如果您丢失了秘密密钥或怀疑它已泄露，请立即在控制面板中撤销它并创建一个新密钥。
如何使用密钥进行 API 身份验证
所有涉及操作或访问私人数据的 Papo API 通信都必须经过身份验证。这通过在 HTTP 标头中发送秘密密钥来完成。
所有 API 调用的基本 URL 是：https://app.papo.global/api/v1
要进行身份验证，请在请求的 Authorization 标头中包含您的秘密密钥，前面加上 Bearer 一词。
使用 curl 获取您的账户数据的请求示例：
curl https://app.papo.global/api/v1/me \
-H "Authorization: Bearer sk_live_SUA_CHAVE_SECRETA_AQUI"
在此示例中：
sk_live_SUA_CHAVE_SECRETA_AQUI必须替换为您的真实秘密密钥。/me端点返回有关已验证账户的信息，可作为检查您的密钥是否正常工作的良好测试。
公共密钥 (pk_live_...) 可以选择性地在 X-Papo-Public-Key 标头中发送作为额外验证，但主要身份验证始终通过秘密密钥完成。
您可以使用 Papo API 做什么？
API 为自动化和集成您的操作提供了广泛的可能性。以下是一些您可以执行的示例：
- 发送 WhatsApp 消息： 创建脚本，通过您连接的号码发送通知、警报或事务性消息。
- 从 Extrator 检索联系人： 访问您使用 Extrator de CNPJ 提取的潜在客户列表，以便将其与您的主要 CRM 同步。
- 管理实例： 列出并检查您的 WhatsApp 连接状态。
- 使用人工智能： 将文本发送到 Papo 的 AI 引擎，并接收根据您配置的提示生成的回复。
- 同步数据： 使您的内部系统（ERP、BI）与 Papo 中生成的数据保持同步。
常见问题 (FAQ)
### 在哪里可以找到完整的 API 文档？
详细的技术文档，包含所有端点、参数以及不同语言（JavaScript、Python）的代码示例，可在 papo.global/pt/docs 公开查阅。
### 我的秘密密钥泄露了。我该怎么办？
如果您怀疑您的秘密密钥已泄露，请立即访问 Papo 控制面板中的开发者区域，在列表中找到泄露的密钥并点击 撤销。一旦撤销，该密钥将无法再用于验证请求。然后，生成一个新密钥以替换您集成中的旧密钥。
### 我可以创建多少个秘密密钥？
您可以创建多个秘密密钥。一个良好的安全实践是为每个您集成的系统或环境（例如：一个用于您的 CRM，一个用于您的自动化系统，一个用于测试环境等）生成一个不同的密钥。这允许您撤销特定系统的访问权限而不会影响其他系统。
### 我可以在网站前端使用公共密钥吗？
是的，公共密钥 (pk_live_...) 被设计为在公共环境（例如您网站的 JavaScript 代码）中安全使用。它的功能仅是识别您的账户，而不是验证操作。另一方面，秘密密钥绝不应暴露在客户端代码中。
### Papo API 和 Webhook 有什么区别？
主要区别在于谁发起通信。使用 API，您的系统发起操作：您“请求”（拉取）Papo 的数据或“命令”（推送）Papo 执行某项操作，例如发送消息。使用 Webhook，Papo 发起操作：当特定事件发生时（例如：联系人到达 Flow 的某个阶段），它会自动将数据“推送”到您的系统。
### Papo API 和 WhatsApp 官方 API 有什么区别？
WhatsApp 官方 API 专注于 WhatsApp 渠道的功能。Papo API 是一个更广泛、更强大的抽象层：它允许您不仅控制 WhatsApp，还可以控制平台上的其他模块，例如 CRM、潜在客户提取器和人工智能引擎，所有这些都通过一套统一的密钥以简化方式进行。
另请阅读
第一个用户免费，您可以测试您的号码上的自动化和集成。