Wiki source code of DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
Hide last authors
Aurelie Bertrand 19.1 1 {{ddtoc/}}
2
3 ----
4
Aurelie Bertrand 37.1 5 (% class="wikigeneratedid" %)
6 DigDash propose une API REST pour interagir avec un certain nombre d'objets DigDash.
7 Vous pouvez utiliser Swagger pour la tester.
8
Aurelie Bertrand 15.1 9 = Accéder à Swagger UI =
Aurelie Bertrand 1.2 10
11 Swagger UI permet de visualiser et d'interagir avec les ressources des API.
12 Cette interface fournit également une documentation visuelle facilitant leur utilisation.
13
14 Pour ouvrir Swagger UI, utilisez le lien suivant :
Aurelie Bertrand 4.1 15 [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
Aurelie Bertrand 1.2 16 dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
17
18 Par exemple:
Aurelie Bertrand 53.1 19 [[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
Aurelie Bertrand 1.2 20
Aurelie Bertrand 37.1 21 Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
Aurelie Bertrand 1.2 22
Aurelie Bertrand 32.1 23 (% class="box infomessage" %)
24 (((
25 💡 Dans le cas où le nom de domaine a été modifié, il est possible de spécifier un domaine ddapi personnalisé dans le champ **domain**.
26 )))
27
Aurelie Bertrand 37.1 28 (% class="wikigeneratedid" %)
Aurelie Bertrand 38.1 29 [[image:DD_API.png]]
Aurelie Bertrand 37.1 30
Aurelie Bertrand 55.1 31 = S'authentifier{{id name="Auth"/}} =
Aurelie Bertrand 1.2 32
33 Afin de pouvoir interagir avec les API, vous devez vous authentifier.
34
Aurelie Bertrand 4.1 35 * (% 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**(% 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" %) en haut à droite de la page Digdash API. (Le cadenas ouvert signifie que vous n’êtes pas autorisé.)(%%)
36 ➡ (% 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" %)La fenêtre (%%)**Available authorizations** ((% 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" %)Autorisations disponibles) s'affiche.
Aurelie Bertrand 1.2 37
38 Deux méthodes d'autorisation sont actuellement disponibles :
39
40 * (((
Aurelie Bertrand 14.1 41 **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
Aurelie Bertrand 1.2 42 )))
43 * (((
Aurelie Bertrand 53.1 44 **BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
Aurelie Bertrand 1.2 45 )))
46
Aurelie Bertrand 61.1 47 La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité et utiliser la seconde méthode d'authentification BeareAuth.
Aurelie Bertrand 1.2 48
49 (% class="box warningmessage" %)
50 (((
51 ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
52 )))
53
Aurelie Bertrand 25.1 54 (% class="box infomessage" %)
55 (((
56 ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
57 )))
58
Aurelie Bertrand 42.1 59 == S'authentifier via BasicAuth ==
Aurelie Bertrand 1.3 60
Aurelie Bertrand 1.4 61 1. Entrez votre nom d'utilisateur et mot de passe Digdash.
62 1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
63 ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
Aurelie Bertrand 1.3 64
Aurelie Bertrand 43.1 65 == Créer le jeton de sécurité ==
Aurelie Bertrand 1.3 66
Aurelie Bertrand 1.4 67 Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
68
69 1. Allez dans la section **Authentication**.
Aurelie Bertrand 34.1 70 1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
Aurelie Bertrand 1.4 71 1. Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
Aurelie Bertrand 5.2 72 1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
73 1*. **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer le JWT dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**.
Aurelie Bertrand 3.1 74 S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
Aurelie Bertrand 5.2 75 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]].
Aurelie Bertrand 5.3 76 1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
Aurelie Bertrand 5.4 77 Par exemple :
Aurelie Bertrand 7.1 78 [[image:Requête_jwt.png||alt="Requête JWT"]]
Aurelie Bertrand 21.1 79
80 (% class="box warningmessage" %)
81 (((
Aurelie Bertrand 59.1 82 ❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
Aurelie Bertrand 21.1 83 )))
84
85 (% start="5" %)
Aurelie Bertrand 5.4 86 1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
87 ➡ La réponse s'affiche dans la section **Server response** en-dessous.
88 [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
89 1. Copiez le jeton JWT.
Aurelie Bertrand 3.1 90
Aurelie Bertrand 9.1 91 === Signature du jeton de sécurité ===
92
Aurelie Bertrand 64.1 93 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.
Aurelie Bertrand 9.1 94
Aurelie Bertrand 10.1 95 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 :
Aurelie Bertrand 9.1 96
Aurelie Bertrand 10.1 97 * **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
98 * **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
Aurelie Bertrand 9.1 99
Aurelie Bertrand 10.1 100 À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
Aurelie Bertrand 9.1 101
Aurelie Bertrand 10.1 102 La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
Aurelie Bertrand 9.1 103
Aurelie Bertrand 10.1 104 {{code language="shell"}}
Aurelie Bertrand 63.1 105 openssl genrsa -out /path/to/privatekey.pem 2048
Aurelie Bertrand 10.1 106 {{/code}}
Aurelie Bertrand 9.1 107
Aurelie Bertrand 10.1 108 La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
Aurelie Bertrand 9.1 109
Aurelie Bertrand 10.1 110 {{code language="shell"}}
111 openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
112 {{/code}}
Aurelie Bertrand 9.1 113
Aurelie Bertrand 44.1 114 == S'authentifier via BearerAuth ==
Aurelie Bertrand 7.1 115
Aurelie Bertrand 12.1 116 (% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
117 (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
Aurelie Bertrand 7.1 118
Aurelie Bertrand 5.4 119 1. Cliquez sur le bouton **Authorize**.
Aurelie Bertrand 53.1 120 1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
Aurelie Bertrand 13.1 121 1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
Aurelie Bertrand 5.4 122 1. Cliquez sur **Authorize**.
123
Aurelie Bertrand 48.1 124 = Ressources API disponibles =
Aurelie Bertrand 15.2 125
Aurelie Bertrand 48.1 126 == Liste des ressources ==
Aurelie Bertrand 18.1 127
Aurelie Bertrand 48.1 128 Les ressources disponibles sont classées par type :
Aurelie Bertrand 15.2 129
Aurelie Bertrand 48.1 130 * **Authentification **: pour la création des jetons de sécurité (JWT)
131 * **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
132 * **System** : pour les informations système, service d'audit et ordonnanceur.
133 * **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
134 * **Event Management** : pour l'ajout d'évènements avec fireEvent.
Aurelie Bertrand 15.2 135
Aurelie Bertrand 20.1 136 (% class="box infomessage" %)
137 (((
Aurelie Bertrand 49.1 138 ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
Aurelie Bertrand 20.1 139 )))
140
Aurelie Bertrand 15.3 141 == Opérations disponibles ==
142
Aurelie Bertrand 49.1 143 Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
Aurelie Bertrand 15.3 144
Aurelie Bertrand 18.1 145 * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
146 * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
147 * (% style="color:#16a085" %)**PATCH**(%%)** **: pour mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.
148 * (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
149 * (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
Aurelie Bertrand 15.3 150
Aurelie Bertrand 23.1 151 == Envoi de requêtes ==
Aurelie Bertrand 20.1 152
Aurelie Bertrand 60.1 153 (% class="box warningmessage" %)
154 (((
155 ❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
156 )))
157
Aurelie Bertrand 26.1 158 (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
Aurelie Bertrand 27.1 159 (% 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 vous y êtes autorisé, vous pouvez effectuer des requêtes :
Aurelie Bertrand 20.1 160
Aurelie Bertrand 49.1 161 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" %)Développez une ressource avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
Aurelie Bertrand 27.1 162 1. Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
163 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" %)Dans la fenêtre de méthode développée, cliquez sur **Try it out **(Essayer) .
Aurelie Bertrand 57.1 164 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" %)Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée dans le tableau ci-dessous.
Aurelie Bertrand 27.1 165 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 **Execute.**(%%)
Aurelie Bertrand 57.1 166 ➡ (% 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" %)La requête est exécutée et la réponse s'affiche.
167 Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
Aurelie Bertrand 26.1 168
Aurelie Bertrand 58.1 169 (% id="cke_bm_11947S" style="display:none" %) (%%)Swagger propose également des lignes de commande curl lors de l'exécution des requêtes afin d'aider à tester ou coder un outil en dehors du navigateur (dans un script par exemple).
170 À noter qu'il faut spécifier, que soit pour curl ou un autre outil, les entêtes HTTP "Accept" (format du contenu à récupérer) et "Content-Type" (format du contenu envoyé) pour que les requêtes fonctionnent correctement. Ces deux entêtes peuvent prendre les valeurs "application/json" pour du json ou "application/xml" pour du xml.
171 [[image:1725441504464-493.png]]
172
Aurelie Bertrand 33.1 173 (% class="wikigeneratedid" id="HParamE8tres" %)
174 **Paramètres**
Aurelie Bertrand 31.1 175
176 (% style="width:785px" %)
177 |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
178 |(% style="width:173px" %)includes|(% style="width:608px" %)Vous pouvez ajouter les rôles, autorisations (acls) et/ou groupes d'autorisations (groupacls) au résultat de la requête.
179 |(% style="width:173px" %)id (obligatoire)|(% style="width:608px" %)Spécifiez le nom de l'utilisateur, rôle.. selon l'API à utiliser pour l'opération.
Aurelie Bertrand 53.1 180 |(% style="width:173px" %)resolveProfiles|(% style="width:608px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seront affichées.
181 Par exemple, si l'utilisateur a des rôles issus d'un profil, ce sont les rôles du profil qui seront affichés et non pas les rôles propres à l'utilisateur.
Aurelie Bertrand 31.1 182 |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
183 |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
184 Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
185
Aurelie Bertrand 53.1 186 = Expiration de l'authentification =
Aurelie Bertrand 35.1 187
188 (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
Aurelie Bertrand 45.1 189 (% 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".
Aurelie Bertrand 53.1 190 (% 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.
Aurelie Bertrand 35.1 191
Aurelie Bertrand 41.1 192 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**.
Aurelie Bertrand 45.1 193 1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
Aurelie Bertrand 46.1 194 1. Cliquez sur** Close** pour **Fermer**.
Aurelie Bertrand 56.1 195 1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].