Aller au contenu

Référence des organisations

Champs, limites et statuts des propriétaires, applications, réseaux, clients, entités, contacts et fonctionnalités, avec les écrans et les opérations d'API.

RéférenceAdministrateurPartenaireDéveloppeur
Voir en Markdown

Cette page décrit les objets de l'organisation Wakastart. Le détail de chaque endpoint (paramètres, codes de réponse) est dans la référence API des organisations. Les concepts sont expliqués dans Modèle d'organisation.

Identifiant court (WID)

PropriétéValeur
Format6 caractères 0-9, a-z, A-Z, par exemple aB3dE9
UnicitéPar type d'objet
ModificationJamais
Validation dans les URLUn WID mal formé renvoie 400

Statuts

Propriétaires, applications, réseaux et clients portent un status :

Valeur APILibellé de la console
ACTIVE (par défaut)Actif
INACTIVEInactif
SUSPENDEDSuspendu
DRAFTBrouillon

Propriétaire

ChampTypeContraintesDescription
widchaîne6 caractèresIdentifiant court
namechaîne100 caractères, obligatoireNom (console : Nom)
descriptionchaîne250 caractèresDescription
statusstatutACTIVE par défautStatut
entityIdUUIDfacultatifEntité juridique rattachée

Application

L'application est créée par Wakastart. Les champs utiles à un partenaire :

ChampTypeContraintesDescription
widchaîne6 caractèresIdentifiant court, et identifiant du client OIDC dans Keycloak
namechaîne100 caractèresNom
shortnamechaîne3 à 12 caractères a-z0-9, unique, non modifiableNom court (par défaut le WID en minuscules)
typeénumérationAPP, MOD, SRVType, affiché en badge dans l'en-tête de l'application
urlFront, urlApiURL255 caractèresURL du front et de l'API de l'application
invitationsEnabled et champs invitation*diversvoir Configurer les invitationsRéglages des invitations

Réseau

ChampTypeContraintesDescription
widchaîne6 caractèresIdentifiant court
appIdUUIDobligatoire, non modifiableApplication distribuée
namechaîne100 caractères, obligatoireNom
descriptionchaîne250 caractèresDescription
subdomainchaîne15 caractères, minuscules, unique sur la plateformeURL Shortener
realmIdchaînerealm-<wid>Realm ID (Keycloak), fixé à la création
defLangId, defThemeIdUUIDfacultatifsLangue par défaut, Thème par défaut, hérités par les clients
entityIdUUIDfacultatifEntité juridique

Client

ChampTypeContraintesDescription
widchaîne6 caractèresIdentifiant court, nom du groupe et alias de l'organisation Keycloak
networkIdUUIDobligatoire, non modifiableRéseau du client
namechaîne100 caractères, obligatoireNom
descriptionchaîne250 caractèresDescription
entityIdUUIDobligatoire à la création par l'APIEntité juridique
subdomainchaîne15 caractères a-z0-9- par l'API, uniqueSous-domaine court
defLangId, defThemeIdUUIDfacultatifsLangue et thème par défaut, qui remplacent ceux du réseau

Entité juridique

ChampLibellé de la consoleContraintes
entityNameNom d'usage100 caractères, obligatoire
legalNameRaison sociale250 caractères
legalCountryPayscode pays à 2 lettres, FR par défaut
legalFormForme juridique
businessRegistrationIdSIREN (France)50 caractères
commercialRegistryNumberRCS (France)100 caractères
vatNumberN° TVA intracommunautaire50 caractères
fiscalYearEndDate de fin d'exercice fiscal20 caractères
addressRue, Complément (optionnel), Complément 2 (optionnel), Code postal, Ville, Pays (adresse)

Contact

ChampLibellé de la consoleContraintes
entityIdEntitéobligatoire
civilityCivilité
firstName, lastNamePrénom, Nom100 caractères chacun, obligatoires
emailEmail255 caractères, obligatoire
jobTitleFonction100 caractères
phone, mobileTéléphone, Mobile20 caractères chacun
isBillingContactbadge Facturationbooléen

Fonctionnalité

ChampLibellé de la consoleContraintes
codeCodeunique dans l'application, non modifiable ; 50 caractères dans la console, 20 par l'API publique
nameNom100 caractères, obligatoire
descriptionDescription200 caractères par l'API publique
isPaidFeature premium (payante)false par défaut
isEnabled(API)interrupteur d'application, true par défaut

Une application compte 50 fonctionnalités au plus.

Écrans de la console

ÉcranCheminAccès
Tableau de bordmenu latéralAdministrateur client ou supérieur
PropriétairesAdministration > PropriétairesPropriétaire
Entités & ContactsAdministration > Entités & ContactsPropriétaire
RéseauxAdministration > RéseauxAdministrateur réseau (droit networks.read) ou supérieur
Fiche d'un réseauRéseaux > Configuration avancéeidem ; onglets Général, Profils, App Features, Langues, Thème, Modules Crédits, Email
Paramétrage d'une applicationmenu latéral, sous le nom de l'applicationdroit apps.read (profils Développeur et Infra) ou Administrateur d'applications
Onglet FeaturesParamétrage > Featureslecture avec l'accès au paramétrage ; écriture avec apps.features.toggle

Opérations de l'API publique

URL de base : https://api.wakastart.app/api. Toutes ces opérations exigent le niveau Administrateur client au moins, en plus du droit indiqué.

OpérationMéthode et cheminDroit
Lister, consulter les propriétairesGET /config/partners, GET /config/partners/{wid}partners.read
Modifier un propriétairePUT /config/partners/{wid}partners.update
Lister, consulter les applicationsGET /config/apps, GET /config/apps/{wid}apps.read
Lister, consulter les réseauxGET /config/networks, GET /config/networks/{wid}networks.read
Créer, modifier un réseauPOST /config/networks, PUT /config/networks/{wid}networks.create, networks.update
Lister, consulter les clientsGET /config/customers, GET /config/customers/{wid}customers.read
Créer, modifier, supprimer un clientPOST /config/customers, PUT et DELETE /config/customers/{wid}customers.create, customers.update, customers.delete
Lister les fonctionnalitésGET /config/app-features, GET /config/app-features/by-app/{appWid}apps.features.read
Déclarer, modifier, supprimer une fonctionnalitéPOST /config/app-features, PATCH et DELETE /config/app-features/{id}apps.features.toggle
Vérifier une fonctionnalitéGET /config/app-features/check/{customerWid}/{featureCode}, GET /config/app-features/enabled/{customerWid}apps.features.read

Les listes acceptent page (à partir de 1) et limit (de 1 à 100, 20 par défaut), et renvoient { "data": [...], "meta": { "page", "limit", "total", "totalPages" } }. Un champ inconnu dans un corps de requête est refusé avec une erreur 400.