API-Authentifizierung: CheckoutOS-Doku

Die CheckoutOS-API verwendet API-Schlüssel zur Authentifizierung. Dieser Leitfaden erklärt die Erstellung von Schlüsseln, die Authentifizierung von Anfragen und die sichere Zugriffsverwaltung.

API-Schlüssel

API-Schlüssel authentifizieren alle Anfragen an die CheckoutOS-API. Jeder Schlüssel gehört zu deinem Shop und hat konfigurierbare Berechtigungen.

API-Schlüssel erstellen

Zu Einstellungen wechseln

Gehe zu CheckoutOS → Settings → API.

Neuen Schlüssel erstellen

Klicke auf „Create API Key“.

Schlüssel benennen

Wähle einen beschreibenden Namen wie „Produktionsserver“.

Berechtigungen festlegen

Wähle die erlaubten API-Berechtigungsbereiche.

Schlüssel kopieren

Kopiere ihn sofort: Er wird nicht erneut angezeigt.

Schlüsselsicherheit

API-Schlüssel werden nur einmal bei der Erstellung angezeigt. Bewahre sie sicher auf. Bei Verlust musst du einen neuen erstellen.

Authentifizierungsmethoden

Bearer-Token, empfohlen

Sende den API-Schlüssel als Bearer-Token im Authorization-Header:

Authentifizierung mit Bearer-Token

curl -X GET "https://api.chargezen.com/v1/checkoutos/upsells" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

X-API-Key-Header

Alternativ kannst du den X-API-Key-Header verwenden:

X-API-Key-Authentifizierung

curl -X GET "https://api.chargezen.com/v1/checkoutos/upsells" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

API-Berechtigungen

API-Schlüssel lassen sich auf bestimmte Berechtigungen begrenzen:

Verfügbare Berechtigungsbereiche

{
  "scopes": {
    "read:upsells": "View upsell configurations",
    "write:upsells": "Create and modify upsells",
    "read:bundles": "View bundle configurations",
    "write:bundles": "Create and modify bundles",
    "read:analytics": "Access analytics data",
    "read:orders": "View order data",
    "write:orders": "Modify orders (edits)",
    "read:settings": "View CheckoutOS settings",
    "write:settings": "Modify settings",
    "webhooks:manage": "Create and manage webhooks"
  }
}

Minimale Rechte

Vergib nur benötigte Berechtigungen. Ein Schlüssel für Analyse-Dashboards sollte keine Upsell-Schreibrechte haben.

Anfragelimits

API-Anfragen werden für faire Nutzung begrenzt:

Anfragelimits

{
  "rate_limits": {
    "requests_per_minute": 120,
    "requests_per_hour": 3600,
    "burst_limit": 20
  },
  "headers": {
    "X-RateLimit-Limit": "120",
    "X-RateLimit-Remaining": "115",
    "X-RateLimit-Reset": "1640000000"
  }
}

Bei Erreichen des Limits erhältst du eine 429-Antwort:

Antwort bei erreichtem Limit

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after 45 seconds.",
    "retry_after": 45
  }
}

Umgebungen

CheckoutOS bietet getrennte Entwicklungs- und Produktionsumgebungen:

API-Umgebungen

{
  "production": {
    "base_url": "https://api.chargezen.com/v1",
    "key_prefix": "live_"
  },
  "sandbox": {
    "base_url": "https://sandbox.api.chargezen.com/v1",
    "key_prefix": "test_"
  }
}

Sandbox-Umgebung

Nutze die Sandbox für Entwicklung und Tests. Ihre Daten sind von der Produktion getrennt und jederzeit zurücksetzbar.

Offizielle SDKs

Offizielle SDKs übernehmen die Authentifizierung automatisch:

Node.js-SDK

import { CheckoutOS } from '@chargezen/checkoutos-sdk';

const client = new CheckoutOS({
  apiKey: process.env.CHARGEZEN_API_KEY,
  environment: 'production'
});

const upsells = await client.upsells.list();

Python-SDK

from chargezen import CheckoutOS

client = CheckoutOS(
    api_key=os.environ['CHARGEZEN_API_KEY'],
    environment='production'
)

upsells = client.upsells.list()

Schlüsselverwaltung

Bewährte Vorgehensweisen

Umgebungsvariablen nutzen – Schlüssel niemals fest im Code hinterlegen
Regelmäßig wechseln – Mindestens jedes Quartal
Eigene Schlüssel pro Umgebung – Entwicklung, Staging, Produktion
Unbenutzte Schlüssel widerrufen – Nicht mehr verwendete Schlüssel löschen
Nutzung beobachten – Auf ungewöhnliche Muster achten
Minimale Rechte nutzen – Nur notwendige Berechtigungen vergeben

Schlüssel widerrufen

API-Einstellungen öffnen

Gehe zu CheckoutOS → Settings → API.

Schlüssel finden

Suche den zu widerrufenden Schlüssel in der Liste.

Widerrufen

Klicke auf „Revoke“ und bestätige.

Sofortige Wirkung

Der Widerruf wirkt sofort. Alle Anfragen mit dem widerrufenen Schlüssel schlagen fehl. Aktualisiere zuvor deine Anwendungen.

API-Referenz

API-Endpunkte

Verfügbare API-Endpunkte

Mehr erfahren

Webhooks

Echtzeit-Benachrichtigungen über Ereignisse

Mehr erfahren