Logo Vitam

Consultation API VITAM

Découvrir les API de versement, de recherche et d'accès aux contenus et aux journaux dans un back-office VITAM


La solution logicielle développée dans le cadre du programme Vitam est une brique de back-office permettant la prise en charge, la conservation, la pérennisation et la consultation sécurisée de très gros volumes d’archives numériques. Elle assure la gestion complète du cycle de vie des archives et donc la garantie de leur valeur probante.

Développée sous licence libre, elle a vocation à être intégrée dans des environnements SI très divers. Les API seront utilisées dans des applications utilisant la solution logicielle Vitam pour verser leurs archives et/ou pour les retrouver et les consulter

Ces API (REST/JSON) sont soumises à consultation des acteurs SI potentiellement intéressés par Vitam, pour s'assurer qu'elles sont :
  • compréhensibles par les développeurs et architectes devant les mettre en oeuvre
  • utilisables dans les contextes applicatifs visés et notamment dans différents langages
  • suffisamment riches pour les tâches visées
Vos commentaires sur les API et les idées d'enrichissements potentiels proposées sont attendus, d'ici le 20 septembre 2016, à l'adresse:
consultation.api@programmevitam.fr

Les ressources suivantes sont mises à votre disposition:
  • Aperçu du projet solution logicielle Vitam (pdf)
  • Ce document donne une vision d'ensemble sur le projet solution logicielle Vitam, sa démarche, son fonctionnel et son architecture.
  • Introduction aux API Vitam (pdf)
  • Ce document présente les concepts mis en oeuvre dans les interfaces, un premier niveau des API et ouvre sur des idées d'enrichissement soumises à commentaires.
  • Documentation des API
    Documentation générée avec RAML.
    • API de versement (Ingest)
    • API de recherche et accès aux archives (Access)
    • API de recherche et accès aux journaux (LogBook)
  • Ressources techniques (zip) comprenant
    • un fichier README.txt (version HTML),
    • le fichier de licence Vitam (LICENCE.txt),
    • un ensemble exécutable avec une JVM 8 (autour d'un serveur jetty) qui expose :
      • la documentation html des API Vitam (pages statiques reprises ci-dessus)
      • l'outil RAML Console permettant de manière dynamique de visualiser la documentation RAML et de faire des tests (https://github.com/mulesoft/api-console)
      • les Javadoc de quelques modules Vitam (query-builder|ingest.client|access.client|logbook.client)
      • les points d'entrée REST des API externes de Access (units et objects), de Logbook (operation et lifecycle) et d'Ingest en mode "bouchonné" c'est à dire que les réponses renvoyées par le serveur sont correctes vis à vis de la documentation de l'API mais il s'agit de "fausses" données puisqu'il n'y a pas d'implémentation du back-office Vitam derrière.
    • des exemples de code Java pour l'utilisation des clients Access, Logbook et Ingest
    • des exemples de requêtes CURL vers les APIs Access et Logbook

Juillet 2016