Hoe werken API-sleutels? - Helpcentrum

API-sleutels zijn uw authenticatiegegevens voor toegang tot de Cathopic API. Begrijpen hoe ze werken is essentieel voor een veilige en effectieve API-integratie.

Wat is een API-sleutel?

Een API-sleutel is een unieke geheime token die uw toepassing identificeert en toestemming geeft om toegang te krijgen tot de Cathopic API:

Een lange alfanumerieke reeks (bijv., sk_live_abc123xyz789...)
Werkt als zowel authenticatie als autorisatie
Koppelt aan uw Cathopic-account en facturatie
Kan actief of inactief zijn

Levenscyclus van de sleutel

Aanmaken:

Genereer sleutels in Instellingen → API
Geef elke sleutel een beschrijvende naam ("Productiewebsite", "Staging", "Mobiele app")
Kopieer de volledige sleutel meteen—die wordt slechts één keer getoond
Bewaar veilig (omgevingsvariabelen, secrets manager, wachtwoordmanager)

Gebruik:

Neem op in de x-api-key HTTP-header bij elke aanvraag
Sleutels worden bij elke aanvraag server-side gevalideerd
Al het API-gebruik wordt bijgehouden en gefactureerd aan uw account

Deactiveren:

Sleutels kunnen tijdelijk worden uitgeschakeld zonder verwijdering
Handig voor het oplossen van problemen of het pauzeren van een specifieke integratie
Kan op elk moment opnieuw worden geactiveerd

Verwijderen:

Verwijdert de sleutel permanent
Kan niet ongedaan worden gemaakt of worden hersteld
Alle aanvragen met die sleutel zullen onmiddellijk mislukken

Richtlijnen voor sleutelbeheer

Beveiliging:

Maak nooit sleutels vast in versiebeheer: Gebruik .env bestanden en voeg ze toe aan .gitignore
Maak sleutels nooit zichtbaar in client-side code: API-sleutels mogen alleen server-side worden gebruikt
Gebruik omgevingsvariabelen: Bewaar sleutels in process.env.CATHOPIC_API_KEY of een equivalent
Roteer regelmatig: Wijzig sleutels periodiek (per kwartaal of na wijzigingen in het team)
Gebruik aparte sleutels per omgeving: Verschillende sleutels voor development, staging en productie

Organisatie:

Beschrijvende namen: Noem sleutels naar hun doel: "Productiewebsite", "iOS-app", "Emailsysteem"
Documenteer eigenaarschap: Houd bij welk teamlid elke sleutel heeft aangemaakt
Regelmatige audits: Bekijk actieve sleutels maandelijks en verwijder ongebruikte sleutels

Meerdere API-sleutels

U kunt meerdere API-sleutels aanmaken voor verschillende doeleinden:

Per omgeving: Afzonderlijke sleutels voor development, staging en productie
Per toepassing: Verschillende sleutels voor website, mobiele app en interne tools
Per teamlid: Individuele sleutels voor ontwikkelaars (makkelijker te volgen en in te trekken)

Alle sleutels onder uw account delen dezelfde facturatie. Gebruik vanuit alle sleutels wordt gecombineerd in uw maandelijkse factuur.

Monitoring van sleutelgebruik

Volg activiteit voor elke sleutel:

Ga naar Instellingen → API
Bekijk de lijst met alle sleutels met de datum van het laatste gebruik
Klik op een sleutel om gedetailleerde gebruiksstatistieken te zien
Houd toezicht op onverwachte activiteit

Wat te doen als een sleutel is gecompromitteerd

Als u denkt dat een API-sleutel is blootgesteld:

Verwijder of deactiveer de sleutel onmiddellijk in Instellingen → API
Genereer een nieuwe vervangende sleutel
Werk uw toepassing bij met de nieuwe sleutel
Bekijk gebruikslogs op verdachte activiteiten
Neem contact op met support als u ongeautoriseerd gebruik ziet

Voorbeeld: sleutels veilig opslaan

Node.js met omgevingsvariabelen:

// .env-bestand (voeg toe aan .gitignore!)
CATHOPIC_API_KEY=sk_live_abc123xyz789...
// Uw code
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 met omgevingsvariabelen:

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'}
)