Présentation fonctionnelle / Portail de données (Front Office)

Accès par API

L’ensemble des fonctionnalités de la plateforme est disponible au travers d’API Rest documentées. Ces API peuvent être appelées en dehors du portail, mais pour les accès restreints, il faut passer par l'utilisation d'une clé d'API. Lors de l’ajout d’une clé d’API, il est possible de restreindre l’accès à une seule fonction. On peut ensuite limiter l’accès à une IP ou à un nom de domaine précis.

La documentation des API est réalisée en suivant la spécification OpenAPI 3.0. Cela permet une description claire et compréhensible au travers d’une interface interactive. La prise en main des APIs par les développeurs est ainsi plus rapide.

Un autre avantage d’utiliser cette spécification est l’interopérabilité accrue, certains systèmes informatiques (par exemple, les gateway API) étant capables de comprendre cette spécification. Les API réalisées avec Data Fair peuvent, par exemple, être directement intégrées par des sites comme https://api.gouv.fr.

screenshot of the API documentation

Il est possible d'utiliser l'API pour moissonner les données d'un portail. Par exemple, le site https://opendatarchives.fr/ moissonne régulièrement les données du portail https://data.ademe.fr/ propulsé par Data Fair.