Glossar

Definitionen der wichtigsten Begriffe, die in der API und im Dashboard verwendet werden.

Eine Referenz für die Begriffe, die Ihnen in der Dokumentation, dem Dashboard und den API-Antworten begegnen.

Eine geheime Zeichenkette zur Authentifizierung von API-Anfragen. Jeder Schlüssel gehört zu einem Tenant und hat einen Alias, eine Kategorie, optionale Kontingente und ein optionales Ablaufdatum. Wird über den x-api-key-Header oder den x_api_key-Query-Parameter übergeben.

Alle Details finden Sie unter API-Schlüssel.

Alias

Der lesbare Name eines API-Schlüssels, eindeutig innerhalb eines Tenants. Wird zur Identifizierung von Schlüsseln im Dashboard und in Analysen verwendet.

Automatische Aufladung

Eine Funktion, die automatisch ein Kreditpaket kauft, wenn Ihr verbleibendes Guthaben unter einen konfigurierten Schwellenwert fällt. Durch eine 72-Stunden-Abklingzeit zwischen Käufen geschützt. Erfordert ein aktives kostenpflichtiges Abonnement.

Alle Details finden Sie unter Automatische Aufladung.

Abrechnungszeitraum

Das aktive Abonnementfenster zur Messung des Kontingentverbrauchs. Bestimmt durch die Felder currentPeriodStart und currentPeriodEnd von Stripe. Wenn kein aktives Abonnement gefunden wird, entspricht der Abrechnungszeitraum dem aktuellen Kalendermonat.

Kategorie

Eine Bezeichnung auf einem API-Schlüssel (production, development, staging oder benutzerdefiniert). Wird zur Filterung und Organisation im Dashboard verwendet. Ändert nicht, wie die API die Anfrage verarbeitet.

Guthaben

Die Einheit des API-Verbrauchs. Jede abrechnungspflichtige Anfrage zieht eine Anzahl von Credits ab, die durch die Kosten des Endpunkts bestimmt werden. Credits werden als Buchungseinträge gespeichert: ein negativer Betrag bedeutet, dass Credits gewährt wurden, ein positiver Betrag bedeutet, dass sie verbraucht wurden.

Die Kosten pro Endpunkt finden Sie unter Credits.

Zusätzliche Credits

Credits, die separat von einem Abonnement erworben wurden (über Einmalpakete oder die automatische Aufladung). Sie werden verwendet, wenn das Abonnementkontingent erschöpft ist. Enthält auch Onboarding-Zuschüsse. Unterscheidet sich vom Abonnementkontingent, da sie am Ende eines Abrechnungszeitraums nicht zurückgesetzt werden.

Schlüsselkontingent

Ein optionales Anfragelimit für einen bestimmten API-Schlüssel. Wird auf rollierenden Zeitfenstern durchgesetzt: Gesamtlaufzeit, letzte 24 Stunden, 7 Tage und 30 Tage. Unabhängig vom Abonnementkontingent.

Plan

Ein Abonnementprodukt (z. B. "Starter", "Pro"), das eine Reihe von Funktionen definiert: API-Aufrufkontingent, Ratenlimits, Zugang zu zusätzlichen Credits und mehr. Ein Tenant kann gleichzeitig mehrere aktive Planprodukte besitzen.

Kontingent

Die maximale Anzahl von API-Aufrufen (gewichtet nach Kreditkosten), die innerhalb eines Abrechnungszeitraums erlaubt sind. Stammt aus der api-Funktion des aktiven Plans. Bei Erschöpfung werden zusätzliche Credits verwendet, falls verfügbar; andernfalls werden Anfragen mit 402 abgelehnt.

Ratenlimit

Es gibt zwei separate Ratenbegrenzungssysteme. Planlimits (pro Sekunde / pro Minute) gelten für alle Schlüssel eines Kontos und werden durch den Abonnementplan festgelegt. Bei Überschreitung wird 429 Too Many Requests zurückgegeben. Schlüsselkontingente (rollierend: gesamt / täglich / wöchentlich / monatlich) sind optionale Obergrenzen pro Schlüssel. Bei Überschreitung wird 401 Rate Limit Exceeded zurückgegeben. Weitere Details unter API-Schlüssel.

Auf dieser Seite