Aperçu
Service permettant de manière sécurisée de stocker et d'archiver des documents accompagnés de leurs métadonnées.
Services IT génériques
Sous-domaineAs a Service
TypologieService & API
Service ownerONSS
2018
Réutilisation12
Effort d'intégrationQuelle en est l'utilité ?
En tant qu’institution de la sécurité sociale, vous devez partager des fichiers avec des partenaires. Grâce au service « documentRepository », vos fichiers et leurs métadonnées sont stockés de façon centralisée avec la possibilité de les gérer, tout en limitant l’accès à ce qui est essentiel. De plus, il existe une solution d'archivage en partenariat avec Archiving-As-A-Service.
Description fonctionnelle
L'API REST/documentRepository gère les métadonnées liées à des documents ainsi que leur stockage et, si nécessaire, leur archivage. Il gère également l'accès à ces documents. Il offre les fonctionnalités suivantes :
- Télécharger un nouveau document. Le contenu et les métadonnées du document sont stockés dans Document Repository et, s'il est prêt à être archivé, une demande d'archivage est faite auprès du service Archiving-as-a-Service (AAAS), le service d'archivage électronique à valeur probante disponible en tant que service sur le G-Cloud
- Demander l'archivage d'un document qui a préalablement été téléchargé dans Document Repository et dont le besoin d'archivage n'était pas nécessaire à ce moment
- Télécharger une location externe. Ceci permet à l'application cliente d'ajouter la localisation d'un document qui se trouve dans un répertoire ou un espace de stockage externe à Document Repository et d'y enregistrer ses métadonnées (afin d'utiliser Document Repository comme moteur centralisé d'indexation et de recherche)
- Consulter le contenu d'un document préalablement téléchargé dans Document Repository ou situé dans un répertoire externe
- Consulter le contenu et les métadonnées associées à un document préalablement téléchargé dans Document Repository ou situé dans un répertoire externe
- Consulter les métadonnées associées à un document préalablement téléchargé dans Document Repository
- Mettre à jour les métadonnées d'un document. Ceci permet le remplacement intégral des métadonnées qui accompagnent le document
- Obtenir une liste de documents et leurs métadonnées sur base de critères de recherche
- Supprimer le contenu d'un document et l'ensemble des informations associés à celui-ci
- Une demande de stockage ou d'archivage se fait pour un seul document à la fois
- Le processus d'archivage est asynchrone ; les documents ne sont pas archivés de manière instantanée
- Les documents et leurs métadonnées sont consultables immédiatement après leur chargement dans Document Repository
Description technique
Service REST sécurisé nécessitant une authentification OAuth, déployé sur l’API Gateway SocSec de la sécurité sociale.
Service REST sécurisé nécessitant une authentification DIAM, déployé sur le tenant DEFENSE.
Service REST sécurisé nécessitant une authentification VAS IAM, déployé sur la plateforme VAS.
Public cible
Toute application qui a un besoin de stocker, d'archiver un document et ses métadonnées.
Conditions d'intégration
Pour intégrer l'API REST/documentRepository, il faut :
- Avoir réalisé les démarches administratives à savoir l'intégration au service d’identification et d’authentification de la sécurité sociale
- Pour l'archivage de documents dans AAAS, avoir réalisé les conditions d'intégration nécessaires (voir les conditions du service AAAS)
Documentation
Autres composants intéressants
Contact
Contact : ReuseOperational@smals.be