Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 46.1
edited by Aurelie Bertrand
on 2024/08/30 10:20
Change comment: There is no comment for this version
To version 26.1
edited by Aurelie Bertrand
on 2024/08/29 16:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,10 +2,6 @@
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 -
9 9  = Accéder à Swagger UI =
10 10  
11 11  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
... ... @@ -18,16 +18,8 @@
18 18  Par exemple:
19 19  [[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
20 20  
21 -Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
17 +Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
22 22  
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 -
31 31  = S'authentifier =
32 32  
33 33  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
... ... @@ -56,18 +56,18 @@
56 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 57  )))
58 58  
59 -== S'authentifier via BasicAuth ==
47 +== Authentification via BasicAuth ==
60 60  
61 61  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
62 62  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
63 63  ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
64 64  
65 -== Créer le jeton de sécurité ==
53 +== Création du jeton de sécurité ==
66 66  
67 67  Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
68 68  
69 69  1. Allez dans la section **Authentication**.
70 -1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
58 +1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.**
71 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.
72 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 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é**.
... ... @@ -111,7 +111,7 @@
111 111  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
112 112  {{/code}}
113 113  
114 -== S'authentifier via BearerAuth ==
102 +== Authentification via BearerAuth ==
115 115  
116 116  (% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
117 117  (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
... ... @@ -151,42 +151,12 @@
151 151  == Envoi de requêtes ==
152 152  
153 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 :
142 +(% 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 vous y êtes autorisé, vous pouvez effectuer des requêtes :
155 155  
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 API 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.
144 +1. (% 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" %)Développez une API avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé
145 +1. (% 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" %)Dans la fenêtre de méthode développée, cliquez sur Essayer(Essayer) .
146 +1. (% 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" %)Spécifiez les valeurs des paramètres si nécessaire.
162 162  
163 -(% class="wikigeneratedid" id="HParamE8tres" %)
164 -**Paramètres**
148 +(% 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" %)Cliquez sur Exécuter. La requête est exécutée. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
165 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 -
192 192  
DD_API.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -63.1 KB
Content