Digdash API

Version 1.2 par Aurelie Bertrand le 2024/08/28 16:54

Ouvrir Swagger UI

Swagger UI permet de visualiser et d'interagir avec les ressources des API.
Cette interface fournit également une documentation visuelle facilitant leur utilisation.

Pour ouvrir Swagger UI, utilisez le lien suivant :
http://[serveur]:[port]/[domaine]/staticwebcontent/swagger/
dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.

Par exemple:
http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/

Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.

S'authentifier

Afin de pouvoir interagir avec les API, vous devez vous authentifier.

  • Cliquez sur le bouton Authorize en haut à droite de la page Digdash API. (Le cadenas ouvert signifie que vous n’êtes pas autorisé.)
    ➡ La fenêtre Available authorizations (Autorisations disponibles) s'affiche.

Deux méthodes d'autorisation sont actuellement disponibles :

  • BasicAuth : La méthode Basic Authentification permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.

  • bearerAuth : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur. 

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.

❗Il n'est pas recommandé d'utiliser la méthode BasicAuth de manière systématique pour des raisons de sécurité.