Docs API pour feature gates
Une expérience de documentation factice de dernière génération pour la future intégration FeaturOx. Le contenu, les endpoints et les SDK sont des placeholders et pourront être remplacés plus tard sans reconstruire la mise en page.
Temps cible
< 15 min.
Statut
Factice
Mode
Sandbox
Console d'intégration
Accès aux fonctionnalités, limites et événements au même endroit
Démarrer
De la clé API à la décision de fonctionnalité
Ce flux factice montre comment une future intégration peut fonctionner : configurer le SDK, vérifier une clé de fonctionnalité et utiliser la réponse dans votre produit.
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()
}Sécurité
Clés API, environnements et signatures
Les détails définitifs de l'authentification viendront plus tard. La page factice montre déjà les blocs de sécurité prévus pour les intégrations serveur à serveur.
Clés Bearer
Les requêtes serveur utilisent des clés API courtes et clairement séparées par environnement.
Moindre privilège
Les clés devraient ensuite prendre en charge des scopes pour les accès en lecture, les mutations et les webhooks.
Sandbox d'abord
Tous les exemples utilisent des placeholders et un domaine de test réservé.
Secrets de webhook
Les événements entrants sont vérifiés par signature avant la synchronisation des données locales.
Authorization: Bearer fo_live_placeholder_keyFeature gates
Vérification des droits
Le cœur de l'intégration : vérifier si un utilisateur, un compte ou un workspace peut utiliser une fonctionnalité et quelles limites s'appliquent.
{
"subjectId": "user_42",
"accountId": "account_acme",
"featureKey": "reports.export",
"context": {
"workspaceId": "workspace_7",
"planHint": "professional"
}
}Événements
Webhooks pour la synchronisation locale
Les webhooks gardent votre app à jour lorsque les forfaits, les accès aux fonctionnalités et les limites changent.
{
"id": "evt_placeholder_01",
"type": "entitlement.updated",
"createdAt": "2026-07-03T09:30:00Z",
"data": {
"accountId": "account_acme",
"featureKey": "reports.export",
"allowed": true,
"plan": "professional"
}
}Aperçu REST
Référence API factice
Ces endpoints sont des placeholders pour la future référence finale. Les noms et payloads restent volontairement génériques.
/v1/entitlements/check
Vérifier l'accès à une fonctionnalité
Retourne allowed, reason et des informations optionnelles de limites pour un utilisateur ou un compte.
/v1/features
Lire le catalogue de fonctionnalités
Liste les clés de fonctionnalités configurées et leur statut d'aperçu.
/v1/accounts/{accountId}/plan
Mettre à jour le contexte de forfait
Endpoint factice pour la future synchronisation des forfaits et abonnements.
/v1/accounts/{accountId}/usage
Lire l'utilisation
Retourne des données d'utilisation simulées et des limites.
/v1/webhook-endpoints
Enregistrer un webhook
Stocke une URL cible pour les événements FeaturOx.
Gestion des erreurs
Réponses d'erreur prévisibles
Les erreurs factices montrent la forme prévue : code lisible par machine, message clair, requestId et lien vers la future documentation.
feature_not_found
Clé de fonctionnalité inconnue
La clé demandée n'est pas configurée dans le projet actuel.
subject_not_linked
Utilisateur ou compte manquant
La requête référence un utilisateur ou un compte qui n'est pas encore lié à une licence.
rate_limited
Limite de débit atteinte
Le client devrait attendre brièvement puis réessayer avec backoff.
{
"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"
}
}Prêt pour la vraie spécification
La mise en page est prête pour accueillir plus tard les textes API finaux, les vrais endpoints et les exemples SDK.