Changes for page DigDash API REST

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

Summary

Details

Page properties
Content
... ... @@ -56,13 +56,13 @@
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 -== Authentification via BasicAuth ==
59 +== S'authentifier 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éation du jeton de sécurité ==
65 +== Créer le jeton de sécurité ==
66 66  
67 67  Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
68 68  
... ... @@ -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 -== Authentification via BearerAuth ==
114 +== S'authentifier 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 :
... ... @@ -121,26 +121,26 @@
121 121  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
122 122  1. Cliquez sur **Authorize**.
123 123  
124 -= API disponibles =
124 += Ressources API disponibles =
125 125  
126 -== Liste des API ==
126 +== Liste des ressources ==
127 127  
128 -Les API disponibles sont classées par type :
128 +Les ressources disponibles sont classées par type :
129 129  
130 -* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
131 -* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
132 -* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
133 -* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
134 -* **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.
135 135  
136 136  (% class="box infomessage" %)
137 137  (((
138 -ℹ 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é.
139 139  )))
140 140  
141 141  == Opérations disponibles ==
142 142  
143 -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 :
144 144  
145 145  * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
146 146  * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
... ... @@ -153,7 +153,7 @@
153 153  (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
154 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 :
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é.
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 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 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 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.
... ... @@ -176,9 +176,17 @@
176 176  = Expiration et révocation de l'authentification =
177 177  
178 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".
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.
180 180  
181 181  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
182 -(% 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 :
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é.
183 183  
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 +
184 184