Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 80.1
edited by Aurelie Bertrand
on 2025/04/29 14:20
Change comment: There is no comment for this version
To version 87.2
edited by Aurelie Bertrand
on 2025/04/29 15:02
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -99,8 +99,10 @@
99 99  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
100 100  [[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
101 101  1. Copiez le jeton JWT.
102 +
102 102  
103 -==== Signature du jeton de sécurité ====
104 +(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
105 +**Signature du jeton de sécurité**
104 104  
105 105  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.
106 106  
... ... @@ -123,6 +123,15 @@
123 123  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
124 124  {{/code}}
125 125  
128 +=== S'authentifier ===
129 +
130 +Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
131 +
132 +1. Cliquez sur le bouton **Authorize**.
133 +1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
134 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
135 +1. Cliquez sur **Authorize**.
136 +
126 126  == S'authentifier via ApiKeyAuth ==
127 127  
128 128  === Créer une clé API ===
... ... @@ -151,6 +151,10 @@
151 151  [[image:1745928288556-250.png||alt="Réponse serveur"]]
152 152  1. Copiez la clé API.
153 153  
165 +(% class="wikigeneratedid" %)
166 +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.//
167 +La clé est hashée et ne peut donc être récupérée.
168 +
154 154  === S'authentifier ===
155 155  
156 156  Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
... ... @@ -231,10 +231,18 @@
231 231  = Expiration de l'authentification =
232 232  
233 233  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
234 -(% 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 le jeton de sécurité (JWT) expire, vous recevez une réponse (% style="color:#182027; font-family:~"Roboto Mono~",monospace; font-size:10pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)401:(%%) "Unauthorized".
249 +(% 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 le jeton de sécurité (JWT) ou la clé API expire, vous recevez une réponse (% style="color:#182027; font-family:~"Roboto Mono~",monospace; font-size:10pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)401:(%%) "Unauthorized".
235 235  (% 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" %)L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton a expiré. Lorsque cela se produit, vous devez vous déconnecter de (%%)BearerAuth** **(% 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" %)et générer un nouveau jeton d'accès.
236 236  
237 237  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" %)Cliquez sur le bouton **Authorize** pour ouvrir la fenêtre **Available authorizations**.
238 -1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
253 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth **ou **ApiKeyAuth**.
239 239  1. Cliquez sur** Close** pour **Fermer**.
240 -1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
255 +1. Générez un nouveau jeton d'accès ou une nouvelle clé API comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
256 +
257 += Invalider un jeton JWT ou une clé API =
258 +
259 +Pour un jeton JWT, l'invalidation se fait de manière globale seulement en changeant la clé privée utilisée pour signer et la clé publique associée utilisée pour valider les signatures.
260 +
261 +Pour une clé API, l'invalidation se fait de manière individuelle et globale. Les clés sont stockées côté serveur dans un fichier csv (pas de cache car stateful) donc l'invalidation individuelle est possible soit via l'endpoint prévu (POST /api/v1/auth/apikeys/delete), soit en modifiant le fichier serveur éteint. L'invalidation globale consiste tout simplement à invalider toutes les clés ou effacer le fichier csv serveur éteint.
262 +
263 +