Référence API
URL de base, environnements, authentification et liste des domaines de l'API publique Wakastart et de Discovery.
This page has not been translated yet and is shown in French.
Cette référence décrit les deux services HTTP que votre application et vos serveurs appellent : l'API publique de Wakastart, qui gère l'organisation de vos clients, leurs utilisateurs, leurs droits et les modules, et Discovery, qui indique à votre application où connecter ses utilisateurs. Chaque endpoint décrit ici a été vérifié dans le code de la plateforme.
URL de base
| Service | URL de base | Authentification |
|---|---|---|
| API publique | https://api.wakastart.app/api | Jeton Keycloak, jeton enrichi ou clé API (voir Authentification) |
| Discovery | https://discovery.wakastart.app | Aucune : le service est public |
Tous les chemins de l'API publique commencent par /api. Les exemples de cette référence écrivent l'URL complète, par exemple https://api.wakastart.app/api/me.
curl -s https://api.wakastart.app/api/healthzRéponse attendue :
{
"status": "ok",
"timestamp": "2026-10-23T09:12:44.512Z",
"uptime": 86400,
"service": "ws-back-api",
"version": "1.0.0"
}Environnements
Une seule URL de base sert les trois environnements de votre application, dev, staging et prod. L'API déduit l'environnement de l'appel :
- d'un jeton Keycloak ou d'un jeton enrichi : l'environnement de la session, porté par le jeton lui-même ;
- d'une clé API : l'environnement auquel la clé est liée à sa création.
Les données renvoyées suivent cet environnement. Par exemple, GET /api/me renvoie le profil que l'utilisateur possède dans l'environnement de sa session.
Chaque environnement a en revanche sa propre instance Keycloak : https://auth.wakastart.app en production, https://auth-staging.wakastart.app en staging et https://auth-dev.wakastart.app en développement. Votre application ne code jamais cette adresse en dur : elle la lit dans sa variable KEYCLOAK_URL, posée par environnement, ou dans la réponse de Discovery.
Lire cette référence
Chaque page couvre un domaine et suit le même ordre : une description, les objets du domaine avec leurs champs, puis une section par endpoint. Une section d'endpoint indique :
- la méthode et le chemin ;
- l'accès requis : le niveau d'administration minimal de l'appelant et, le cas échéant, le droit applicatif exigé, par exemple
users.read; - les paramètres de chemin, de requête et de corps, avec leur type, leurs contraintes et leur valeur par défaut ;
- un exemple cURL, parfois suivi d'un exemple TypeScript, puis la réponse attendue ;
- les codes d'erreur propres à l'endpoint. Les erreurs communes à toute l'API sont décrites dans Codes d'erreur.
Les niveaux d'administration s'écrivent dans l'API avec leur code : PARTNER_ADMIN (Propriétaire), APP_ADMIN (Administrateur d'applications), NETWORK_ADMIN (Administrateur réseau), CUSTOMER_ADMIN (Administrateur client), USER (Utilisateur) et NONE. Un niveau inclut tous les niveaux inférieurs.
Note
L'hébergement (environnements, services, builds, bases de données, domaines) se pilote depuis la console Wakastart : l'API publique n'expose pas ces opérations. La création d'une application est réservée à l'équipe Wakastart : votre application est créée par Wakastart ; contactez-nous pour en ouvrir une.
Domaines
Envoyer un jeton Keycloak, un jeton enrichi ou une clé API.
ConventionsFormat JSON, erreurs, pagination, filtres, limites de débit et CORS.
DiscoveryObtenir l'adresse de connexion Keycloak à partir de l'URL de votre front.
Jeton et /meLire l'utilisateur connecté, enrichir un jeton, vérifier une autorisation.
OrganisationsRéseaux et clients de votre application.
UtilisateursCréer, modifier, désactiver et importer des utilisateurs.
ÉquipesRegrouper des utilisateurs et gérer leurs niveaux d'équipe.
Droits et profilsCatalogue de droits, profils et attribution par environnement.
InvitationsInviter un utilisateur, suivre et accepter une invitation.
Clés APIFormat, portée et usage d'une clé API.
AuditLire le journal d'audit de votre organisation.
ApplicationsFiche de l'application et fonctionnalités activables.
Contenus de l'applicationThèmes, langues, traductions, branding et configuration au démarrage.
AntivirusFaire analyser un fichier et recevoir le résultat.
HDSCoffres, documents et partages de données de santé.
PaiementsFaire payer vos utilisateurs avec Stripe Checkout.
CréditsAcheter un pack de crédits et comprendre les débits.
Documents légauxLire et rendre les CGU, CGV et documents RGPD de l'application.
Ressources
- Codes d'erreur : chaque statut HTTP et les messages métier fréquents.
- Limites et quotas : limites de débit, tailles maximales et valeurs par défaut.
- Outils pour assistants IA : interroger cette documentation depuis Claude, Cursor ou un autre client MCP.
- Notes de version : évolutions de la plateforme et de sa documentation.