Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 81.1
edited by Aurelie Bertrand
on 2025/04/29 14:22
Change comment: There is no comment for this version
To version 88.1
edited by Aurelie Bertrand
on 2025/04/29 15:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -125,6 +125,15 @@
125 125  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
126 126  {{/code}}
127 127  
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 +
128 128  == S'authentifier via ApiKeyAuth ==
129 129  
130 130  === Créer une clé API ===
... ... @@ -153,6 +153,10 @@
153 153  [[image:1745928288556-250.png||alt="Réponse serveur"]]
154 154  1. Copiez la clé API.
155 155  
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 +
156 156  === S'authentifier ===
157 157  
158 158  Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
... ... @@ -233,10 +233,21 @@
233 233  = Expiration de l'authentification =
234 234  
235 235  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
236 -(% 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".
237 237  (% 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.
238 238  
239 239  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**.
240 -1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
253 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth **ou **ApiKeyAuth**.
241 241  1. Cliquez sur** Close** pour **Fermer**.
242 -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.
262 +Pour invalider une ou plusieurs clés, vous pouvez tout d'abord récupérer la liste des clés en utilisant l'enpoint GET /api/v1/auth/apikeys
263 +
264 +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.
265 +
266 +