Guide QoREST Swagger
Configuration et utilisation de l'interface API
1
Configuration initiale
1
Cliquez sur le bouton
Authorize
en haut de la page
2
Remplissez la clé
X-API-KEY
disponible dans les variables d'environnement QoREST via ArgoCD
3
Cliquez sur
Authorize
pour valider
2
Obtenir un token d'accès
1
Utilisez l'endpoint
POST /auth/token
2
Cliquez sur
Try Out
et remplissez vos identifiants :
email
: votre adresse email
password
: votre mot de passe
Astuce :
Cliquez sur
Save as Default
pour mémoriser ces valeurs pour vos prochaines sessions
3
Cliquez sur
Execute
et copiez la valeur
accessToken
retournée
4
Recliquez sur
Authorize
et saisissez :
Bearer <accessToken>
Puis validez avec
Authorize
3
Utiliser les endpoints
1
Sélectionnez l'endpoint souhaité et cliquez sur
Try Out
2
Remplissez les paramètres requis :
Request Body
: corps de la requête (JSON)
Query Params
: paramètres de requête
Path Variables
: variables dans l'URL
Exemple :
Pour l'endpoint
/evcps/{evcp_reference}/connectors/{connector_reference}/start
, remplissez
evcp_reference
et
connector_reference
3
Cliquez sur
Execute
pour lancer la requête et consulter la réponse