Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 66.1
edited by Aurelie Bertrand
on 2025/03/14 10:07
Change comment: There is no comment for this version
To version 58.1
edited by Aurelie Bertrand
on 2024/09/04 11:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -DigDash API REST
1 +DigDash API
Content
... ... @@ -11,16 +11,12 @@
11 11  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
12 12  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
13 13  
14 -Pour ouvrir Swagger UI, vous pouvez :
15 -
16 -* cliquer sur le lien **API** présent en bas de la page d'accueil
17 -
18 -* utiliser le lien suivant :(((
14 +Pour ouvrir Swagger UI, utilisez le lien suivant :
19 19  [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
20 20  dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
17 +
21 21  Par exemple:
22 22  [[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
23 -)))
24 24  
25 25  Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
26 26  
... ... @@ -30,7 +30,7 @@
30 30  )))
31 31  
32 32  (% class="wikigeneratedid" %)
33 -[[image:DigDash_API.png||height="770" width="1043"]]
29 +[[image:DD_API.png]]
34 34  
35 35  = S'authentifier{{id name="Auth"/}} =
36 36  
... ... @@ -48,7 +48,7 @@
48 48  **BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
49 49  )))
50 50  
51 -La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité et utiliser la seconde méthode d'authentification BeareAuth.
47 +La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité et utiliser la seconde méthode d'authentification.
52 52  
53 53  (% class="box warningmessage" %)
54 54  (((
... ... @@ -83,7 +83,7 @@
83 83  
84 84  (% class="box warningmessage" %)
85 85  (((
86 -❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
82 +❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
87 87  )))
88 88  
89 89  (% start="5" %)
... ... @@ -94,9 +94,9 @@
94 94  
95 95  === Signature du jeton de sécurité ===
96 96  
97 -Une clé privée utilisée pour signer le JWT est générée par défaut. Cette clé est temporaire et est régénérée à chaque redémarrage du serveur.
93 +Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
98 98  
99 -Pour éviter ce problème et améliorer la sécurité, il est vivement recommandé d'utiliser votre propre clé privée pour la signature des jetons JWT à l'aide des variables d'environnement suivantes :
95 +Pour des raisons de sécurité, il est vivement recommandé d'utiliser votre propre clé privée pour la signature des jetons JWT à l'aide des variables d'environnement suivantes :
100 100  
101 101  * **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
102 102  * **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
... ... @@ -133,11 +133,9 @@
133 133  
134 134  * **Authentification **: pour la création des jetons de sécurité (JWT)
135 135  * **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
136 -* **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
137 137  * **System** : pour les informations système, service d'audit et ordonnanceur.
138 138  * **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
139 139  * **Event Management** : pour l'ajout d'évènements avec fireEvent.
140 -* **Connections **: pour la gestion des connexions aux bases de donnnées : liste, création, remplacement, supression.
141 141  
142 142  (% class="box infomessage" %)
143 143  (((
... ... @@ -156,11 +156,6 @@
156 156  
157 157  == Envoi de requêtes ==
158 158  
159 -(% class="box warningmessage" %)
160 -(((
161 -❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
162 -)))
163 -
164 164  (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
165 165  (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Lorsque vous y êtes autorisé, vous pouvez effectuer des requêtes :
166 166  
... ... @@ -172,6 +172,7 @@
172 172  ➡ (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)La requête est exécutée et la réponse s'affiche.
173 173  Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
174 174  
164 +
175 175  (% id="cke_bm_11947S" style="display:none" %) (%%)Swagger propose également des lignes de commande curl lors de l'exécution des requêtes afin d'aider à tester ou coder un outil en dehors du navigateur (dans un script par exemple).
176 176  À noter qu'il faut spécifier, que soit pour curl ou un autre outil, les entêtes HTTP "Accept" (format du contenu à récupérer) et "Content-Type" (format du contenu envoyé) pour que les requêtes fonctionnent correctement. Ces deux entêtes peuvent prendre les valeurs "application/json" pour du json ou "application/xml" pour du xml.
177 177  [[image:1725441504464-493.png]]
DigDash_API.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -86.5 KB
Content