API Docs für Feature-Gates
Eine state-of-the-art Dummy-Dokumentation für die spätere Integration von FeaturOx. Inhalte, Endpunkte und SDKs sind Platzhalter und können später ohne Layout-Umbau ersetzt werden.
Zielzeit
< 15 Min.
Status
Dummy
Modus
Sandbox
Integration Console
Feature-Zugriff, Limits und Events an einem Ort
Loslegen
Von API-Key zu Feature-Entscheidung
Diese Dummy-Strecke zeigt, wie eine spätere Integration aussehen kann: SDK konfigurieren, Feature-Key prüfen und die Antwort im Produkt verwenden.
import { FeatureOx } from "@featureox/sdk"
const featureOx = new FeatureOx({
apiKey: process.env.FEATUREOX_API_KEY,
environment: "sandbox",
})
const access = await featureOx.entitlements.check({
subjectId: "user_42",
featureKey: "reports.export",
})
if (access.allowed) {
enableExport()
}Sicherheit
API Keys, Umgebungen und Signaturen
Die endgültige Authentifizierung kommt später. Die Dummy-Seite zeigt bereits die vorgesehenen Sicherheitsbausteine für Server-to-Server-Integrationen.
Bearer Keys
Server-Requests verwenden kurz und klar getrennte API Keys pro Umgebung.
Least Privilege
Keys sollen später scopes für Lesezugriffe, Mutationen und Webhooks unterstützen.
Sandbox zuerst
Alle Beispiele nutzen Platzhalter und eine reservierte Test-Domain.
Webhook Secrets
Eingehende Events werden über eine Signatur verifiziert, bevor lokale Daten synchronisiert werden.
Authorization: Bearer fo_live_placeholder_keyFeature Gates
Entitlement Check
Der Kern der Integration: Prüfe, ob ein User, Account oder Workspace ein Feature nutzen darf und welche Limits gelten.
{
"subjectId": "user_42",
"accountId": "account_acme",
"featureKey": "reports.export",
"context": {
"workspaceId": "workspace_7",
"planHint": "professional"
}
}Events
Webhooks für lokale Synchronisierung
Webhooks halten deine Anwendung über Planwechsel, Feature-Freigaben und Limitänderungen auf dem aktuellen Stand.
{
"id": "evt_placeholder_01",
"type": "entitlement.updated",
"createdAt": "2026-07-03T09:30:00Z",
"data": {
"accountId": "account_acme",
"featureKey": "reports.export",
"allowed": true,
"plan": "professional"
}
}REST Preview
Dummy API-Referenz
Diese Endpunkte sind Platzhalter für die spätere finale Referenz. Namen und Payloads bleiben bewusst generisch.
/v1/entitlements/check
Feature-Zugriff prüfen
Liefert allowed, reason und optionale Limitinformationen für einen User oder Account.
/v1/features
Feature-Katalog lesen
Listet die konfigurierten Feature-Keys und ihren Preview-Status.
/v1/accounts/{accountId}/plan
Plan-Kontext aktualisieren
Dummy-Endpoint für spätere Plan- und Subscription-Synchronisierung.
/v1/accounts/{accountId}/usage
Nutzung abrufen
Gibt simulierte Verbrauchsdaten und Limits zurück.
/v1/webhook-endpoints
Webhook registrieren
Hinterlegt eine Ziel-URL für FeaturOx Events.
Fehlerhandling
Vorhersehbare Fehlerantworten
Die Dummy-Fehler zeigen die geplante Form: maschinenlesbarer Code, klare Message, requestId und Link zur späteren Dokumentation.
feature_not_found
Feature-Key unbekannt
Der angefragte Key ist im aktuellen Projekt nicht konfiguriert.
subject_not_linked
User oder Account fehlt
Die Anfrage referenziert einen User oder Account, der noch keiner Lizenz zugeordnet ist.
rate_limited
Rate Limit erreicht
Der Client sollte kurz warten und die Anfrage mit Backoff wiederholen.
{
"error": {
"code": "feature_not_found",
"message": "The requested feature key is not configured.",
"requestId": "req_placeholder_123",
"docs": "https://featureox.test/docs/errors#feature-not-found"
}
}Bereit für die echte Spezifikation
Das Layout ist vorbereitet, damit finale API-Texte, echte Endpunkte und SDK-Beispiele später direkt eingesetzt werden können.