Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29

From 56.1 to 55.1 From 74.1 to 73.1

From version 73.1

edited by Aurelie Bertrand
on 2025/04/25 14:23

Change comment: There is no comment for this version

To version 56.1

edited by Aurelie Bertrand
on 2024/09/04 10:55

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 4 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--DigDash API REST
++DigDash API

Content

@@ -11,16 +11,12 @@
  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
--Pour ouvrir Swagger UI, vous pouvez :
--
--* cliquer sur le lien **API** présent en bas de la page d'accueil
--
--* utiliser le lien suivant :(((
++Pour ouvrir Swagger UI, utilisez le lien suivant :
  [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
  dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
++
  Par exemple:
  [[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
--)))
  Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
@@ -30,7 +30,7 @@
  )))
  (% class="wikigeneratedid" %)
--[[image:DigDash_API.png||alt="Interface Swagger" height="770" width="1043"]]
++[[image:DD_API.png]]
  = S'authentifier{{id name="Auth"/}} =
@@ -48,7 +48,7 @@
  **BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
  )))
--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.
++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.
  (% class="box warningmessage" %)
  (((
@@ -79,24 +79,24 @@
 *. **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]].
 *. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
  Par exemple :
--[[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
++[[image:Requête_jwt.png||alt="Requête JWT"]]
  (% class="box warningmessage" %)
  (((
--❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
++❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
  )))
  (% start="5" %)
 . Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
--[[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
++[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
 . Copiez le jeton JWT.
  === Signature du jeton de sécurité ===
--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.
++Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
--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 :
++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 :
  * **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
  * **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
@@ -106,7 +106,7 @@
  La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
  {{code language="shell"}}
--openssl genrsa -out /path/to/privatekey.pem 2048
++openssl -genrsa -out /path/to/privatekey.pem 2048
  {{/code}}
  La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
@@ -125,7 +125,7 @@
 . Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
 . Cliquez sur **Authorize**.
--= Ressources API disponibles{{id name="ressources"/}} =
++= Ressources API disponibles =
  == Liste des ressources ==
@@ -132,12 +132,10 @@
  Les ressources disponibles sont classées par type :
  * **Authentification **: pour la création des jetons de sécurité (JWT)
--* **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.
--* **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
++* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
  * **System** : pour les informations système, service d'audit et ordonnanceur.
  * **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
  * **Event Management** : pour l'ajout d'évènements avec fireEvent.
--* **Connections **: pour la gestion des connexions aux bases de donnnées : liste, création, remplacement, supression.
  (% class="box infomessage" %)
  (((
@@ -156,11 +156,6 @@
  == Envoi de requêtes ==
--(% class="box warningmessage" %)
--(((
--❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
--)))
--
  (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
  (% 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 :
@@ -167,15 +167,10 @@
 . (% 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" %)Développez une ressource avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
 . Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
 . (% 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" %)Dans la fenêtre de méthode développée, cliquez sur **Try it out **(Essayer) .
--1. (% 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" %)Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée dans le tableau ci-dessous.
++1. (% 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" %)Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée ci-dessous.
 . (% 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" %)Cliquez sur **Execute.**(%%)
--➡ (% 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.
--Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
++➡ (% 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. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
--(% 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).
--À 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.
--[[image:1725441504464-493.png]]
--
  (% class="wikigeneratedid" id="HParamE8tres" %)
  **Paramètres**

1725441504464-493.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-25.3 KB

Content

DigDash_API.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-86.5 KB

Content

DigDash_API_token_creation_FR.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-13.6 KB

Content

DigDash_API_token_creation_response_FR.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-58.4 KB

Content

Changes for page DigDash API REST

Summary

Details

Sommaire