Aller au contenu principal

Prérequis

Avant de commencer, assurez-vous d’être connecté à la plateforme.

  • Accédez au menu API dans la barre de navigation latérale.

Gestion d’API

La section Gestion d’API est organisée en deux onglets distincts :

  • Génération de token : création, suivi et suppression des clés d’accès.
  • Documentation : description des endpoints mis à disposition par Ferronext pour importer, exporter ou consulter des données.
Vue générale de la page Gestion d'API avec les deux onglets (Tokens et Documentation)

Onglet : Génération de token

Cette partie permet de créer et d’administrer vos tokens d’authentification.
Pour des raisons de sécurité, un token n’est visible qu’une seule fois au moment de sa création. Une fois généré, il ne sera plus affiché : seul l’historique reste consultable.

Le tableau récapitulatif des tokens contient :

  • Nom du token
  • Audience (import, export, aperçu, etc.)
  • Usage actuel (nombre d’appels effectués)
  • Limite d’utilisation (100 appels maximum)
  • Dates : création, dernière utilisation, expiration
  • Source associée

Chaque token peut être supprimé à tout moment.
En bas du tableau, vous retrouvez les contrôles habituels (pagination, total, lignes par page).

Bonnes pratiques
  • Utilisez un nom explicite pour chaque token afin d’en faciliter la gestion.
  • Supprimez les tokens inutilisés pour renforcer la sécurité.
  • Générez un token distinct par usage (import/export/aperçu) plutôt qu’un unique token global.
  • Conservez votre token en lieu sûr après sa création, car il ne sera plus réaffiché.

Onglet : Documentation API

Cet onglet rassemble toutes les informations nécessaires pour consommer l’API Ferronext :

  • Les endpoints disponibles (GET, POST, etc.).
  • Les paramètres d’entrée attendus.
  • Les formats de réponses.
  • Des exemples d’appels API.

Par ailleurs, vous pourrez trouver dans l'onglet REST API la liste des endpoints disponibles pour importer, exporter et consulter des données. Cette page est destiné au développeur.

Cela vous permet d’intégrer vos flux de données directement avec la plateforme Ferronext.