Changes for page DigDash API REST

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

Summary

Details

Page properties
Content
... ... @@ -68,14 +68,9 @@
68 68  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
69 69  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
70 70  ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
71 -Vous pouvez à présent créer un jeton JWT ou un clé API pour vous connecter.
72 72  
73 -== S'authentifier via BearerAuth ==
72 +== Créer un jeton de sécurité ==
74 74  
75 -Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
76 -
77 -=== Créer un jeton de sécurité ===
78 -
79 79  Nous allons créer ici un jeton de sécurité Json Web Token (JWT) :
80 80  
81 81  1. Allez dans la section **Authentication**.
... ... @@ -99,10 +99,8 @@
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 -
103 103  
104 -(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
105 -**Signature du jeton de sécurité**
98 +=== Signature du jeton de sécurité ===
106 106  
107 107  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.
108 108  
... ... @@ -125,19 +125,8 @@
125 125  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
126 126  {{/code}}
127 127  
128 -=== S'authentifier ===
121 +== Créer une clé API ==
129 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 -
137 -== S'authentifier via ApiKeyAuth ==
138 -
139 -=== Créer une clé API ===
140 -
141 141  Nous allons créer ici une clé API :
142 142  
143 143  1. Allez dans la section **Authentication**.
... ... @@ -162,17 +162,14 @@
162 162  [[image:1745928288556-250.png||alt="Réponse serveur"]]
163 163  1. Copiez la clé API.
164 164  
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.
147 +== S'authentifier via BearerAuth ==
168 168  
169 -=== S'authentifier ===
149 +(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
150 +(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
170 170  
171 -Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
172 -
173 173  1. Cliquez sur le bouton **Authorize**.
174 174  1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
175 -1. Dans la section **ApiKeyAuth**, collez la clé API dans le champ Value.
154 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
176 176  1. Cliquez sur **Authorize**.
177 177  
178 178  = Ressources API disponibles{{id name="ressources"/}} =
... ... @@ -246,18 +246,10 @@
246 246  = Expiration de l'authentification =
247 247  
248 248  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
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".
228 +(% 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".
250 250  (% 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.
251 251  
252 252  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**.
253 -1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth **ou **ApiKeyAuth**.
232 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
254 254  1. Cliquez sur** Close** pour **Fermer**.
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 -
234 +1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].