Changes for page DigDash API REST
Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 79.1
edited by Aurelie Bertrand
on 2025/04/29 14:06
on 2025/04/29 14:06
Change comment:
There is no comment for this version
To version 84.1
edited by Aurelie Bertrand
on 2025/04/29 14:46
on 2025/04/29 14:46
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -68,9 +68,14 @@ 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. 71 71 72 -== Créerun jetondesécurité==73 +== S'authentifier via BearerAuth == 73 73 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 + 74 74 Nous allons créer ici un jeton de sécurité Json Web Token (JWT) : 75 75 76 76 1. Allez dans la section **Authentication**. ... ... @@ -94,8 +94,10 @@ 94 94 ➡ La réponse s'affiche dans la section **Server response** en-dessous. 95 95 [[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]] 96 96 1. Copiez le jeton JWT. 102 + 97 97 98 -=== Signature du jeton de sécurité === 104 +(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %) 105 +**Signature du jeton de sécurité** 99 99 100 100 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. 101 101 ... ... @@ -118,8 +118,19 @@ 118 118 openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt 119 119 {{/code}} 120 120 121 -== Créeruneclé API==128 +=== S'authentifier === 122 122 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 + 123 123 Nous allons créer ici une clé API : 124 124 125 125 1. Allez dans la section **Authentication**. ... ... @@ -144,14 +144,16 @@ 144 144 [[image:1745928288556-250.png||alt="Réponse serveur"]] 145 145 1. Copiez la clé API. 146 146 147 -== S'authentifier via BearerAuth == 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.// 148 148 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 : 168 +=== S'authentifier === 151 151 170 +Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode : 171 + 152 152 1. Cliquez sur le bouton **Authorize**. 153 153 1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**. 154 -1. Dans la section ** BearerAuth**, collez lejetonJWTdans le champ**Value**.174 +1. Dans la section **ApiKeyAuth**, collez la clé API dans le champ Value. 155 155 1. Cliquez sur **Authorize**. 156 156 157 157 = Ressources API disponibles{{id name="ressources"/}} = ... ... @@ -225,10 +225,10 @@ 225 225 = Expiration de l'authentification = 226 226 227 227 (% style="line-height:1.7142857142857142; background-color:#ffffff" %) 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". 248 +(% 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". 229 229 (% 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. 230 230 231 231 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**. 232 -1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**. 252 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth **ou **ApiKeyAuth**. 233 233 1. Cliquez sur** Close** pour **Fermer**. 234 -1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]]. 254 +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"]].