Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 82.1
edited by Aurelie Bertrand
on 2025/04/29 14:24
Change comment: There is no comment for this version
To version 78.1
edited by Aurelie Bertrand
on 2025/04/29 14:04
Change comment: Ajout du fichier 1745928288556-250.png

Summary

Details

Page properties
Content
... ... @@ -47,11 +47,8 @@
47 47  * (((
48 48  **BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
49 49  )))
50 -* (((
51 -**ApiKeyAuth** : La méthode Api Key Authentification qui permet de s'identifier avec une clé API.
52 -)))
53 53  
54 -La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité ou une clé API et utiliser l'une des deux autres méthodes.
51 +La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité et utiliser la seconde méthode d'authentification BeareAuth.
55 55  
56 56  (% class="box warningmessage" %)
57 57  (((
... ... @@ -68,16 +68,11 @@
68 68  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
69 69  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
70 70  ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
71 -Vous pouvez à présent créer un jeton JWT ou un clé API pour vous connecter.
72 72  
73 -== S'authentifier via BearerAuth ==
69 +== Créer le jeton de sécurité ==
74 74  
75 -Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
71 +Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
76 76  
77 -=== Créer un jeton de sécurité ===
78 -
79 -Nous allons créer ici un jeton de sécurité Json Web Token (JWT) :
80 -
81 81  1. Allez dans la section **Authentication**.
82 82  1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
83 83  1. Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
... ... @@ -99,10 +99,8 @@
99 99  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
100 100  [[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
101 101  1. Copiez le jeton JWT.
102 -
103 103  
104 -(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
105 -**Signature du jeton de sécurité**
95 +=== Signature du jeton de sécurité ===
106 106  
107 107  Une clé privée utilisée pour signer le JWT est générée par défaut. Cette clé est temporaire et est régénérée à chaque redémarrage du serveur.
108 108  
... ... @@ -125,50 +125,14 @@
125 125  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
126 126  {{/code}}
127 127  
128 -=== S'authentifier ===
118 +== S'authentifier via BearerAuth ==
129 129  
130 -Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
120 +(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
121 +(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
131 131  
132 -1. Cliquez sur le bouton **Authorize**.
133 -1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
134 -1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
135 -1. Cliquez sur **Authorize**.
136 -
137 -== S'authentifier via ApiKeyAuth ==
138 -
139 -=== Créer une clé API ===
140 -
141 -Nous allons créer ici une clé API :
142 -
143 -1. Allez dans la section **Authentication**.
144 -1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/apikeys**
145 -1. Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
146 -1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
147 -1*. **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer la clé API dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**.
148 -S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
149 -1*. **expires** : (Optionnel) Indiquez la période de validité la clé API spécifiée sous la forme d'une période de temps au format ISO 8601 (c'est-à-dire PT5M pour 5 minutes). Pour plus d'informations, consultez [[https:~~/~~/en.wikipedia.org/wiki/ISO_8601#Durations>>https://en.wikipedia.org/wiki/ISO_8601#Durations]].
150 -1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
151 -Par exemple :
152 -[[image:1745928168043-553.png]]
153 -
154 -(% class="box warningmessage" %)
155 -(((
156 -❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
157 -)))
158 -
159 -(% start="5" %)
160 -1. Cliquez sur le bouton **Execute **pour générer la clé API.
161 -➡ La réponse s'affiche dans la section **Server response** en-dessous.
162 -[[image:1745928288556-250.png||alt="Réponse serveur"]]
163 -1. Copiez la clé API.
164 -
165 -=== S'authentifier ===
166 -
167 -Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
168 -
169 169  1. Cliquez sur le bouton **Authorize**.
170 170  1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
171 -1. Dans la section **ApiKeyAuth**, collez la clé API dans le champ Value.
125 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
172 172  1. Cliquez sur **Authorize**.
173 173  
174 174  = Ressources API disponibles{{id name="ressources"/}} =