Hogyan működnek az API-kulcsok?

Az API-kulcsok az Ön hitelesítési adatai a Cathopic API eléréséhez. Annak megértése, hogy hogyan működnek, elengedhetetlen a biztonságos és hatékony API-integrációhoz.

Mi az az API-kulcs?

Az API-kulcs egy egyedi titkos token, amely azonosítja az alkalmazását, és feljogosítja a Cathopic API elérésére:

• Egy hosszú, betűkből és számokból álló karakterlánc (pl. sk_live_abc123xyz789...)

• Egyszerre szolgál hitelesítésre és jogosultságkezelésre

• A Cathopic-fiókjához és számlázásához van kötve

• Lehet aktív vagy inaktív

A kulcsok életciklusa

Létrehozás:

1. Kulcsokat a Beállítások → API menüpontban generáljon

2. Adjon minden kulcsnak leíró nevet ("Production Website", "Staging", "Mobile App")

3. Azonnal másolja ki a teljes kulcsot – csak egyszer jelenik meg

4. Tárolja biztonságosan (környezeti változók, secrets manager, jelszókezelő)

Használat:

• Minden kérésnél vegye fel az x-api-key HTTP fejlécbe

• A kulcsokat a szerver oldalon ellenőrzik minden egyes kérésnél

• Az összes API-használat nyomon követésre kerül, és a fiókjához kerül számlázásra

Inaktiválás:

• A kulcsok törlés nélkül ideiglenesen letilthatók

• Hasznos hibakereséshez vagy egy adott integráció szüneteltetéséhez

• Bármikor újraaktiválhatók

Törlés:

• Véglegesen eltávolítja a kulcsot

• Nem vonható vissza, és nem állítható helyre

• Az ezzel a kulccsal küldött összes kérés azonnal sikertelen lesz

Kulcskezelési irányelvek

Biztonság:

• Soha ne mentse a kulcsokat verziókezelésbe: Használjon .env fájlokat, és adja hozzá őket a .gitignore-hoz

• Soha ne tegye ki ügyféloldali kódban: Az API-kulcsokat csak szerveroldalon szabad használni

• Használjon környezeti változókat: A kulcsokat a process.env.CATHOPIC_API_KEY vagy ennek megfelelő változóban tárolja

• Rendszeres rotáció: Időszakonként cserélje a kulcsokat (negyedévente vagy csapattag-váltás után)

• Külön kulcsok környezetenként: Külön kulcsok a fejlesztéshez, a staginghez és a produkcióhoz

Szervezés:

• Leíró nevek: A kulcsokat a céljuk szerint nevezze el: "Production Website", "iOS App", "Email System"

• Tulajdonjog dokumentálása: Kövesse nyomon, hogy melyik csapattag hozta létre az egyes kulcsokat

• Rendszeres auditok: Tekintse át az aktív kulcsokat havonta, és távolítsa el a nem használtakat

Több API-kulcs

Különböző célokra több API-kulcsot is létrehozhat:

• Környezetenként: Külön kulcsok a fejlesztéshez, a staginghez és a produkcióhoz

• Alkalmazásonként: Külön kulcsok a weboldalhoz, a mobilalkalmazáshoz és a belső eszközökhöz

• Csapattagonként: Egyéni kulcsok a fejlesztőknek (könnyebb nyomon követni és visszavonni)

A fiókja alatti összes kulcs ugyanahhoz a számlázáshoz tartozik. Az összes kulcsról származó használat összeadódik a havi számláján.

Kulcshasználat figyelése

Az egyes kulcsok aktivitását kövesse nyomon:

1. Menjen a Beállítások → API menüpontba

2. Tekintse meg az összes kulcs listáját az utoljára használt dátumokkal

3. Kattintson egy kulcsra a részletes használati statisztikák megtekintéséhez

4. Figyelje a szokatlan aktivitást

Mit tegyen, ha egy kulcs kompromittálódott?

Ha úgy gondolja, hogy egy API-kulcs nyilvánosságra került:

1. Azonnal törölje vagy tiltsa le a kulcsot a Beállítások → API menüpontban

2. Készítsen egy új, helyettesítő kulcsot

3. Frissítse az alkalmazását az új kulccsal

4. Ellenőrizze a használati naplókat bármilyen gyanús tevékenység miatt

5. Ha jogosulatlan használatot lát, lépjen kapcsolatba a támogatással

Példa: Kulcsok biztonságos tárolása

Node.js környezeti változókkal:

// .env fájl (add hozzá a .gitignore!-hoz!)
CATHOPIC_API_KEY=sk_live_abc123xyz789...
// A kódja
require('dotenv').config();
const apiKey = process.env.CATHOPIC_API_KEY;
fetch('https://api.cathopic.com/resources', {
  method: 'POST',
  headers: {
    'x-api-key': apiKey,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ query: 'Jesus' })
});

Python környezeti változókkal:

import os
import requests
api_key = os.environ.get('CATHOPIC_API_KEY')
response = requests.post(
    'https://api.cathopic.com/resources',
    headers={'x-api-key': api_key},
    json={'query': 'Jesus'}
)