Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 1.1
edited by Aurelie Bertrand
on 2024/08/28 14:19
Change comment: There is no comment for this version
To version 1.2
edited by Aurelie Bertrand
on 2024/08/28 16:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,0 +1,38 @@
1 += Ouvrir Swagger UI =
2 +
3 +Swagger UI permet de visualiser et d'interagir avec les ressources des API.
4 +Cette interface fournit également une documentation visuelle facilitant leur utilisation.
5 +
6 +Pour ouvrir Swagger UI, utilisez le lien suivant :
7 + [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
8 +dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
9 +
10 +Par exemple:
11 +[[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
12 +
13 +Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
14 +
15 += S'authentifier =
16 +
17 +Afin de pouvoir interagir avec les API, vous devez vous authentifier.
18 +
19 +* (% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)Cliquez sur le bouton (%%)**Authorize**(% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %) en haut à droite de la page Digdash API. (Le cadenas ouvert signifie que vous n’êtes pas autorisé.)(%%)
20 +➡ (% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)La fenêtre (%%)**Available authorizations** ((% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)Autorisations disponibles) s'affiche.
21 +
22 +Deux méthodes d'autorisation sont actuellement disponibles :
23 +
24 +* (((
25 +**BasicAuth **: La méthode Basic Authentification permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
26 +)))
27 +* (((
28 +**bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
29 +)))
30 +
31 +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.
32 +
33 +(% class="box warningmessage" %)
34 +(((
35 +❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
36 +)))
37 +
38 +