Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 35.1
edited by Aurelie Bertrand
on 2024/08/30 08:52
Change comment: There is no comment for this version
To version 48.1
edited by Aurelie Bertrand
on 2024/09/02 11:11
Change comment: There is no comment for this version

Summary

Details

Page properties
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,7 +14,7 @@
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  
19 19  (% class="box infomessage" %)
20 20  (((
... ... @@ -21,6 +21,9 @@
21 21  💡 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**.
22 22  )))
23 23  
28 +(% class="wikigeneratedid" %)
29 +[[image:DD_API.png]]
30 +
24 24  = S'authentifier =
25 25  
26 26  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
... ... @@ -49,13 +49,13 @@
49 49  ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
50 50  )))
51 51  
52 -== Authentification via BasicAuth ==
59 +== S'authentifier via BasicAuth ==
53 53  
54 54  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
55 55  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
56 56  ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
57 57  
58 -== Création du jeton de sécurité ==
65 +== Créer le jeton de sécurité ==
59 59  
60 60  Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
61 61  
... ... @@ -104,7 +104,7 @@
104 104  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
105 105  {{/code}}
106 106  
107 -== Authentification via BearerAuth ==
114 +== S'authentifier via BearerAuth ==
108 108  
109 109  (% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
110 110  (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
... ... @@ -114,17 +114,17 @@
114 114  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
115 115  1. Cliquez sur **Authorize**.
116 116  
117 -= API disponibles =
124 += Ressources API disponibles =
118 118  
119 -== Liste des API ==
126 +== Liste des ressources ==
120 120  
121 -Les API disponibles sont classées par type :
128 +Les ressources disponibles sont classées par type :
122 122  
123 -* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
124 -* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
125 -* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
126 -* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
127 -* **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.
128 128  
129 129  (% class="box infomessage" %)
130 130  (((
... ... @@ -166,14 +166,20 @@
166 166  |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
167 167  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
168 168  
169 -
170 -
171 171  = Expiration et révocation de l'authentification =
172 172  
173 173  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
174 -(% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)Lorsque le jeton d'accès expire, vous recevez une réponse (% style="font-size: 10pt; font-variant: normal; white-space: pre-wrap; font-family: ~"Roboto Mono~", monospace; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)401:(%%) "Unauthorized".
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.
175 175  
176 176  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
177 -(% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton d'accès a expiré. Lorsque cela se produit, vous devez invalider le jeton expiré et générer un nouveau jeton d'accès :
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é.
178 178  
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 +
179 179  
DD_API.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +63.1 KB
Content