Pengesahan
Cara mengesahkan permintaan API TCG Price Lookup menggunakan kunci API.
Pengesahan Kunci API
API TCG Price Lookup menggunakan pengesahan berasaskan kunci API. Semua permintaan mesti menyertakan kunci API anda.
Pengesahan Pengepala (Disyorkan)
Hantar kunci API anda dalam pengepala X-API-Key:
curl https://api.tcgpricelookup.com/v1/search?q=charizard \
-H "X-API-Key: your-api-key"
Pengesahan Parameter Pertanyaan
Sebagai alternatif, anda boleh menghantarnya sebagai parameter pertanyaan:
curl "https://api.tcgpricelookup.com/v1/search?q=charizard&api_key=your-api-key"
Nota: Pengesahan pengepala adalah lebih selamat. Menghantar sebagai parameter pertanyaan boleh menyebabkan kunci API anda dilog dalam log pelayan.
Pengesahan dengan SDK
SDK mengendalikan semua pengesahan secara automatik:
// 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'])
Keselamatan Kunci API
- Jangan komit kunci API ke kawalan versi
- Gunakan pemboleh ubah persekitaran (
TCG_API_KEY) - Jangan dedahkan kunci API dalam kod sisi klien atau bahagian hadapan
- Putar kunci segera dari papan pemuka jika ia bocor
Respons Ralat
Ralat pengesahan mengembalikan 401 Unauthorized:
{
"error": {
"code": "unauthorized",
"message": "Invalid or missing API key"
}
}