Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 18.1
edited by Aurelie Bertrand
on 2024/08/29 15:26
Change comment: There is no comment for this version
To version 25.1
edited by Aurelie Bertrand
on 2024/08/29 15:56
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.
... ... @@ -35,6 +35,11 @@
35 35  ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
36 36  )))
37 37  
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 +
38 38  == Authentification via BasicAuth ==
39 39  
40 40  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
... ... @@ -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"]]
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" %)
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"]]
... ... @@ -105,6 +105,11 @@
105 105  * **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
106 106  * **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
107 107  
124 +(% class="box infomessage" %)
125 +(((
126 +ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
127 +)))
128 +
108 108  == Opérations disponibles ==
109 109  
110 110  Il existe plusieurs types d'opérations pouvant être effectuées via les API :
... ... @@ -115,4 +115,7 @@
115 115  * (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
116 116  * (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
117 117  
139 +== Envoi de requêtes ==
140 +
141 +
118 118