Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/11/13 09:19
From version 58.1
edited by Aurelie Bertrand
on 2024/09/04 11:20
Change comment: There is no comment for this version
To version 66.1
edited by Aurelie Bertrand
on 2025/11/13 09:19
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -DigDash API
1 +DigDash API REST
Content
... ... @@ -44,7 +44,7 @@
44 44  **BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
45 45  )))
46 46  
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.
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 BeareAuth.
48 48  
49 49  (% class="box warningmessage" %)
50 50  (((
... ... @@ -72,7 +72,7 @@
72 72  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
73 73  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é**.
74 74  S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
75 -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]].
75 +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).
76 76  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
77 77  Par exemple :
78 78  [[image:Requête_jwt.png||alt="Requête JWT"]]
... ... @@ -79,7 +79,7 @@
79 79  
80 80  (% class="box warningmessage" %)
81 81  (((
82 -❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
82 +❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
83 83  )))
84 84  
85 85  (% start="5" %)
... ... @@ -90,7 +90,7 @@
90 90  
91 91  === Signature du jeton de sécurité ===
92 92  
93 -Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
93 +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.
94 94  
95 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 :
96 96  
... ... @@ -102,7 +102,7 @@
102 102  La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
103 103  
104 104  {{code language="shell"}}
105 -openssl -genrsa -out /path/to/privatekey.pem 2048
105 +openssl genrsa -out /path/to/privatekey.pem 2048
106 106  {{/code}}
107 107  
108 108  La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
... ... @@ -150,6 +150,11 @@
150 150  
151 151  == Envoi de requêtes ==
152 152  
153 +(% class="box warningmessage" %)
154 +(((
155 +❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
156 +)))
157 +
153 153  (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
154 154  (% 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 :
155 155  
... ... @@ -161,7 +161,6 @@
161 161  ➡ (% 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.
162 162  Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
163 163  
164 -
165 165  (% 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).
166 166  À 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.
167 167  [[image:1725441504464-493.png]]