Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 25.1
edited by Aurelie Bertrand
on 2024/08/29 15:56
Change comment: There is no comment for this version
To version 50.2
edited by Aurelie Bertrand
on 2024/09/04 10:10
Change comment: Update document after refactoring.

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +Digdash.WebHome
Content
... ... @@ -2,6 +2,10 @@
2 2  
3 3  ----
4 4  
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 +
5 5  = Accéder à Swagger UI =
6 6  
7 7  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
... ... @@ -14,8 +14,16 @@
14 14  Par exemple:
15 15  [[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
16 16  
17 -Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
21 +Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
18 18  
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 +
28 +(% class="wikigeneratedid" %)
29 +[[image:DD_API.png]]
30 +
19 19  = S'authentifier =
20 20  
21 21  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
... ... @@ -44,18 +44,18 @@
44 44  ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
45 45  )))
46 46  
47 -== Authentification via BasicAuth ==
59 +== S'authentifier via BasicAuth ==
48 48  
49 49  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
50 50  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
51 51  ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
52 52  
53 -== Création du jeton de sécurité ==
65 +== Créer le jeton de sécurité ==
54 54  
55 55  Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
56 56  
57 57  1. Allez dans la section **Authentication**.
58 -1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.**
70 +1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
59 59  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.
60 60  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
61 61  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é**.
... ... @@ -99,7 +99,7 @@
99 99  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
100 100  {{/code}}
101 101  
102 -== Authentification via BearerAuth ==
114 +== S'authentifier via BearerAuth ==
103 103  
104 104  (% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
105 105  (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
... ... @@ -109,26 +109,26 @@
109 109  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
110 110  1. Cliquez sur **Authorize**.
111 111  
112 -= API disponibles =
124 += Ressources API disponibles =
113 113  
114 -== Liste des API ==
126 +== Liste des ressources ==
115 115  
116 -Les API disponibles sont classées par type :
128 +Les ressources disponibles sont classées par type :
117 117  
118 -* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
119 -* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
120 -* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
121 -* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
122 -* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
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.
123 123  
124 124  (% class="box infomessage" %)
125 125  (((
126 -ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
138 +ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
127 127  )))
128 128  
129 129  == Opérations disponibles ==
130 130  
131 -Il existe plusieurs types d'opérations pouvant être effectuées via les API :
143 +Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
132 132  
133 133  * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
134 134  * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
... ... @@ -138,5 +138,43 @@
138 138  
139 139  == Envoi de requêtes ==
140 140  
153 +(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
154 +(% 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 :
141 141  
156 +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é.
157 +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.
158 +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) .
159 +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 ci-dessous.
160 +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.**(%%)
161 +➡ (% 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. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
162 +
163 +(% class="wikigeneratedid" id="HParamE8tres" %)
164 +**Paramètres**
165 +
166 +(% style="width:785px" %)
167 +|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
168 +|(% 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.
169 +|(% 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.
170 +|(% style="width:173px" %)resolveProfiles|(% style="width:608px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seraont affichées.
171 +Par exemple, si l'utilisateur a des rôles issus d'un profil, ce sont les rôles du profil qui seont affichés et non pas les rôles propres à l'utilisateur.
172 +|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
173 +|(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
174 +Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
175 +
176 += Expiration et révocation de l'authentification =
177 +
178 +(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
179 +(% 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".
180 +(% 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 invalider le jeton expiré et générer un nouveau jeton d'accès.
181 +
182 +(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
183 +De même l(% 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" %)orsque vous avez terminé de travailler avec l'interface Swagger, vous devez invalider le jeton d'accès que vous avez utilisé.
184 +
185 +(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
186 +(% 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" %)Pour invalider le jeton de sécurité :
187 +
188 +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**.
189 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
190 +1. Cliquez sur** Close** pour **Fermer**.
191 +
142 142  
DD_API.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +63.1 KB
Content