Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 17.1
edited by Aurelie Bertrand
on 2024/08/29 15:23
Change comment: There is no comment for this version
To version 24.1
edited by Aurelie Bertrand
on 2024/08/29 15:45
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"]]
... ... @@ -95,6 +95,8 @@
95 95  
96 96  = API disponibles =
97 97  
109 +== Liste des API ==
110 +
98 98  Les API disponibles sont classées par type :
99 99  
100 100  * **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
... ... @@ -103,14 +103,22 @@
103 103  * **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
104 104  * **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
105 105  
119 +(% class="box infomessage" %)
120 +(((
121 +ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
122 +)))
123 +
106 106  == Opérations disponibles ==
107 107  
108 108  Il existe plusieurs types d'opérations pouvant être effectuées via les API :
109 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.
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.
115 115  
134 +== Envoi de requêtes ==
135 +
136 +
116 116