Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 15.1
edited by Aurelie Bertrand
on 2024/08/29 14:37
Change comment: There is no comment for this version
To version 21.1
edited by Aurelie Bertrand
on 2024/08/29 15:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,3 +1,7 @@
1 +{{ddtoc/}}
2 +
3 +----
4 +
1 1  = Accéder à Swagger UI =
2 2  
3 3  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
... ... @@ -55,6 +55,13 @@
55 55  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
56 56  Par exemple :
57 57  [[image:Requête_jwt.png||alt="Requête JWT"]]
62 +
63 +(% class="box warningmessage" %)
64 +(((
65 +❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
66 +)))
67 +
68 +(% start="5" %)
58 58  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
59 59  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
60 60  [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
... ... @@ -93,4 +93,34 @@
93 93  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
94 94  1. Cliquez sur **Authorize**.
95 95  
107 += API disponibles =
108 +
109 +== Liste des API ==
110 +
111 +Les API disponibles sont classées par type :
112 +
113 +* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
114 +* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
115 +* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
116 +* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
117 +* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
118 +
119 +(% class="box infomessage" %)
120 +(((
121 +ℹ Le cadenas fermé signifie que vous avez les droits sur l'API.
122 +)))
123 +
124 +== Opérations disponibles ==
125 +
126 +Il existe plusieurs types d'opérations pouvant être effectuées via les API :
127 +
128 +* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
129 +* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
130 +* (% style="color:#16a085" %)**PATCH**(%%)** **: pour mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.
131 +* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
132 +* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
133 +
134 +== Envoi d'une requête ==
135 +
136 +
96 96