# 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.

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](/v1.0/reference-api/organisations). Les concepts sont expliqués dans [Modèle d'organisation](/v1.0/organisations/modele-d-organisation).

## Identifiant court (WID)

| Propriété | Valeur |
|---|---|
| Format | 6 caractères `0-9`, `a-z`, `A-Z`, par exemple `aB3dE9` |
| Unicité | Par type d'objet |
| Modification | Jamais |
| Validation dans les URL | Un WID mal formé renvoie 400 |

## Statuts

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

| Valeur API | Libellé de la console |
|---|---|
| `ACTIVE` (par défaut) | Actif |
| `INACTIVE` | Inactif |
| `SUSPENDED` | Suspendu |
| `DRAFT` | Brouillon |

## Propriétaire

| Champ | Type | Contraintes | Description |
|---|---|---|---|
| `wid` | chaîne | 6 caractères | Identifiant court |
| `name` | chaîne | 100 caractères, obligatoire | Nom (console : **Nom**) |
| `description` | chaîne | 250 caractères | Description |
| `status` | statut | `ACTIVE` par défaut | Statut |
| `entityId` | UUID | facultatif | Entité juridique rattachée |

## Application

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

| Champ | Type | Contraintes | Description |
|---|---|---|---|
| `wid` | chaîne | 6 caractères | Identifiant court, et identifiant du client OIDC dans Keycloak |
| `name` | chaîne | 100 caractères | Nom |
| `shortname` | chaîne | 3 à 12 caractères `a-z0-9`, unique, non modifiable | Nom court (par défaut le WID en minuscules) |
| `type` | énumération | `APP`, `MOD`, `SRV` | Type, affiché en badge dans l'en-tête de l'application |
| `urlFront`, `urlApi` | URL | 255 caractères | URL du front et de l'API de l'application |
| `invitationsEnabled` et champs `invitation*` | divers | voir [Configurer les invitations](/v1.0/utilisateurs/configurer-les-invitations) | Réglages des invitations |

## Réseau

| Champ | Type | Contraintes | Description |
|---|---|---|---|
| `wid` | chaîne | 6 caractères | Identifiant court |
| `appId` | UUID | obligatoire, non modifiable | Application distribuée |
| `name` | chaîne | 100 caractères, obligatoire | **Nom** |
| `description` | chaîne | 250 caractères | **Description** |
| `subdomain` | chaîne | 15 caractères, minuscules, unique sur la plateforme | **URL Shortener** |
| `realmId` | chaîne | `realm-<wid>` | **Realm ID (Keycloak)**, fixé à la création |
| `defLangId`, `defThemeId` | UUID | facultatifs | **Langue par défaut**, **Thème par défaut**, hérités par les clients |
| `entityId` | UUID | facultatif | Entité juridique |

## Client

| Champ | Type | Contraintes | Description |
|---|---|---|---|
| `wid` | chaîne | 6 caractères | Identifiant court, nom du groupe et alias de l'organisation Keycloak |
| `networkId` | UUID | obligatoire, non modifiable | Réseau du client |
| `name` | chaîne | 100 caractères, obligatoire | Nom |
| `description` | chaîne | 250 caractères | Description |
| `entityId` | UUID | obligatoire à la création par l'API | Entité juridique |
| `subdomain` | chaîne | 15 caractères `a-z0-9-` par l'API, unique | Sous-domaine court |
| `defLangId`, `defThemeId` | UUID | facultatifs | Langue et thème par défaut, qui remplacent ceux du réseau |

## Entité juridique

| Champ | Libellé de la console | Contraintes |
|---|---|---|
| `entityName` | **Nom d'usage** | 100 caractères, obligatoire |
| `legalName` | **Raison sociale** | 250 caractères |
| `legalCountry` | **Pays** | code pays à 2 lettres, `FR` par défaut |
| `legalForm` | **Forme juridique** | |
| `businessRegistrationId` | **SIREN** (France) | 50 caractères |
| `commercialRegistryNumber` | **RCS** (France) | 100 caractères |
| `vatNumber` | **N° TVA intracommunautaire** | 50 caractères |
| `fiscalYearEnd` | **Date de fin d'exercice fiscal** | 20 caractères |
| `address` | **Rue**, **Complément (optionnel)**, **Complément 2 (optionnel)**, **Code postal**, **Ville**, **Pays (adresse)** | |

## Contact

| Champ | Libellé de la console | Contraintes |
|---|---|---|
| `entityId` | **Entité** | obligatoire |
| `civility` | **Civilité** | |
| `firstName`, `lastName` | **Prénom**, **Nom** | 100 caractères chacun, obligatoires |
| `email` | **Email** | 255 caractères, obligatoire |
| `jobTitle` | **Fonction** | 100 caractères |
| `phone`, `mobile` | **Téléphone**, **Mobile** | 20 caractères chacun |
| `isBillingContact` | badge **Facturation** | booléen |

## Fonctionnalité

| Champ | Libellé de la console | Contraintes |
|---|---|---|
| `code` | **Code** | unique dans l'application, non modifiable ; 50 caractères dans la console, 20 par l'API publique |
| `name` | **Nom** | 100 caractères, obligatoire |
| `description` | **Description** | 200 caractères par l'API publique |
| `isPaid` | **Feature 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

| Écran | Chemin | Accès |
|---|---|---|
| **Tableau de bord** | menu latéral | Administrateur client ou supérieur |
| **Propriétaires** | **Administration** > **Propriétaires** | Propriétaire |
| **Entités & Contacts** | **Administration** > **Entités & Contacts** | Propriétaire |
| **Réseaux** | **Administration** > **Réseaux** | Administrateur réseau (droit `networks.read`) ou supérieur |
| Fiche d'un réseau | **Réseaux** > **Configuration avancée** | idem ; onglets **Général**, **Profils**, **App Features**, **Langues**, **Thème**, **Modules Crédits**, **Email** |
| **Paramétrage** d'une application | menu latéral, sous le nom de l'application | droit `apps.read` (profils **Développeur** et **Infra**) ou Administrateur d'applications |
| Onglet **Features** | **Paramétrage** > **Features** | lecture 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ération | Méthode et chemin | Droit |
|---|---|---|
| Lister, consulter les propriétaires | `GET /config/partners`, `GET /config/partners/{wid}` | `partners.read` |
| Modifier un propriétaire | `PUT /config/partners/{wid}` | `partners.update` |
| Lister, consulter les applications | `GET /config/apps`, `GET /config/apps/{wid}` | `apps.read` |
| Lister, consulter les réseaux | `GET /config/networks`, `GET /config/networks/{wid}` | `networks.read` |
| Créer, modifier un réseau | `POST /config/networks`, `PUT /config/networks/{wid}` | `networks.create`, `networks.update` |
| Lister, consulter les clients | `GET /config/customers`, `GET /config/customers/{wid}` | `customers.read` |
| Créer, modifier, supprimer un client | `POST /config/customers`, `PUT` et `DELETE /config/customers/{wid}` | `customers.create`, `customers.update`, `customers.delete` |
| Lister les fonctionnalités | `GET /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.
