Gérer les clients
Créer, consulter, modifier et supprimer les clients d'un réseau avec l'API publique, et comprendre ce que Wakastart crée dans Keycloak.
- Accès requis
- Administrateur réseau (NetworkAdmin) ou Propriétaire, droits customers.*
- Durée
- 5 min
Un client est une organisation cliente dans un réseau : une entreprise, un cabinet, une école. Ses utilisateurs, dans chacun des environnements, et ses équipes lui sont rattachés. La gestion des clients se fait par l'API publique, https://api.wakastart.app/api.
Avant de commencer
- Vous appelez l'API avec le jeton d'un administrateur ou une clé API qui porte les droits
customers.read,customers.create,customers.updateoucustomers.deleteselon l'opération. Voir Authentification. - Pour créer un client, il faut le niveau Administrateur réseau sur le réseau visé, ou Propriétaire de l'application.
- Munissez-vous de l'UUID du réseau (
id, renvoyé parGET /api/config/networks/{wid}) et de l'UUID d'une entité juridique existante. Les réponses de l'API renvoient l'entité rattachée à chaque objet dansentity.id.
Créer un client
/api/config/customerscurl -X POST "https://api.wakastart.app/api/config/customers" \
-H "Authorization: Bearer $WAKASTART_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"networkId": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
"name": "Cabinet Exemple",
"entityId": "0e1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b",
"subdomain": "cabinet-exemple"
}'const response = await fetch("https://api.wakastart.app/api/config/customers", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.WAKASTART_TOKEN}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
networkId: "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
name: "Cabinet Exemple",
entityId: "0e1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b",
subdomain: "cabinet-exemple",
}),
});
const customer = await response.json();Réponse attendue (extrait) :
{
"id": "5d6e7f8a-9b0c-4d1e-8f2a-3b4c5d6e7f8a",
"wid": "Cu9pL2",
"networkId": "c2d3e4f5-a6b7-4c8d-9e0f-1a2b3c4d5e6f",
"name": "Cabinet Exemple",
"subdomain": "cabinet-exemple",
"status": "ACTIVE"
}À la création, Wakastart :
- crée un groupe et une organisation Keycloak, nommés par le WID du client, dans le realm du réseau, sur chaque instance où ce realm est prêt ;
- donne au client l'accès à l'application du réseau.
Le client peut alors recevoir des utilisateurs : voir Inviter un utilisateur.
Lister et consulter les clients
/api/config/customers/api/config/customers/{wid}La liste est paginée (page, à partir de 1 ; limit, de 1 à 100, 20 par défaut) et se filtre par networkWid, customerWid ou partnerWid. Vous ne voyez que les clients de votre périmètre.
curl "https://api.wakastart.app/api/config/customers?networkWid=Nw4kR8&page=1&limit=20" \
-H "Authorization: Bearer $WAKASTART_TOKEN"const response = await fetch(
"https://api.wakastart.app/api/config/customers?networkWid=Nw4kR8&page=1&limit=20",
{ headers: { Authorization: `Bearer ${process.env.WAKASTART_TOKEN}` } },
);
const { data, meta } = await response.json();Réponse attendue (extrait) :
{
"data": [
{ "wid": "Cu9pL2", "name": "Cabinet Exemple", "status": "ACTIVE" }
],
"meta": { "page": 1, "limit": 20, "total": 1, "totalPages": 1 }
}Modifier un client
/api/config/customers/{wid}Envoyez seulement les champs à modifier : name, description, subdomain, defLangId, defThemeId, entityId. Le réseau d'un client ne change pas. Le champ status n'est accepté que d'un niveau Administrateur réseau ou supérieur.
curl -X PUT "https://api.wakastart.app/api/config/customers/Cu9pL2" \
-H "Authorization: Bearer $WAKASTART_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "name": "Cabinet Exemple & Associés" }'Réponse attendue : le client complet, avec le nouveau nom.
Supprimer un client
/api/config/customers/{wid}Attention
La suppression d'un client supprime aussi tous ses utilisateurs, dans tous les environnements, ses équipes, ses anciens profils propres, ses invitations et ses fournisseurs d'identité, ainsi que son groupe et son organisation Keycloak. Elle est définitive. Pour garder une trace de ses utilisateurs, listez-les d'abord avec GET /api/config/users?customerWid=Cu9pL2, une fois par environnement, avec une clé de chaque environnement.
curl -X DELETE "https://api.wakastart.app/api/config/customers/Cu9pL2" \
-H "Authorization: Bearer $WAKASTART_TOKEN"Réponse attendue : un code 200 sans erreur.
Vérifier le résultat
GET /api/config/customers/Cu9pL2 renvoie le client avec son réseau et son entité. Après une suppression, le même appel renvoie 404.