Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 33.1
edited by Aurelie Bertrand
on 2024/08/29 17:12
Change comment: There is no comment for this version
To version 43.1
edited by Aurelie Bertrand
on 2024/08/30 09:37
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,18 +49,18 @@
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  
62 62  1. Allez dans la section **Authentication**.
63 -1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.**
70 +1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
64 64  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.
65 65  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
66 66  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é**.
... ... @@ -166,6 +166,13 @@
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 -
176 += Expiration et révocation de l'authentification =
170 170  
171 -= Expiration et révocation de l'accès =
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 d'accès 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 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. Pour invalider le jeton :
181 +
182 +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**.
183 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
184 +
185 +
DD_API.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +63.1 KB
Content