Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 77.1
edited by Aurelie Bertrand
on 2025/04/29 14:02
Change comment: Ajout du fichier 1745928168043-553.png
To version 80.1
edited by Aurelie Bertrand
on 2025/04/29 14:20
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -47,8 +47,11 @@
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 +)))
50 50  
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.
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.
52 52  
53 53  (% class="box warningmessage" %)
54 54  (((
... ... @@ -65,11 +65,16 @@
65 65  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
66 66  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
67 67  ➡ 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.
68 68  
69 -== Créer le jeton de sécurité ==
73 +== S'authentifier via BearerAuth ==
70 70  
71 -Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
75 +Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
72 72  
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 +
73 73  1. Allez dans la section **Authentication**.
74 74  1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
75 75  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.
... ... @@ -92,7 +92,7 @@
92 92  [[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
93 93  1. Copiez le jeton JWT.
94 94  
95 -=== Signature du jeton de sécurité ===
103 +==== Signature du jeton de sécurité ====
96 96  
97 97  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.
98 98  
... ... @@ -115,14 +115,41 @@
115 115  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
116 116  {{/code}}
117 117  
118 -== S'authentifier via BearerAuth ==
126 +== S'authentifier via ApiKeyAuth ==
119 119  
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 :
128 +=== Créer une clé API ===
122 122  
130 +Nous allons créer ici une clé API :
131 +
132 +1. Allez dans la section **Authentication**.
133 +1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/apikeys**
134 +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.
135 +1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
136 +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é**.
137 +S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
138 +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]].
139 +1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
140 +Par exemple :
141 +[[image:1745928168043-553.png]]
142 +
143 +(% class="box warningmessage" %)
144 +(((
145 +❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
146 +)))
147 +
148 +(% start="5" %)
149 +1. Cliquez sur le bouton **Execute **pour générer la clé API.
150 +➡ La réponse s'affiche dans la section **Server response** en-dessous.
151 +[[image:1745928288556-250.png||alt="Réponse serveur"]]
152 +1. Copiez la clé API.
153 +
154 +=== S'authentifier ===
155 +
156 +Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
157 +
123 123  1. Cliquez sur le bouton **Authorize**.
124 124  1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
125 -1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
160 +1. Dans la section **ApiKeyAuth**, collez la clé API dans le champ Value.
126 126  1. Cliquez sur **Authorize**.
127 127  
128 128  = Ressources API disponibles{{id name="ressources"/}} =
1745928288556-250.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +43.6 KB
Content