ORM_ApiSetup
Configure le mode API de l'ORM_CSHX2. Active ou désactive globalement les fonctionnalités liées à l'API, et différencie automatiquement le rôle serveur (le projet est l'API) du rôle client (le projet appelle une API distante) selon les paramètres fournis.
📋 Description
ORM_ApiSetup définit la posture du projet hôte vis-à-vis de l'API REST :
- Le drapeau
bAPIActivéeest l'interrupteur principal : il active ou désactive les fonctionnalités liées à l'API. Lorsqu'il est àFaux, les autres paramètres sont sans effet. - Le rôle (serveur ou client) est déterminé automatiquement à partir de la présence ou non d'une URL cible : si le projet fournit une URL et un token, c'est qu'il appelle une API distante (mode client) ; sinon, c'est qu'il est lui-même l'API (mode serveur).
Les 3 configurations possibles
| Configuration | bAPIActivée | sURL | Token | Description |
|---|---|---|---|---|
| Désactivé | Faux | — (ignoré) | — (ignoré) | Les fonctionnalités liées à l'API sont désactivées. Mode habituel d'une application standalone qui ne fait ni serveur ni client API. |
| Serveur | Vrai | "" (vide) |
Null |
Le projet est l'API : il expose des points d'entrée que d'autres applications consomment. Aucune URL cible n'est définie puisque l'API tourne localement. |
| Client | Vrai | URL renseignée | Token fourni | Le projet appelle une API distante : sURL indique le serveur cible et Token assure l'authentification de chaque requête. |
🔑 Signature
| Paramètre | Type | Défaut | Description |
|---|---|---|---|
| bAPIActivée | booléen | — | Interrupteur global du mode API. Faux désactive toutes les fonctionnalités liées à l'API, indépendamment des autres paramètres. |
| sURL | chaîne | "" | URL de l'API distante en mode client. Laisser vide pour signifier que le projet est lui-même l'API (mode serveur). |
| Token | AuthToken | Null | Jeton d'authentification (type WinDev natif AuthToken) utilisé par le client pour s'identifier auprès de l'API distante. |
Aucune valeur de retour : la procédure applique simplement la configuration.
💡 Exemples
Exemple 1 — Mode API désactivé
Configuration d'une application standalone qui n'utilise ni serveur ni client API. C'est la configuration par défaut la plus courante.
Exemple 2 — Mode serveur (le projet EST l'API)
Configuration d'une application qui expose elle-même une API REST. Aucune URL cible puisque l'API tourne dans le projet hôte.
Exemple 3 — Mode client (le projet APPELLE une API distante)
Configuration d'une application qui consomme une API REST distante. L'URL cible et le token d'authentification sont fournis.