身份验证
身份验证
每个对 FourA API 的 request 都需要身份验证。本页说明如何获取、使用和管理您的 API key。
获取 API key
- 登录 FourA 控制台
- 转到 API Keys 页面
- 点击 Create Key
- 从确认对话框复制 key
您的 API key 如下所示:pk_live_a1b2c3d4e5f6...
现在创建的 key 支持重新查看:日后可通过点击 key 所在行的眼睛图标,按需显示完整的密钥 (有关查看流程和权限,请参见管理 API key)。在查看功能发布前创建的旧 key 无法重新查看,并会显示锁定图标;请重新生成一次即可切换。
使用 API key
在每个 request 的 X-API-Key header 中包含您的 API key:
curl -X POST https://eu.api.foura.ai/api/single/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"method": "GET", "url": "https://example.com"}'
在 Python 中:
import requests
response = requests.post(
"https://eu.api.foura.ai/api/single/",
headers={
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={"method": "GET", "url": "https://example.com"}
)
在 Node.js 中:
const response = await fetch('https://eu.api.foura.ai/api/single/', {
method: 'POST',
headers: {
'X-API-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});
API key 安全
请像对待密码一样对待您的 API key:
- 不要将其提交到版本控制系统中。 请改用环境变量。
- 不要在客户端代码中泄露。 仅在服务端应用程序中使用。
- 若已泄露请立即轮换。 从控制台重新生成 key。旧的密钥会立即失效,并且每次查看都会记录在审计日志中,以便在事后轻松发现被盗用的凭据。
使用环境变量
将您的 key 存储在环境变量中:
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
然后在您的代码中引用它:
import os
api_key = os.environ["FOURA_API_KEY"]
const apiKey = process.env.FOURA_API_KEY;
常见身份验证错误
所有身份验证失败都会返回 401 Unauthorized 状态。
| 错误 | 消息 | 原因 | 解决方法 |
|---|---|---|---|
| 401 | Missing API key. Include X-API-Key header. | request 中没有 X-API-Key header |
添加 X-API-Key header |
| 401 | Invalid API key | key 错误、包含多余空格或 key 已停用 | 验证该 key、去除空格,或从控制台创建新 key |
每个 response (无论成功或失败) 都带有 X-Foura-Request-Id header。请在您的系统中记录它,以便技术支持日后查找特定的调用请求。
后续步骤
- 快速入门:发送您的第一个 request
- 管理 API key:查看、编辑、重新生成和删除 key
- API endpoint:完整的 endpoint 参考
- 错误处理:妥善处理身份验证错误