Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 78.2
edited by Aurelie Bertrand
on 2025/04/29 14:06
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  (((
... ... @@ -69,9 +69,9 @@
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 71  
72 -== Créer un jeton de sécurité ==
69 +== Créer le jeton de sécurité ==
73 73  
74 -Nous allons créer ici un jeton de sécurité Json Web Token (JWT) :
71 +Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
75 75  
76 76  1. Allez dans la section **Authentication**.
77 77  1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
... ... @@ -118,32 +118,6 @@
118 118  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
119 119  {{/code}}
120 120  
121 -== Créer une clé API ==
122 -
123 -Nous allons créer ici une clé API :
124 -
125 -1. Allez dans la section **Authentication**.
126 -1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/apikeys**
127 -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.
128 -1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
129 -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é**.
130 -S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
131 -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]].
132 -1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
133 -Par exemple :
134 -[[image:1745928168043-553.png]]
135 -
136 -(% class="box warningmessage" %)
137 -(((
138 -❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
139 -)))
140 -
141 -(% start="5" %)
142 -1. Cliquez sur le bouton **Execute **pour générer la clé API.
143 -➡ La réponse s'affiche dans la section **Server response** en-dessous.
144 -[[image:1745928288556-250.png||alt="Réponse serveur"]]
145 -1. Copiez la clé API.
146 -
147 147  == S'authentifier via BearerAuth ==
148 148  
149 149  (% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)