Modifications pour le document DigDash API REST

Modifié par Aurelie Bertrand le 2025/03/25 16:13
Depuis la version 14.1
modifié par Aurelie Bertrand
sur 2024/08/29 14:35
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 17.1
modifié par Aurelie Bertrand
sur 2024/08/29 15:23
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -1,4 +1,4 @@
1 -= Ouvrir Swagger UI =
1 += Accéder à Swagger UI =
2 2  
3 3  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
4 4  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
... ... @@ -93,4 +93,24 @@
93 93  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
94 94  1. Cliquez sur **Authorize**.
95 95  
96 += API disponibles =
97 +
98 +Les API disponibles sont classées par type :
99 +
100 +* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
101 +* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
102 +* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
103 +* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
104 +* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
105 +
106 +== Opérations disponibles ==
107 +
108 +Il existe plusieurs types d'opérations pouvant être effectuées via les API :
109 +
110 +* (% style="color:#3498db" %)**GET**(%%) : permet d'obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
111 +* (% style="color:#2ecc71" %)**POST**(%%) : permet de créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
112 +* (% style="color:#16a085" %)**PATCH**(%%)** **: permet de mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.
113 +* (% style="color:#e67e22" %)**PUT**(%%)** **: permet de remplacer des éléments (écrase toutes les données et les remplace).
114 +* (% style="color:#c0392b" %)**DELETE**(%%) : supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
115 +
96 96