Comment puis-je vous aider ?
Introduction
Damaris RM web service est un ensemble d’API qui vous permettent d’exploiter des fonctions à partir de vos autres outils informatiques.
Cette documentation concerne Damaris RM v9.
Le principe des méthodes Damaris RM
Pour pouvoir utiliser les Web Services, il convient de suivre les séquences des appels qui vous permettent d’obtenir les informations nécessaires pour l’appel suivant.
Voici un exemple de séquence d’appels :
- /rest/services/auth/login : Authentifie l’utilisateur
- Génère une clé unique : uniqueKey
- … Lancement des autres méthodes en utilisant la valeur uniqueKey
- /rest/services/auth/logout : Fin de session
L’accès à la liste des méthodes
Pour accéder à la liste des méthodes, et même pour pouvoir les tester, la solution Damaris RM intègre une page swagger.
Cette interface liste les différents contrôleurs et méthodes.
Vous pouvez ensuite tester directement chaque appel API à partir de la page web.
De plus, vous trouverez des exemples de codes JSON et curl pour vous guider dans le codage des appels.
Pour accéder à la page swagger, lancez l’URL de votre serveur Damaris RM, suivi de /swagger-ui/
Voici un exemple de lien URL : https://prod27.damaris.pro/DamarisRM4/swagger-ui/
La recherche de documents électroniques
Voici la séquence d’appels pour déclencher une recherche de documents dans Damaris RM :
- /rest/services/auth/login
- Soumettre le login et le mot de passe crypté
- Récupérer uniqueKey
- /rest/services/search/searchArchivesAdvanced
- Soumettre uniqueKey, l’ID typologie document et les critères de recherches
- Récupérer les résultats dont ArchivedID
- /rest/services/archiving/getElectronicDocument
- Soumettre uniqueKet et l’ID du document
- Récupérer le fichier numérique
- /rest/services/auth/logout
- Soumettre uniqueKey
L’archivage de documents électroniques
Voici la séquence d’appels pour déclencher l’archivage d’un document dans Damaris RM :
- /rest/services/auth/login
- Soumettre le login et le mot de passe crypté
- Récupérer uniqueKey
- /rest/services/archiving/getDocumentTypes
- Soumettre uniqueKey
- Récupérer les docTypeID
- /rest/services/archiving/getDocumentTypeIndexes
- Soumettre uniqueKey, docTypeID
- Récupérer les résultats dont indexID
- /rest/services/archiving/archiveElectronicDocument
- Soumettre uniqueKey docTypeID et les indexID
- Soumettre également le PDF à archiver
- Récupérer le statut et le numéro unique de dépôt archiveID
- /rest/services/auth/logout
- Soumettre uniqueKey
La modification des index
- /rest/services/auth/login
- Soumettre le login et le mot de passe crypté
- Récupérer uniqueKey
- /rest/services/archiving/getDocumentTypes
- Soumettre uniqueKey
- Récupérer les docTypeID
- /rest/services/search/updateArchiveIndex
- Soumettre uniqueKey, archiveID, indexID et la nouvelle valeur d’index
- /rest/services/auth/logout
- Soumettre uniqueKey
Les Contrôleurs disponibles
Ici, il convient de citer les différents “Contrôleurs” qui sont un regroupement de méthodes par grande fonction de Damaris RM.
Voici la liste des contrôleurs et des méthodes pour chaque.
NB : Vous trouverez tous ces éléments depuis votre interface Swagger de Damaris RM.
| Contrôleur | Courte description |
| archiving-controller | Regroupe toutes les fonctions nécessaires pour archiver de nouveaux documents. Vous y trouverez les méthodes vous permettant d’obtenir les différentes informations pour composer vos flux JSON à soumettre à Damaris RM. |
| authentication-controller | Concerne essentiellement les méthodes pour connecter un utilisateur ou pour gérer les jetons de connexion. |
| declaration-controller | Sert pour la gestion des archives physiques et particulièrement, la gestion des lots de versements. |
| messages-controller | Regroupe les méthodes de la messagerie interne à Damaris RM, l’envoi des notifications vers Damaris Mobile ou la possibilité de créer un nouveau ticket Hotline dans Damaris Extranet. |
| prediction-controller | Utilisez la fonction de prédiction pour obtenir des informations pertinentes concernant les archives physiques. Cette fonction aide les archivistes à mieux gérer leurs fonds. |
| projects-controller | Transmet des données statistiques et quantitatives vers Damaris Extranet pour alimenter la gestion centralisée des projets. |
| requests-controller | Regroupe les méthodes pour la gestion des demandes de sorties et la gestion des sorties et des retours des boites d’archives physiques. |
| scanning-controller | Retrouvez ici toutes les méthodes vous permettant de gérer les projets de numérisation massive de documents. Cela correspond aux fonctions de Scanning Centers multi-scanners et multi-sites. |
| search-controller | Regroupe toutes les fonctions de recherches de documents et l’obtention des résultats de recherches. |
| stamps-controller | Ajoutez et vérifiez la présence des Tampons électroniques sur les documents. Faites évoluer l’état d’avancement de vos documents dans vos Workflows. |
| supplier-portal-controller | Ce sont les API de dépôt et de suivi des factures fournisseurs. Vos fournisseurs peuvent exploiter ces API REST pour déposer leurs factures à votre destination. |
| tasks-controller | Gérez vos tâches automatisées ou manuelles. Vous pouvez les déclencher à distance depuis vos autres processus. |