La documentation
Introduction
Bienvenue sur Projet Mémorial, l’API des soldats français morts en OPEX depuis 1963.
Cette documentation devrait vous aider à vous familiariser avec les ressources disponibles et comment les utiliser avec les requêtes HTTP. Lisez la section de démarrage avant de vous lancer. La plupart de vos problèmes devraient être résolus simplement en la lisant.
Commencer
Faisons notre première requête API au Projet Mémorial !
Ouvrez un terminal et utilisez curl ou httpie pour effectuer une requête API pour une ressource. Vous pouvez également faire défiler les définitions ci-dessous et envoyer des demandes directement à partir de la documentation des points de terminaison !
Par exemple, si vous collez et exécutez cette commande curl :
curl -X GET "curl -X GET "https://api.projet-memorial.fr/soldats/readOfDay"
Vous devriez avoir comme résultat la liste des soldats morts à la date d’aujourd’hui. Par exemple un 27 juin :
Vous pouvez utiliser un outil comme POSTMAN pour tester les requêtes de l’API.
Requêtes disponibles
Soldats
Méthode GET
– Afficher tous les soldats de la base de données:
https://api.projet-memorial.fr/soldats/readAll
– Afficher tous les soldats morts à la date de la demande:
https://api.projet-memorial.fr/soldats/readOnDate
Méthode POST
– Afficher le soldat avec l’identifiant passé :
https://api.projet-memorial.fr/soldats/read
Body :
{
« id »: « 1 »
}
– Afficher les soldats morts à la date donnée:
https://api.projet-memorial.fr/soldats/readOfDay
Body :
{
« userDate »: « 2022-01-22 »
}
– Rechercher les soldats avec ce nom ou prénom.
https://api.projet-memorial.fr/soldats/search
Body :
{
« userSearch »: « martin »
}
Armées
Méthode GET
– Afficher toutes les armées de la base de données:
https://api.projet-memorial.fr/armees/readAll
– Afficher l’armée avec l’identifiant passé :
https://api.projet-memorial.fr/armees/read
Body :
{
« id »: « 1 »
}
Unités
Méthode GET
– Afficher toutes les unités de la base de données:
https://api.projet-memorial.fr/unites/readAll
– Afficher l’unité avec l’identifiant passé :
https://api.projet-memorial.fr/unites/read
Body :
{
« id »: « 1 »
}
Conflits
Méthode GET
– Afficher toutes les conflits de la base de données:
https://api.projet-memorial.fr/conflits/readAll
– Afficher le conflit avec l’identifiant passé :
https://api.projet-memorial.fr/conflits/read
Body :
{
« id »: « 1 »
}
Authentification
Projet Mémorial est une API complètement ouverte. Aucune authentification n’est requise pour interroger et obtenir des données. Cela signifie également que nous avons limité ce que vous pouvez faire pour obtenir simplement les données. Si vous trouvez une erreur dans les données, n’hésitez pas à nous envoyer un message ICI.
FAQ
L’API est-elle gratuite ?
Oui, le projet est collaboratif et open source.
Une donnée est fausse ou le contenu est manquant.
Contactez-nous via le formulaire, nous contrôlerons les données et les modifierons dans les meilleurs délais !
Puis-je modifier les données moi même?
Non, seul les administrateurs peuvent modifier les données. Les administrateurs se réservent le droit de filtrer les données pour preserver leurs fiabilité et le respect de la mémoire des soldats.
Puis-je utiliser les données dans un projet à but lucratif ?
Oui, conformément au site de prélèvement d’origines des données ( https://www.memoiredeshommes.sga.defense.gouv.fr/fr/arkotheque/navigation_facette/index.php?f=opendata).
A quoi peuvent servir les données?
Projet Mémorial est la source des données utilisées par l’application mobile : Mémoire De Nos Frères.
Vous pouvez utiliser les données pour un projet étudiant par exemple.
Je n’arrive pas à faire mes requêtes ou l’application semble bugger.
Contactez-nous ICI.
Je veux vous soutenir.
Vous pouvez nous témoigner votre soutien en participant au frais d’hébergement des sites et données.
Faites un don ICI.
Note
Il s’agit d’une API évolutive et avoir de nouvelles idées est toujours le bienvenu !
Aidez-nous !
Vous voulez participer au projet ? Mettre à jour les données, ajouter des biographies ou des photos, chaqu’un peut participer !
Projet Mémorial est une application ouverte ! Pas besoin d’être développeur pour apporter sa pierre à l’édifice.
Le développement et l’hébergement des données ont aussi un coût vous pouvez également nous financer !
Envoyez-nous l’équivalent d’un café croissant et vous financez l’hebergement des données et du site pour 1 mois !