Serveur.Info
En bref
6 opérations sur 5 chemins. Préfixe /v2. Authentification JWT (voir Démarrer).
Opérations
| Méthode | Chemin | Rôle |
|---|---|---|
GET |
/v2/serveur/check |
Appel GET sur serveur/check |
GET |
/v2/serveur/config/{configName} |
Appel GET sur serveur/config |
POST |
/v2/serveur/config/{configName} |
Appel POST sur serveur/config |
GET |
/v2/serveur/ping |
Appel GET sur serveur/ping |
GET |
/v2/serveur/sync-confirm |
Appel GET sur serveur/sync-confirm |
GET |
/v2/serveur/version |
Appel GET sur serveur/version |
Rôle déduit
La spécification ne porte ni summary ni description d'opération : la colonne Rôle est déduite mécaniquement de la méthode HTTP et du chemin.
Détail
GET /v2/serveur/check
Appel GET sur serveur/check.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
userEmail |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/serveur/check?userEmail=<userEmail>" \
-H "Accept: application/json"
Cette opération est déclarée anonyme dans le contrat (aucun schéma de sécurité).
GET /v2/serveur/config/{configName}
Appel GET sur serveur/config.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
configName |
path | string |
oui | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/serveur/config/<configName>" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
POST /v2/serveur/config/{configName}
Appel POST sur serveur/config.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
configName |
path | string |
oui | - |
Corps de la requête (application/json)
Schéma ConfigDto - 1 propriétés (détail : Schémas).
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X POST "https://<votre-connecteur>/v2/serveur/config/<configName>" \
-H "Authorization: Bearer <jeton>" \
-H "Content-Type: application/json" \
-d '{"valeur": "…"}'
GET /v2/serveur/ping
Appel GET sur serveur/ping.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/serveur/ping?targets=DEMO&limit=50" \
-H "Accept: application/json"
Cette opération est déclarée anonyme dans le contrat (aucun schéma de sécurité).
GET /v2/serveur/sync-confirm
Appel GET sur serveur/sync-confirm.
Paramètres
| Nom | Emplacement | Type | Obligatoire | Description |
|---|---|---|---|---|
id |
query | string |
non | - |
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/serveur/sync-confirm?id=<id>" \
-H "Accept: application/json"
Cette opération est déclarée anonyme dans le contrat (aucun schéma de sécurité).
GET /v2/serveur/version
Appel GET sur serveur/version.
Réponses
| Code | Description | Schéma de data |
|---|---|---|
200 |
OK | - |
401 |
Unauthorized | - |
403 |
Forbidden | - |
Exemple
curl -s -X GET "https://<votre-connecteur>/v2/serveur/version?targets=DEMO&limit=50" \
-H "Authorization: Bearer <jeton>" \
-H "Accept: application/json"
Schémas
Schémas résolus à un niveau : les propriétés qui référencent un autre schéma sont citées par leur nom, sans être dépliées.
ConfigDto
ConfigDto - 1 propriétés
| Propriété | Type | Notes |
|---|---|---|
valeur |
string |
nullable |