身份验证
认证
对 FourA API 的每个 request 均需进行认证。本页面介绍了如何获取、使用和管理 API key。
获取 API Key
- 登录 FourA Dashboard
- 前往 API Keys 页面
- 点击 Create Key
- 从确认对话框中复制 key
您的 API key 格式如下:pk_live_a1b2c3d4e5f6...
现已支持查看创建的 key:后续点击对应 key 行的眼睛图标,即可按需显示完整 secret(有关查看流程和权限,请参阅 管理 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:
- 切勿提交至版本控制系统。 请改用环境变量。
- 切勿在客户端代码中暴露。 仅在服务端应用程序中使用。
- 泄露时立即轮换。 在 Dashboard 中重新生成密钥。旧密钥将在 1 分钟内失效,且每次查看都会记录审计日志,以便事后排查凭据被盗情况。
使用环境变量
将密钥存储在环境变量中:
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、清除空格或在 Dashboard 中创建新 key |
无论成功还是失败,每个 response 都会携带一个 X-Foura-Request-Id header。但 FourA 完全无法读取的 body(格式错误的 JSON,或大于 100 KB 的 body)除外,此类 request 会在分配 ID 之前被拒绝。请在客户端记录该 ID,以便支持团队后续查询特定调用。
后续步骤
- 快速入门:发送你的第一个 request
- 管理 API Key:查看、编辑、重新生成和删除 key
- API Endpoint:完整的 endpoint 参考
- 错误处理:从容处理认证错误