Vérifier qu'une fonctionnalité est active
Interroger l'API publique depuis le serveur de votre application pour savoir si une fonctionnalité est active pour un client.
- Accès requis
- Niveau Administrateur client et droit apps.features.read
- Durée
- 10 min
Votre application décide d'afficher un module selon l'offre du client de l'utilisateur. Le serveur de l'application demande à Wakastart si la fonctionnalité est active, en appliquant la règle des trois niveaux (application, réseau, client) décrite dans Fonctionnalités activables.
Avant de commencer
- La fonctionnalité est déclarée sur votre application : voir Définir les fonctionnalités.
- Le serveur de votre application dispose d'une clé API de niveau Administrateur client au moins, qui porte le droit
apps.features.read. Gardez-la côté serveur : elle ne doit jamais atteindre le navigateur. - Vous connaissez le WID du client de l'utilisateur. Il figure dans
customer.widde la réponse deGET /api/me, et dans le claimciddu jeton enrichi.
Vérifier une fonctionnalité précise
/api/config/app-features/check/{customerWid}/{featureCode}curl "https://api.wakastart.app/api/config/app-features/check/Cu9pL2/analytics" \
-H "x-api-key: sk_test_exemple"async function isFeatureEnabled(customerWid: string, featureCode: string): Promise<boolean> {
const response = await fetch(
`https://api.wakastart.app/api/config/app-features/check/${customerWid}/${featureCode}`,
{ headers: { "x-api-key": process.env.WAKASTART_API_KEY! } },
);
if (!response.ok) {
throw new Error(`Vérification impossible : HTTP ${response.status}`);
}
const body: { featureCode: string; customerId: string; isEnabled: boolean } =
await response.json();
return body.isEnabled;
}
if (await isFeatureEnabled("Cu9pL2", "analytics")) {
// afficher le module Statistiques
}Réponse attendue :
{
"featureCode": "analytics",
"customerId": "5d6e7f8a-9b0c-4d1e-8f2a-3b4c5d6e7f8a",
"isEnabled": true
}Un code de fonctionnalité inconnu renvoie "isEnabled": false, sans erreur.
Lister toutes les fonctionnalités actives d'un client
Un seul appel suffit pour charger l'état de toutes les fonctionnalités au démarrage d'une session.
/api/config/app-features/enabled/{customerWid}curl "https://api.wakastart.app/api/config/app-features/enabled/Cu9pL2" \
-H "x-api-key: sk_test_exemple"const response = await fetch(
"https://api.wakastart.app/api/config/app-features/enabled/Cu9pL2",
{ headers: { "x-api-key": process.env.WAKASTART_API_KEY! } },
);
const { features }: { customerId: string; features: string[] } = await response.json();
const hasAnalytics = features.includes("analytics");Réponse attendue :
{
"customerId": "5d6e7f8a-9b0c-4d1e-8f2a-3b4c5d6e7f8a",
"features": ["analytics", "export-pdf"]
}Conseil
Mettez la liste en cache pour la durée de la session de l'utilisateur plutôt que d'appeler l'API à chaque écran. Respectez les limites de débit de l'API publique : 10 requêtes par seconde, 100 par minute et 1 000 par heure par adresse IP.
Vérifier le résultat
Éteignez la fonctionnalité au niveau de l'application (PATCH /api/config/app-features/{id} avec "isEnabled": false) : l'appel de vérification renvoie aussitôt "isEnabled": false, et le code disparaît de la liste features.