Changes for page DigDash API REST

Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 1 added, 0 removed)
  • DD_API.png

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,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.
...	...	@@ -55,7 +55,7 @@
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é**.
...	...	@@ -144,11 +144,12 @@
144	144	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é.
145	145	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.
146	146	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) .
147		-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.
	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.
148	148	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.**(%%)
149	149	➡ (% 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.
150	150
151		-=== Paramètres ===
	163	+(% class="wikigeneratedid" id="HParamE8tres" %)
	164	+**Paramètres**
152	152
153	153	(% style="width:785px" %)
154	154	|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
...	...	@@ -160,6 +160,13 @@
160	160	|(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
161	161	Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
162	162
163		-
	176	+= Expiration et révocation de l'authentification =
164	164
165		-= 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