Aller au contenu

Server

En bref

7 opérations sur 6 chemins. Routes héritées, sans préfixe /v2. Authentification JWT (voir Démarrer).

Routes héritées

Les chemins de ce groupe ne portent pas le préfixe /v2 : ils proviennent de la surface historique du connecteur, publiée dans la même spécification. Pour une intégration neuve, préférez l'équivalent /v2 (voir Conventions).

Opérations

Méthode Chemin Rôle
GET /Server/check Appel GET sur Server/check
GET /Server/config/{configName} Appel GET sur Server/config
POST /Server/config/{configName} Appel POST sur Server/config
GET /Server/ping Appel GET sur Server/ping
GET /Server/sync-confirm Appel GET sur Server/sync-confirm
POST /Server/token Appel POST sur Server/token
GET /Server/version Appel GET sur Server/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 /Server/check

Appel GET sur Server/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>/Server/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 /Server/config/{configName}

Appel GET sur Server/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>/Server/config/<configName>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

POST /Server/config/{configName}

Appel POST sur Server/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>/Server/config/<configName>" \
  -H "Authorization: Bearer <jeton>" \
  -H "Content-Type: application/json" \
  -d '{"valeur": "…"}'

GET /Server/ping

Appel GET sur Server/ping.

Réponses

Code Description Schéma de data
200 OK —

Exemple

curl -s -X GET "https://<votre-connecteur>/Server/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 /Server/sync-confirm

Appel GET sur Server/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>/Server/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é).

POST /Server/token

Appel POST sur Server/token.

Corps de la requête (application/json)

Schéma LivraisonJetonDto — 2 propriétés (détail : Schémas).

Réponses

Code Description Schéma de data
200 OK —

Exemple

curl -s -X POST "https://<votre-connecteur>/Server/token" \
  -H "Content-Type: application/json" \
  -d '{"delivery_id": "…", "server_token": "…"}'

Cette opération est déclarée anonyme dans le contrat (aucun schéma de sécurité).

GET /Server/version

Appel GET sur Server/version.

Réponses

Code Description Schéma de data
200 OK —
401 Unauthorized —
403 Forbidden —

Exemple

curl -s -X GET "https://<votre-connecteur>/Server/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

LivraisonJetonDto

LivraisonJetonDto — 2 propriétés
Propriété Type Notes
delivery_id string nullable
server_token string nullable

Voir aussi