Wiki source code of Digdash API
Version 5.1 by Aurelie Bertrand on 2024/08/29 10:07
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
1.2 | 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 : | ||
| |
4.1 | 7 | [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]] |
| |
1.2 | 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 | |||
| |
4.1 | 19 | * (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Cliquez sur le bouton (%%)**Authorize**(% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %) en haut à droite de la page Digdash API. (Le cadenas ouvert signifie que vous n’êtes pas autorisé.)(%%) |
| 20 | ➡ (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)La fenêtre (%%)**Available authorizations** ((% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Autorisations disponibles) s'affiche. | ||
| |
1.2 | 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 | |||
| |
2.2 | 38 | == Authentification via BasicAuth == |
| |
1.3 | 39 | |
| |
1.4 | 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é. | ||
| |
1.3 | 43 | |
| |
1.4 | 44 | == Création du jeton de sécurité == |
| |
1.3 | 45 | |
| |
1.4 | 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. | ||
| |
3.1 | 51 | 1. ((( |
| 52 | Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :* **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer le JWT dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**. | ||
| 53 | S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas. | ||
| 54 | |||
| 55 | * **expires** : (Optionnel mais recommandé) Indiquez la période de validité du JWT 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]]. | ||
| 56 | * ((( | ||
| 57 | **permissions **: Définissez les autorisations à donner à ce jeton : "-" pour aucune autorisation, "r" pour lecture seule, "rw" pour lecture-écriture. | ||
| |
2.2 | 58 | ))) |
| |
3.1 | 59 | ))) |
| |
1.4 | 60 | |
| |
1.2 | 61 |