Modifications pour le document DigDash API REST
Modifié par Aurelie Bertrand le 2025/03/25 16:13
Depuis la version 25.1
modifié par Aurelie Bertrand
sur 2024/08/29 15:56
sur 2024/08/29 15:56
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
sur 2024/08/29 15:23
Commentaire de modification :
Il n'y a aucun commentaire pour cette version
Résumé
-
Propriétés de la Page (1 modifications, 0 ajouts, 0 suppressions)
Détails
- Propriétés de la Page
-
- Contenu
-
... ... @@ -1,7 +5,3 @@ 1 -{{ddtoc/}} 2 - 3 ----- 4 - 5 5 = Accéder à Swagger UI = 6 6 7 7 Swagger UI permet de visualiser et d'interagir avec les ressources des API. ... ... @@ -39,11 +39,6 @@ 39 39 ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité. 40 40 ))) 41 41 42 -(% class="box infomessage" %) 43 -((( 44 -ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT). 45 -))) 46 - 47 47 == Authentification via BasicAuth == 48 48 49 49 1. Entrez votre nom d'utilisateur et mot de passe Digdash. ... ... @@ -64,13 +64,6 @@ 64 64 1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture. 65 65 Par exemple : 66 66 [[image:Requête_jwt.png||alt="Requête JWT"]] 67 - 68 -(% class="box warningmessage" %) 69 -((( 70 -❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons. 71 -))) 72 - 73 -(% start="5" %) 74 74 1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT). 75 75 ➡ La réponse s'affiche dans la section **Server response** en-dessous. 76 76 [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]] ... ... @@ -111,8 +111,6 @@ 111 111 112 112 = API disponibles = 113 113 114 -== Liste des API == 115 - 116 116 Les API disponibles sont classées par type : 117 117 118 118 * **Authentification **: contient l'API permettant, comme vu précédemment, la création des jetons de sécurité (JWT) ... ... @@ -121,22 +121,14 @@ 121 121 * **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc. 122 122 * **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent. 123 123 124 -(% class="box infomessage" %) 125 -((( 126 -ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé. 127 -))) 128 - 129 129 == Opérations disponibles == 130 130 131 131 Il existe plusieurs types d'opérations pouvant être effectuées via les API : 132 132 133 -* (% style="color:#3498db" %)**GET**(%%) : p our obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.134 -* (% style="color:#2ecc71" %)**POST**(%%) : p our créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.135 -* (% style="color:#16a085" %)**PATCH**(%%)** **: p our mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.136 -* (% style="color:#e67e22" %)**PUT**(%%)** **: p our remplacer des éléments (écrase toutes les données et les remplace).137 -* (% style="color:#c0392b" %)**DELETE**(%%) : poursupprimer des éléments. Par exemple, des autorisations d'un utilisateur.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. 138 138 139 -== Envoi de requêtes == 140 - 141 - 142 142