API 密钥
API 密钥是 Bearer 令牌，用于授予对 LeadHub REST API 的程序化访问权限。您可以使用它们构建自定义集成、与其他系统同步数据或通过代码自动化任务。
创建 API 密钥
- 进入集成 → API 密钥。
- 点击新建 API 密钥。
- 填写以下内容：
| 字段 | 说明 |
|---|---|
| 名称 | 描述性名称（例如"我的应用集成"、"Zapier"） |
| 权限 | 该密钥可执行的操作（只读或读写） |
| 过期时间 | 可选的过期日期；留空表示永不过期 |
- 点击保存。
- 立即复制令牌 — 仅显示一次。如果丢失，必须重新生成。
使用 API 密钥
在每个 API 请求中，将密钥作为 Bearer 令牌包含在请求头中：
GET /api/leads HTTP/1.1
Host: yourdomain.com
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json
API 端点
| 方法 | 端点 | 说明 |
|---|---|---|
GET | /api/leads | 列出所有线索（分页） |
GET | /api/leads/{id} | 获取单条线索 |
POST | /api/leads | 创建新线索 |
PUT | /api/leads/{id} | 更新线索 |
DELETE | /api/leads/{id} | 删除线索 |
GET | /api/pipelines | 列出销售管道 |
GET | /api/tags | 列出标签 |
POST | /api/leads/{id}/tags | 为线索添加标签 |
完整 API 参考文档可在您安装的 LeadHub Swagger 文档中查看，路径为 /api/documentation。
撤销密钥
撤销 API 密钥的步骤：
- 进入集成 → API 密钥。
- 点击密钥行上的删除图标并确认。
密钥立即失效。使用该密钥的所有请求将收到 401 未授权响应。
安全最佳实践
- 切勿将 API 密钥提交到版本控制系统（GitHub、Bitbucket 等）
- 仅需读取数据时，使用只读密钥
- 为临时集成使用的密钥设置过期日期
- 如果密钥可能泄露，立即撤销
- 每个集成使用一个独立密钥，便于单独撤销