认证
每个发往 API 的请求都携带 API 密钥。请求绝不会与浏览器会话关联。
创建 API 密钥
在您账户的 API 密钥 页面创建,最多 5 个。登录后,您可以随时在该页面复制 API 密钥:我们会加密保存,并且只向您显示。请像对待密码一样对其保密;如果它可能已被他人看到,请吊销它并创建一个新的。
发送 API 密钥
在 Authorization 标头中发送,格式为 Bearer 后接密钥。也可以使用 X-API-Key。
curl "https://api.talismanleads.io/v1/account" \
-H "Authorization: Bearer tl_live_your_key_here"API 密钥的权限
新的 API 密钥可以执行所有操作:查看您的余额、检测器、订单及其结果,并使用 POST /uploads、POST /estimates 和 POST /orders,这些接口会存储您的列表或花费您的余额。2026 年 11 月 8 日之前创建的密钥可能是只读的:它可以查看所有内容,但上述三个接口会拒绝它,并返回 missing_scope。
过期与 IP 地址
新的 API 密钥永不过期,并且可以从任何地址使用。2026 年 11 月 8 日之前创建的密钥可能设有过期日期,过期后会被拒绝并返回 expired_key;也可能限定为只能从您服务器的 IP 地址使用,来自其他地方的请求会被拒绝并返回 ip_not_allowed。如需更改其中任何一项,请创建一个新密钥并吊销旧密钥。
保护 API 密钥的安全
- 请像对待密码一样对待 API 密钥:任何持有它的人都可以花费您的余额。
- 只在您的服务器上使用。API 不允许从网页发起调用。
- 不要将它写入您的代码或版本控制系统。
- 如果 API 密钥可能已被他人看到,请立即在账户中吊销。它会立刻失效。已下的订单会继续运行。
- 只将它发送给 API。上传和下载链接自带权限,因此不要把 API 密钥发送给这些链接。
API 密钥被拒绝时
错误、已吊销或已过期的 API 密钥返回 401。已被封禁的 API 密钥或账户返回 403。请参阅错误。