Gérer les réseaux
Créer un réseau de distribution pour votre application, puis régler son nom, son sous-domaine court, sa langue et son thème par défaut.
- Accès requis
- Administrateur réseau (NetworkAdmin) ou Propriétaire
- Durée
- 5 min
Un réseau est un canal de distribution de votre application. À sa création, Wakastart lui crée un realm Keycloak sur chacune des trois instances (prod, staging, dev) et y déclare votre application. Créez un réseau par marque ou par distributeur dont les utilisateurs doivent rester séparés.
Avant de commencer
- Vous êtes Administrateur réseau (
NetworkAdmin) avec l'accès aux réseaux, ou Propriétaire (OwnerAdmin). - Votre application existe. Elle est créée par Wakastart ; contactez-nous pour en ouvrir une.
- Choisissez un sous-domaine court s'il vous en faut un : 15 caractères au plus, en minuscules. Il est unique sur toute la plateforme.
Créer un réseau
Choisir l'application
Dans le fil d'Ariane sous l'en-tête, sélectionnez votre application dans le sélecteur Application.
Sans application sélectionnée, l'écran affiche « Sélectionnez une application dans le filtre global pour afficher et créer des réseaux. »
Ouvrir la liste des réseaux
Dans le menu latéral, ouvrez Administration > Réseaux, puis cliquez sur Nouveau réseau.
Résultat : la fenêtre Nouveau réseau s'ouvre.
Renseigner le réseau
- Nom : 100 caractères au plus, obligatoire ;
- Description : 250 caractères au plus ;
- URL Shortener : le sous-domaine court du réseau (15 caractères au plus : minuscules, chiffres, tirets et points) ;
- Langue par défaut et Thème par défaut, hérités par les clients du réseau. Laissez Aucune (hérite de l'App) ou Aucun (hérite de l'App) pour reprendre ceux de l'application.
Le champ Realm ID (Keycloak) est grisé : le realm est créé automatiquement et s'appelle realm-<WID du réseau>.
Enregistrer
Cliquez sur Enregistrer.
Résultat : le message « Réseau créé avec succès » s'affiche et le réseau apparaît dans la liste.
/api/config/networksLe droit networks.create est requis. appId est l'UUID de votre application, renvoyé par GET /api/config/apps/{wid}.
curl -X POST "https://api.wakastart.app/api/config/networks" \
-H "Authorization: Bearer $WAKASTART_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"appId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"name": "Réseau Sud-Ouest",
"description": "Distribution par le partenaire régional",
"subdomain": "sud-ouest"
}'const response = await fetch("https://api.wakastart.app/api/config/networks", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.WAKASTART_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
appId: "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
name: "Réseau Sud-Ouest",
description: "Distribution par le partenaire régional",
subdomain: "sud-ouest",
}),
});
const network = await response.json();Réponse attendue (extrait) :
{
"id": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
"wid": "Nw4kR8",
"appId": "7a1b2c3d-4e5f-4a6b-8c7d-9e0f1a2b3c4d",
"name": "Réseau Sud-Ouest",
"subdomain": "sud-ouest",
"realmId": "realm-Nw4kR8",
"status": "ACTIVE"
}Par l'API publique, subdomain accepte les minuscules, les chiffres et les tirets (^[a-z0-9-]+$).
Si la création du realm échoue sur une instance Keycloak, le réseau est tout de même enregistré : contactez Wakastart pour relancer la création sur cette instance.
Modifier un réseau
Ouvrir la configuration du réseau
Dans Administration > Réseaux, cliquez sur l'action Configuration avancée du réseau.
Résultat : la fiche du réseau s'ouvre sur l'onglet Général. Si un seul réseau vous est confié, la console l'ouvre directement.
Modifier les champs
Modifiez Nom, Description, URL Shortener, Langue par défaut ou Thème par défaut. Le Statut n'est modifiable qu'à partir du niveau Administrateur d'applications.
Enregistrer
Cliquez sur Enregistrer.
Résultat : le message « Réseau mis à jour » s'affiche.
/api/config/networks/{wid}Le droit networks.update est requis. Envoyez seulement les champs à modifier : name, description, subdomain, defLangId, defThemeId, status. L'application d'un réseau ne change jamais.
curl -X PUT "https://api.wakastart.app/api/config/networks/Nw4kR8" \
-H "Authorization: Bearer $WAKASTART_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "name": "Réseau Grand Sud-Ouest" }'await fetch("https://api.wakastart.app/api/config/networks/Nw4kR8", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.WAKASTART_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({ name: "Réseau Grand Sud-Ouest" }),
});Réponse attendue : le réseau complet, avec "name": "Réseau Grand Sud-Ouest".
Les autres onglets de la fiche règlent l'apparence, les langues, les profils et les e-mails du réseau. Voir Apparence, Langues et traductions et Masquer un profil pour un réseau.
Vérifier le résultat
- Dans Administration > Réseaux, le réseau apparaît avec son application.
- Sa fiche affiche son Realm ID (Keycloak), sous la forme
realm-<WID>.