Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13

From version 6.1
edited by Aurelie Bertrand
on 2024/08/29 11:29
Change comment: There is no comment for this version
To version 13.1
edited by Aurelie Bertrand
on 2024/08/29 14:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -54,17 +54,43 @@
54 54  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]].
55 55  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
56 56  Par exemple :
57 - [[image:Requête_jwt.png||alt="Requête JWT"]]
57 +[[image:Requête_jwt.png||alt="Requête JWT"]]
58 58  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
59 59  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
60 60  [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
61 61  1. Copiez le jeton JWT.
62 62  
63 -Vous pouvez alors vous authentifier via la seconde méthode :
63 +=== Signature du jeton de sécurité ===
64 64  
65 +Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
66 +
67 +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 :
68 +
69 +* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
70 +* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
71 +
72 +À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
73 +
74 +La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
75 +
76 +{{code language="shell"}}
77 +openssl -genrsa -out /path/to/privatekey.pem 2048
78 +{{/code}}
79 +
80 +La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
81 +
82 +{{code language="shell"}}
83 +openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
84 +{{/code}}
85 +
86 +== Authentification via BearerAuth ==
87 +
88 +(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
89 +(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
90 +
65 65  1. Cliquez sur le bouton **Authorize**.
66 -1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton.
92 +1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
93 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
67 67  1. Cliquez sur **Authorize**.
68 68  
69 -
70 70