Skip to main content
Home
  • 集成
  • API 密钥

API 密钥

API密钥为Bearer令牌，用于程序化调用LeadHub REST API；可开发自定义集成、跨系统同步数据、代码自动化业务任务。

#创建API密钥

  1. 进入 集成 → API 密钥。
  2. 点击新建 API 密钥。
  3. 配置参数：
字段 说明
名称 标识用途，例如“我的应用集成”、“Zapier”
权限 访问权限：只读 / 读写
过期时间 可选过期日期；留空代表永不过期
  1. 保存，立即复制令牌；密钥仅展示一次，丢失只能重新生成。

#请求鉴权方式

HTTP请求头携带Authorization: Bearer YOUR_API_KEY_HERE完成身份校验。

http 
GET /api/leads HTTP/1.1
Host: shturl.cc/mD6K
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文档访问实例路径 /api/documentation（Swagger）。

#撤销密钥

  1. 进入 集成 → API 密钥。
  2. 点击删除图标确认操作。

撤销后密钥立刻失效，使用该密钥的请求返回401未授权。

#安全最佳实践

  • 禁止提交密钥到代码版本库（GitHub、Bitbucket等）
  • 仅读取数据场景，优先使用只读密钥
  • 临时使用的密钥设置过期时间
  • 密钥疑似泄露，立刻执行撤销
  • 不同业务集成使用独立密钥，便于单独关停。