调用 API 前必须先获取 API Key
所有 API 请求均需通过 X-API-Key 请求头进行身份认证。没有有效的 API Key,任何端点都无法调用。
概述
ImgRoute API 使用 API Key 进行身份认证。所有 API 请求都必须携带有效的 API Key,否则会返回 401 Unauthorized 错误。
获取 API Key
- 登录 ImgRoute 账户
- 进入控制台 → 高级功能
- 在「API Key 管理」卡片中点击「生成 Key」
- 复制并妥善保管生成的 Key(仅展示一次)
注意:每个用户仅允许一个活跃的 API Key。重新生成会使旧 Key 立即失效,请谨慎操作。
传递方式
使用 X-API-Key 请求头传递 API Key:
X-API-Key: sk-ir-a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
常见认证错误
| 错误码 | 说明 | 解决方案 |
|---|---|---|
MISSING_API_KEY | 请求未携带 API Key | 添加 X-API-Key 请求头 |
INVALID_API_KEY | API Key 格式或值无效 | 检查 Key 是否正确,确认未过期或被撤销 |
安全建议
- 不要将 API Key 直接硬编码在代码中,建议使用环境变量
- 不要在客户端代码中暴露 API Key
- 定期更换 API Key
- 如果 Key 泄露,立即在控制台重新生成
示例代码
import os
import requests
API_KEY = os.environ.get("IMGROUTE_API_KEY")
headers = {"X-API-Key": API_KEY}
response = requests.get(
"https://imgroute.com/api/v1/list",
headers=headers
)
print(response.json())