Aller au contenu

Applications

Lire et modifier la fiche de votre application, et gérer ses fonctionnalités activables par client avec l'API publique.

RéférenceDéveloppeurPartenaire
Voir en Markdown

La fiche d'une application porte son identité (nom, URL du front et de l'API) et le réglage de ses invitations. Les fonctionnalités de l'application sont des interrupteurs que votre code consulte pour savoir si un client y a accès. L'hébergement de l'application (environnements, services, builds) se pilote depuis la console et n'est pas couvert ici.

Note

La création et la suppression d'une application sont réservées à l'équipe Wakastart : votre application est créée par Wakastart ; contactez-nous pour en ouvrir une.

Accès commun : appelant de niveau Administrateur client (CUSTOMER_ADMIN) au minimum, avec le droit applicatif indiqué. La modification de la fiche revient au propriétaire de l'application et aux administrateurs qui lui sont rattachés.

L'objet Application

ChampTypeDescription
idUUIDIdentifiant technique
widchaîne (6)Identifiant court, qui sert aussi d'identifiant de client Keycloak
partnerIdUUIDPropriétaire. Non modifiable
namechaîne (100)Nom
descriptionchaîne (250) ou nullDescription
typechaîneAPP (application), MOD (module) ou SRV (service)
urlFrontchaîne (255) ou nullURL du front. Discovery s'en sert pour limiter la recherche par e-mail
urlApichaîne (255) ou nullURL de l'API de l'application
isHdsbooléenApplication hébergeant des données de santé
statuschaîneACTIVE, INACTIVE, SUSPENDED, DELETED ou DRAFT
invitationsEnabledbooléenInvitations autorisées (défaut true)
acceptInvitationUrlchaîne (500) ou nullAdresse de la page d'acceptation, avec l'emplacement {token} : https://mon-app.exemple.fr/invitation/{token}
invitationExpiryDaysentier, 1 à 365Validité d'une invitation, en jours (défaut 10)
invitationPerUserLimitentier, 1 à 10 000, ou nullInvitations maximales par inviteur sur 30 jours ; null : sans limite
invitationVerifyEmailbooléenVérifie l'adresse avant d'inviter (défaut true)
invitationNotifyInviterbooléenPrévient l'inviteur de l'acceptation (défaut false)
createdAt, updatedAtchaîne ISO 8601Dates de création et de modification

Lister et lire les applications

GET/api/config/apps
GET/api/config/apps/{wid}

Droit requis : apps.read. La liste est paginée (page, limit de 1 à 100, défaut 20) et limitée aux applications de votre périmètre.

Bash
curl -s https://api.wakastart.app/api/config/apps/EXAPP1 \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Réponse 200

JSON
{
  "id": "a1b2c3d4-0000-4000-8000-000000000001",
  "wid": "EXAPP1",
  "partnerId": "f0e1d2c3-4444-4b5a-9c8d-7e6f5a4b3c21",
  "name": "Mon App",
  "description": "Gestion des rendez-vous",
  "type": "APP",
  "urlFront": "https://mon-app.exemple.fr",
  "urlApi": "https://api.mon-app.exemple.fr",
  "isHds": false,
  "status": "ACTIVE",
  "invitationsEnabled": true,
  "acceptInvitationUrl": "https://mon-app.exemple.fr/invitation/{token}",
  "invitationExpiryDays": 10,
  "invitationPerUserLimit": null,
  "invitationVerifyEmail": true,
  "invitationNotifyInviter": false,
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-10-01T08:20:00.000Z"
}

Erreurs : 403 Accès refusé à cette application ; 404 App with WID <wid> not found.

Modifier l'application

PUT/api/config/apps/{wid}

Droit requis : apps.update. Tous les champs sont facultatifs.

ChampTypeContraintes
namechaîne100 caractères au plus
descriptionchaîne250 caractères au plus
urlFront, urlApichaîne255 caractères au plus
invitationsEnabledbooléen—
acceptInvitationUrlchaîne500 caractères au plus, avec {token}
invitationExpiryDaysentier1 à 365
invitationPerUserLimitentier ou null1 à 10 000
invitationVerifyEmail, invitationNotifyInviterbooléen—

L'activation des données de santé (isHds) se fait depuis la console, qui provisionne en même temps le module HDS pour chaque client de l'application.

Bash
curl -s -X PUT https://api.wakastart.app/api/config/apps/EXAPP1 \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "acceptInvitationUrl": "https://mon-app.exemple.fr/invitation/{token}",
    "invitationExpiryDays": 14
  }'

Réponse : l'objet Application modifié.

Erreurs : 403 Accès refusé à cette application.

L'objet Fonctionnalité

ChampTypeDescription
idUUIDIdentifiant
appIdUUIDApplication. Non modifiable
codechaîne (20)Code unique dans l'application, que votre code teste : export-pdf
namechaîne (100)Libellé
descriptionchaîne (200) ou nullDescription
isPaidbooléenFonctionnalité payante (défaut false)
isEnabledbooléenDisponible dans l'application (défaut true)

Une application compte 50 fonctionnalités au plus. Une fonctionnalité n'est active pour un client que si elle l'est pour l'application, pour son réseau et pour le client lui-même ; l'activation par réseau et par client se fait dans la console.

Savoir si une fonctionnalité est active pour un client

GET/api/config/app-features/check/{customerWid}/{featureCode}

Droit requis : apps.features.read.

Bash
curl -s https://api.wakastart.app/api/config/app-features/check/EXCLI1/export-pdf \
  -H "x-api-key: sk_test_exemple"

Réponse 200

JSON
{ "featureCode": "export-pdf", "customerId": "c3d5e7f9-2b4c-4d6e-9f0a-1b2c3d4e5f60", "isEnabled": true }
GET/api/config/app-features/enabled/{customerWid}

Droit requis : apps.features.read. Renvoie les codes de toutes les fonctionnalités actives pour le client :

JSON
{ "customerId": "c3d5e7f9-2b4c-4d6e-9f0a-1b2c3d4e5f60", "features": ["export-pdf", "agenda-partage"] }

Le jeton de l'utilisateur ne porte pas ses fonctionnalités : interrogez ces endpoints depuis votre serveur, et gardez le résultat en cache quelques minutes.

Lister les fonctionnalités

GET/api/config/app-features/by-app/{appWid}

Droit requis : apps.features.read. Renvoie le tableau des fonctionnalités de l'application. GET /api/config/app-features (paginé) et GET /api/config/app-features/{id} lisent avec le même droit.

Créer, modifier ou supprimer une fonctionnalité

POST/api/config/app-features

Droit requis : apps.features.toggle.

ChampTypeObligatoireContraintes
appIdUUIDouiApplication
codechaîneoui20 caractères au plus, unique dans l'application
namechaîneoui100 caractères au plus
descriptionchaînenon200 caractères au plus
isPaidbooléennonDéfaut false
isEnabledbooléennonDéfaut true
Bash
curl -s -X POST https://api.wakastart.app/api/config/app-features \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "appId": "a1b2c3d4-0000-4000-8000-000000000001",
    "code": "export-pdf",
    "name": "Export PDF"
  }'

Réponse 201 : l'objet Fonctionnalité créé.

PATCH/api/config/app-features/{id}
DELETE/api/config/app-features/{id}

Droit requis : apps.features.toggle. La modification accepte les champs de la création, tous facultatifs, sauf appId.

Erreurs : 409 Maximum 50 features allowed per app ; 409 Feature with code '<code>' already exists for this app ; 403 App feature not found or not accessible.