Documentation de l’API

L’onglet Documentation présente l’ensemble des endpoints disponibles pour accéder à la plateforme Ferronext via l’API REST.

Cette documentation est générée à partir d’un fichier OpenAPI (Swagger), ce qui permet de :

• Visualiser tous les endpoints disponibles (GET, POST, etc.).
• Consulter la description de chaque endpoint.
• Voir les paramètres attendus, les types de réponse et les éventuelles erreurs.
• Tester directement certaines requêtes depuis l’interface

Fonctionnalités principales

1. Navigation par catégorie
   Les endpoints sont regroupés par type (Public, Sources, Upload, etc.) pour faciliter la recherche.

2. Consultation des détails
   Pour chaque endpoint, vous pouvez voir :

   • Résumé et description complète.
   • Paramètres requis et optionnels, avec leur type et format.
   • Exemples de réponse (JSON) et codes HTTP associés.
   • Sécurité : certains endpoints nécessitent un token.

3. Test en direct + Vous pouvez exécuter des appels API directement depuis la documentation pour vérifier les résultats.

Accéder à la documentation

La documentation Swagger est disponible à l'adresse :

Documentation de l'API

Elle permet de consulter les endpoints disponibles et de tester les requêtes directement depuis l'interface.

Bonnes pratiques pour utiliser l’API Ferronext

• Générer un token valide via l’onglet Génération de token avant d’effectuer des appels protégés.
• Ne jamais partager votre token publiquement : il donne accès à vos données.