Modifications pour le document DigDash API REST
Modifié par Aurelie Bertrand le 2025/03/25 16:13
Depuis la version 1.4
modifié par Aurelie Bertrand
sur 2024/08/28 17:12
sur 2024/08/28 17:12
Commentaire de modification :
Il n'y a aucun commentaire pour cette version
À la version 1.1
modifié par Aurelie Bertrand
sur 2024/08/28 14:19
sur 2024/08/28 14:19
Commentaire de modification :
Il n'y a aucun commentaire pour cette version
Résumé
-
Propriétés de la Page (1 modifications, 0 ajouts, 0 suppressions)
Détails
- Propriétés de la Page
-
- Contenu
-
... ... @@ -1,53 +1,0 @@ 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 -== Authentification via BasicAuth == 39 - 40 -1. Entrez votre nom d'utilisateur et mot de passe Digdash. 41 -1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**. 42 -➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé. 43 - 44 -== Création du jeton de sécurité == 45 - 46 -Nous allons créer ici le jeton de sécurité Json Web Token (JWT) : 47 - 48 -1. Allez dans la section **Authentication**. 49 -1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.** 50 -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. 51 -1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci 52 - 53 -