认证
如何使用API密钥对TCG Price Lookup API请求进行身份验证。
API密钥认证
TCG Price Lookup API使用基于API密钥的认证方式。所有请求都必须包含API密钥。
请求头认证(推荐)
在X-API-Key请求头中传递API密钥:
curl https://api.tcgpricelookup.com/v1/search?q=charizard \
-H "X-API-Key: your-api-key"
查询参数认证
也可以通过查询参数传递:
curl "https://api.tcgpricelookup.com/v1/search?q=charizard&api_key=your-api-key"
注意: 推荐使用请求头认证方式,更为安全。通过查询参数传递可能会将API密钥记录在服务器日志中。
通过SDK认证
SDK会自动处理所有认证:
// JavaScript
import { TCGLookup } from 'tcglookup';
const tcg = new TCGLookup({ apiKey: process.env.TCG_API_KEY });
# Python
from tcglookup import TCGLookup
tcg = TCGLookup(api_key=os.environ['TCG_API_KEY'])
API密钥安全建议
- 不要将API密钥提交到版本控制系统
- 使用环境变量(
TCG_API_KEY)存储密钥 - 不要在客户端代码或前端中暴露API密钥
- 如果密钥泄露,请立即在控制台中进行轮换
错误响应
认证错误将返回401 Unauthorized:
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}