Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2026/01/19 11:55
From version 106.1
edited by Aurelie Bertrand
on 2026/01/19 11:49
Change comment: There is no comment for this version
To version 97.1
edited by Aurelie Bertrand
on 2025/04/29 17:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Tags
... ... @@ -1,1 +1,1 @@
1 -API|Clé API|Jeton JWT
1 +API
Content
... ... @@ -84,7 +84,7 @@
84 84  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
85 85  1*. **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer le JWT dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**.
86 86  S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
87 -1*. **expires** : (Optionnel mais recommandé) Indiquez la période de validité du JWT spécifiée sous la forme d'une période de temps au format ISO 8601 (c'est-à-dire PT5M pour 5 minutes). Pour plus d'informations, consultez [[https:~~/~~/en.wikipedia.org/wiki/ISO_8601#Durations>>https://en.wikipedia.org/wiki/ISO_8601#Durations]]. (% style="color:#d35400" %)⚠ Seul le format PnDTnHnMnS est supporté (%%): il est possible de mettre des jours, heures, minutes et secondes mais pas des années, mois ou semaines (PnYnMnWnDTnHnMnS).
87 +1*. **expires** : (Optionnel mais recommandé) Indiquez la période de validité du JWT spécifiée sous la forme d'une période de temps au format ISO 8601 (c'est-à-dire PT5M pour 5 minutes). Pour plus d'informations, consultez [[https:~~/~~/en.wikipedia.org/wiki/ISO_8601#Durations>>https://en.wikipedia.org/wiki/ISO_8601#Durations]].
88 88  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
89 89  Par exemple :
90 90  [[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
... ... @@ -134,7 +134,7 @@
134 134  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
135 135  1. Cliquez sur **Authorize**.
136 136  
137 -== S'authentifier via ApiKeyAuth{{id name="ApiKeyAuth"/}} ==
137 +== S'authentifier via ApiKeyAuth ==
138 138  
139 139  Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
140 140  
... ... @@ -148,8 +148,7 @@
148 148  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
149 149  1*. **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer la clé API dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**.
150 150  S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
151 -1*. **expires** : (Optionnel) Indiquez la période de validité la clé API spécifiée sous la forme d'une période de temps au format ISO 8601 (c'est-à-dire PT5M pour 5 minutes). Pour plus d'informations, consultez [[https:~~/~~/en.wikipedia.org/wiki/ISO_8601#Durations>>https://en.wikipedia.org/wiki/ISO_8601#Durations]]. (% style="color:#d35400" %)⚠ Seul le format PnDTnHnMnS est supporté(%%): il est possible de mettre des jours, heures, minutes et secondes mais pas des années, mois ou semaines (PnYnMnWnDTnHnMnS).
152 -Si l'élément //expires// n'est pas dans la requête, la clé a une durée infinie.
151 +1*. **expires** : (Optionnel) Indiquez la période de validité la clé API spécifiée sous la forme d'une période de temps au format ISO 8601 (c'est-à-dire PT5M pour 5 minutes). Pour plus d'informations, consultez [[https:~~/~~/en.wikipedia.org/wiki/ISO_8601#Durations>>https://en.wikipedia.org/wiki/ISO_8601#Durations]].
153 153  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
154 154  Par exemple :
155 155  [[image:1745928168043-553.png]]
... ... @@ -164,13 +164,10 @@
164 164  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
165 165  [[image:1745928288556-250.png||alt="Réponse serveur"]]
166 166  1. Copiez la clé API.
167 -❗La clé affichée n'est affichée qu'une seule fois et ne peut être récupérée autrement car elle est hashée (cryptée de façon irréversible) lors du stockage sur le serveur pour des raisons de sécurité.(((
168 -Si une clé est perdue ou inutile, elle doit être invalidée et une autre clé doit être créée si nécessaire.
169 -)))
170 170  
171 -La clé API est stockée côté serveur dans un fichier CSV nommé **//apikeys.csv//**, situé par défaut dans le répertoire //appdata/EnterpriseServer/ddenterpriseapi/config//. Cependant, si un emplacement personnalisé a été défini via le paramètre **//ddenterpriseapi.ServerSettingsPath//** dans le fichier //digdash.properties//, cette configuration prend le pas sur le chemin par défaut.
172 -Vous pouvez modifier ce répertoire, ou spécifier plusieurs répertoires dans le cas de plusieurs domaines, dans le fichier //digdash.properties// en les ajoutant sous la forme suivante //: ddenterprise.api_keys_path=/chemin/vers/fichier.csv. //
173 -Cette propriété a la priorité sur //ddenterpriseapi.ServerSettingsPath//.
167 +(% class="wikigeneratedid" %)
168 +La clé API est stockée côté serveur dans un fichier csv //apikeys.csv, //situé par défaut dans le répertoire //appdata/EnterpriseServer/ddenterpriseapi/config. //Vous pouvez modifier le répertoire, ou spécifier les répertoires dans le cas de plusieurs domaines, dans le fichier //digdash.properties// en les ajoutant sous la forme suivante //: ddenterprise.api_keys_path=/chemin/vers/fichier.csv.//
169 +La clé est hashée et ne peut donc être récupérée.
174 174  
175 175  === S'authentifier ===
176 176  
... ... @@ -188,7 +188,7 @@
188 188  Les ressources disponibles sont classées par type :
189 189  
190 190  * **Authentification **: pour la création des jetons de sécurité (JWT)
191 -* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, groupes d'autorisations des rôles, etc.
187 +* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, groupes d'autosations des rôles, etc.
192 192  * **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
193 193  * **System** : pour les informations système, service d'audit et ordonnanceur.
194 194  * **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
... ... @@ -210,7 +210,7 @@
210 210  * (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
211 211  * (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
212 212  
213 -== Envoi de requêtes{{id name="envoi"/}} ==
209 +== Envoi de requêtes ==
214 214  
215 215  (% class="box warningmessage" %)
216 216  (((
... ... @@ -242,7 +242,7 @@
242 242  |(% style="width:173px" %)resolveProfiles|(% style="width:1214px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seront affichées.
243 243  Par exemple, si l'utilisateur a des rôles issus d'un profil, ce sont les rôles du profil qui seront affichés et non pas les rôles propres à l'utilisateur.
244 244  |(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Session management**
245 -|(% style="width:173px" %)users|(% style="width:1214px" %)Vous pouvez spécifier des utilisateurs pour la requête : cliquez sur le bouton **Add string item** et entrez le nom d'un utilisateur. Répétez l'opération si besoin avec les autres utilisateurs.         
241 +|(% style="width:173px" %)users|(% style="width:1214px" %)Vous pouvez spécifier des utilisateurs pour la requête : cliquez sur le bouton **Add string item** et entrez le nom d'un utilisateur. Répétez l'opération si besoin avec les autres utilisateurs. 
246 246  |(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Connection management**
247 247  |(% style="width:173px" %)itemRole|(% style="width:1214px" %)Vous pouvez restreindre la requête aux connexions de bases de données resteintes aux rôles spécifiés ici.
248 248  |(% style="width:173px" %)nameFilter|(% style="width:1214px" %)Vous pouvez restreindre la requête aux connexions de bases de données dont le nom contient la chaîne texte spécifiée ici.
... ... @@ -279,7 +279,7 @@
279 279  1. Vous pouvez tout d'abord récupérer la liste des clés API ave leur identifiant en utilisant **GET /api/v1/auth/apikeys**. Vous obtenez la liste sous la forme suivante :
280 280  [[image:1745932166616-318.png||alt="Liste clés API"]]
281 281  
282 -1. Envoyez une liste d'identifiants (en JSON ou XML selon le Content-Type comme expliqué dans la partie [[Envoi de requêtes>>doc:||anchor="envoi"]]) à "POST /api/v1/auth/apikeys/delete" pour invalider une ou plusieurs clés
278 +1. Utilisez ensuite **DELETE /api/v1/auth/apikeys **: entrez l'identifiant de la clé API à invalider ou, dans le cas de plusieurs clés, les identifiants séparés par des virgules.
283 283  
284 284  Pour invalider toutes les clés API, supprimez toutes les clés comme ci-dessus ou supprimer le fichier csv //apikeys.csv //contenant les clés avec le serveur éteint.
285 285