要开始使用 Papo Global API(https://papo.global/),你需要在面板中生成密钥,使用 Authorization 请求头对请求进行身份验证,并向基础地址 https://app.papo.global/api/v1 发起 REST 调用。第一个实际测试是用简单的 cURL 命令列出 Extrator 的联系人。
Papo API 是 REST API,使用 JSON,并接受来自任何来源的请求(CORS 已开放)。通过它,你可以将 CRM、自动化平台(如 n8n)、ERP 或你自己的后端连接到 Papo 的客户服务、销售和 AI 生态系统。
核心要素概览
| 要素 | 说明 |
|---|---|
公钥(pk_live_…) |
你账户的固定标识符,可以暴露在前端 |
密钥(sk_live_…) |
身份验证令牌,必须保密,并且仅在服务器端使用 |
| 身份验证 | 在所有调用中使用请求头 Authorization: Bearer sk_live_...(或 X-Papo-Secret-Key),但 GET /api/v1 除外 |
| 基础 URL | https://app.papo.global/api/v1 |
| 示例端点 | GET /api/v1/contacts — 列出提取的联系人(Extrator),支持分页 |
首次调用分步指南
1. 创建 API 密钥
访问 Papo 面板中的开发者页面(位于 app.papo.global/developers)。在那里,你可以生成一个命名的密钥——例如“primeiro-teste”——并立即复制它。该密钥仅显示一次;之后你只能撤销它并创建新的。
公钥(pk_live_…)按账户固定,并随时可在同一页面查看。虽然请求中可选,但如果你发送它,它必须与所用密钥属于同一账户。
2. 选择端点
本指南中,我们将使用 GET /api/v1/contacts,它列出由 Extrator 模块提取的潜在客户。你可以使用 page(默认 1)和 per_page(1 到 100,默认 20)参数对结果分页。也接受使用 q 进行文本查询,以按公司、电话或电子邮件搜索。
3. 使用 cURL 发起调用
拿到密钥后,构建请求。以下示例列出最多 20 个联系人:
curl "https://app.papo.global/api/v1/contacts?page=1&per_page=20" \
-H "Authorization: Bearer sk_live_…"
将 sk_live_… 替换为你的密钥。如果你想使用备用请求头,请执行:
curl "https://app.papo.global/api/v1/contacts" \
-H "X-Papo-Secret-Key: sk_live_…"
响应是一个 JSON,包含 success: true,数据位于 data 对象内。如果出错,JSON 将包含 success: false 以及一个带有说明性代码和消息的 error 对象。
从这里开始,你可以探索 API 页面 中记录的其他端点,例如发送消息(POST /api/v1/messages)、账户详情(GET /api/v1/me)或使用 AI 补全文本(POST /api/ai/v1/complete)。
本指南适合谁
本内容面向希望将 Papo 与外部系统集成的开发者——CRM、自动化工具(例如 n8n)或自有应用。如果你是只想连接渠道并接待客户的最终用户,帮助中心提供了其他更合适的文章。
常见问题
我需要在每次调用中都发送公钥吗?
不需要。公钥是可选的。如果你选择发送它,它必须与所用密钥的账户匹配。
密钥会过期吗?
不会自动过期。如果你怀疑泄露,可以随时通过面板撤销它并创建新的。
我可以使用免费账户测试 API 吗?
可以。Papo 的第一个用户免费,你可以生成密钥来探索 API。访问 Extrator 等模块可能会根据使用情况消耗余额,但创建密钥和基本读取调用可以无额外成本测试。
如果我丢失了密钥怎么办?
在开发者面板中创建一个新的命名密钥。之前的密钥无法恢复;为了安全只能撤销。
我可以使用 API 发送批量消息吗?
可以,POST /api/v1/messages 端点允许发送文本消息。但是,请遵守同意政策和平台使用条款。
API 只列出 Extrator 的联系人吗?
GET /api/v1/contacts 端点返回提取的联系人。要管理 CRM 的统一数据库(搜索、创建和更新任何联系人),你可以查阅完整的 API 文档。
另请阅读:如何使用 Papo API 创建注册表单并自动填充 CRM · 如何使用 Papo API 监控白标经销商积分消耗和发票
第一个用户 R$ 0,无需信用卡。了解更多请访问 papo.global。