Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 8.1
edited by Aurelie Bertrand
on 2024/08/29 11:46
Change comment: There is no comment for this version
To version 20.1
edited by Aurelie Bertrand
on 2024/08/29 15:37
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,9 @@
1 -= Ouvrir Swagger UI =
1 +{{ddtoc/}}
2 2  
3 +----
4 +
5 += Accéder à Swagger UI =
6 +
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.
5 5  
... ... @@ -22,7 +22,7 @@
22 22  Deux méthodes d'autorisation sont actuellement disponibles :
23 23  
24 24  * (((
25 -**BasicAuth **: La méthode Basic Authentification permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
29 +**BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
26 26  )))
27 27  * (((
28 28  **bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
... ... @@ -60,12 +60,67 @@
60 60  [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
61 61  1. Copiez le jeton JWT.
62 62  
67 +=== Signature du jeton de sécurité ===
68 +
69 +Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
70 +
71 +Pour des raisons de sécurité, il est vivement recommandé d'utiliser votre propre clé privée pour la signature des jetons JWT à l'aide des variables d'environnement suivantes :
72 +
73 +* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
74 +* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
75 +
76 +À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
77 +
78 +La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
79 +
80 +{{code language="shell"}}
81 +openssl -genrsa -out /path/to/privatekey.pem 2048
82 +{{/code}}
83 +
84 +La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
85 +
86 +{{code language="shell"}}
87 +openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
88 +{{/code}}
89 +
63 63  == Authentification via BearerAuth ==
64 64  
65 -== (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :(%%) ==
92 +(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
93 +(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
66 66  
67 67  1. Cliquez sur le bouton **Authorize**.
68 -1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton JWT.
96 +1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
97 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
69 69  1. Cliquez sur **Authorize**.
70 70  
100 += API disponibles =
101 +
102 +== Liste des API ==
103 +
104 +Les API disponibles sont classées par type :
105 +
106 +* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
107 +* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
108 +* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
109 +* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
110 +* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
111 +
112 +(% class="box infomessage" %)
113 +(((
114 +ℹ Le cadenas fermé signifie que vous avez les droits sur l'API.
115 +)))
116 +
117 +== Opérations disponibles ==
118 +
119 +Il existe plusieurs types d'opérations pouvant être effectuées via les API :
120 +
121 +* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
122 +* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
123 +* (% 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.
124 +* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
125 +* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
126 +
127 +== Envoi d'une requête ==
128 +
129 +
71 71