Introduction aux Web Services de Damaris RM

Les Web Services sont considérés des API (Application Programming Interface) qui vous permet d’utiliser les fonctions de Damaris RM depuis vos propres outils.

 

Les différences avec les URL dynamiques

Les Web Services utilisent un protocole standard d’échanges d’informations entre les outils informatiques en ligne.

Damaris RM utilise le protocole RESTFul.

Votre progiciel va se connecter au serveur Damaris RM et va lui soumettre les requêtes.

Au retour Damaris RM renvoie les données selon les opérations effectuées.

Le format des échanges est JSON (JavaScript Object Notation).

 

Du coup, vous gardez totalement la main sur la composition de votre interface homme machine et composez vos pages selon vos besoins.

 

Les utilisations des Web Service Damaris RM

Les modules Damaris Mobile, Damaris Printer et Damaris Scan Manager utilisent uniquement les Web Service pour interagir avec Damaris RM.

Comme ces modules sont exploités quotidiennement la fiabilité de la solution est vérifiée régulièrement.

 

Les séquences types d’exécutions

Avant toute action, vous devez ouvrir une session.

Pour cela, utilisez le service auth/login.

Cette opération retourne un “uniqueKey” qui est un identifiant de la session ouverte.

Vous devrez utiliser cette “uniqueKey” dans les actions suivantes.

 

A la fin d’une opération, n’oubliez pas de vous déconnecter.

La déconnexion peut s’effectuer après avoir utilisé plusieurs fonctions.

 

Pour vous déconnecter, utilisez le service “auth/logout”.

 

Les fonctions les plus importantes

 

La recherche de documents

Cette fonction vous permet d’effectuer une recherche dans la base Damaris RM et de remonter les informations des résultats obtenus.

Les résultats vous sont retournés au format JSON. A vous de les exploiter pour les rendre intelligibles aux utilisateurs.

Voici la liste des services concernant les recherches :

• search/searchArchives
• search/searchArchivesCount
• search/searchArchivesAdvancedCountGPS
• search/searchArchivesAdvanced
• search/getExtendedNotices

 

L’obtention d’un document numérique

Une fois une recherche effectuée, récupérez les identifiants d’un document en particulier.

Ensuite, vous pouvez utiliser le service archiving/getElectronicDocument pour obtenir au retour le binaire du fichier PDF.

 

La liste des Web Service Damaris RM

Vous trouverez la liste des Web Service Damaris RM dans la Base de connaissances, ici.

 

Les futures évolutions

Selon les demandes des clients et la feuille de route Damaris RM, nous ajoutons très régulièrement de nouvelles fonctions.