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.
Konto
Siehe Tenant.
API-Schlüssel
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.
API-Top-up
Einmaliger Kauf, der verbrauchbares API-Kontingent hinzufügt. Top-ups setzen sich nicht jede Abrechnungsperiode zurück. API-Aufrufe verbrauchen zuerst das Abonnement, dann Top-ups bis zur Erschöpfung.
Top-ups kaufen Sie im Dashboard unter Abrechnung oder auf der Preisseite.
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
Funktion, die automatisch ein Einmalpaket kauft, wenn Ihr verbleibendes Saldo (API-Kontingent + zusätzliche Credits) 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 in einem separaten Saldo, getrennt vom API-Kontingent. Werden erst genutzt, wenn das kombinierte API-Kontingent (Abonnement + Top-ups) vollständig erschöpft ist. Werden am Ende einer Abrechnungsperiode nicht zurückgesetzt. Quellen: Onboarding-Boni oder manuelle Käufe zusätzlicher Credits.
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
Kombiniertes API-Aufrufbudget aus Abonnement und verbleibenden einmaligen Top-ups, gewichtet nach Endpunkt-Creditkosten. Der Abonnementanteil wird pro Abrechnungsperiode zurückgesetzt; Top-ups werden einmal verbraucht. Bei erschöpftem API-Kontingent werden zusätzliche Credits genutzt, falls vorhanden; andernfalls 402.
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.
Abonnement
Eine wiederkehrende Abrechnungsvereinbarung, die einen Tenant mit einem oder mehreren Plänen verknüpft. Wird über Stripe verwaltet. Bestimmt den Abrechnungszeitraum, das Kontingent und die für den Tenant verfügbaren Funktionen.
Tenant
Die Organisationseinheit in der Plattform, gleichbedeutend mit einem Konto oder Arbeitsbereich. Alle API-Schlüssel, Nutzung, Credits und Abonnements sind auf einen Tenant beschränkt. Benutzer können mehreren Tenants angehören. Siehe Konto.
Schwellenwert
Der Prozentsatz des verbleibenden Saldos (API-Kontingent + zusätzliche Credits), bei dem die automatische Aufladung aktiviert wird. Konfigurierbar zwischen 10 % und 30 %.