אימות
כיצד לאמת בקשות ל-TCG Price Lookup API עם מפתח API.
אימות עם מפתח API
TCG Price Lookup API משתמש באימות מבוסס מפתח API. כל בקשה חייבת לכלול את מפתח ה-API שלך.
אימות עם כותרת (מומלץ)
העבר את מפתח ה-API בכותרת X-API-Key:
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
- אל תבצע commit של מפתח ה-API לניהול גרסאות
- השתמש במשתני סביבה (
TCG_API_KEY) - אל תחשוף את מפתח ה-API בקוד צד-לקוח או בחזית
- אם המפתח נחשף, החלף אותו מיידית מלוח הבקרה
תגובת שגיאה
שגיאות אימות מחזירות 401 Unauthorized:
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}