Consommer des données par API

En résumé

  • Les APIs sont des jeux de données conçus et partagés depuis la plateforme DataChain

  • Elles contiennent un ensemble d’informations (métadonnées) en plus du jeu de données

  • Toutes les APIs publiées issues de DataChain auxquelles un utilisateur à accès sont visibles dans la Marketplace

  • Il est possible de construire des requêtes et tester les APIs depuis la Marketplace

  • Un jeton d’authentification est nécessaire pour consommer les APIs en dehors de la Marketplace

Introduction

Toutes les APIs disponibles dans la Marketplace DataChain sont directement issues de jeux de données créés, gérés et partagés via la plateforme DataChain.
Ce mécanisme garantit non seulement une traçabilité complète, mais également un accès sécurisé et contrôlé aux données à chaque étape de leur cycle de vie, depuis leur création jusqu’à leur consommation finale au sein des applications.
DataChain agit ainsi comme un écosystème centralisé et fiable, assurant l’intégrité et la conformité des informations mises à disposition, tout en facilitant la découverte et l’intégration de ces API par les consommateurs en dehors de DataChain.

Construire des requêtes et tester les APIs

La Marketplace offre la possibilité de construire des requêtes et de tester des API simplement et rapidement, puis de les utiliser en dehors de l’écosystème DataChain.

Au sein de DataChain

Vous pouvez consulter les métadonnées et l’ensemble des informations relatives à l’API depuis sa page de détail.
Il est possible de construire des requêtes à l’aide du formulaire afin de générer l’URL puis de prévisualiser les résultats aux formats REST ou OData.

Depuis une application externe

Les APIs peuvent être consommées en dehors de DataChain. Quel que soit le type d’api utilisé, la requête API doit être authentifiée. Le système d’authentification est décrit dans la suite de cette page.

Deux formats d’API sont mis à dispositions, dont le fonctionnement est décrit dans les pages dédiées :

Authentification

Afin d’accéder aux apis, vous devez être authentifié auprès du serveur. Deux méthodes d’authentifications peuvent-être utilisées :

  • via Jeton Oauth,

  • via token Datachain,

  • via Kerberos (dans ce cas, il faut obtenir un jeton kerberos, non documenté ici)

Utilisation d’un Jeton Oauth

Ce jeton est à obtenir auprès de votre système d’authentification. La méthode d’obtention de votre token est à obtenir auprès de votre administrateur SSO.
Dans le cas de keycloak, il est possible d’obtenir le token via une requête de ce type.

curl --location --request POST 'https://'VOTRE_URL_KEYCLOAK'/auth/realms/dc-realm/protocol/openid-connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=password' \
--data-urlencode 'username=VOTRE_LOGIN' \
--data-urlencode 'password=VOTRE_MOT_DE_PASSE' \
--data-urlencode 'client_id=dc_marketplace' \
--data-urlencode 'client_secret=KEYCLOAK_CLIENT_SECRET' \
--data-urlencode 'scope=openid profile email'

Pour obtenir

{
    "access_token": "eyJhbGciOiJS...",
    "expires_in": 50400,
    "refresh_expires_in": 86400,
    "refresh_token": "eyJhbGciO...",
    "token_type": "Bearer",
    "id_token": "eyJhbGciOiJS...",
    "not-before-policy": 0,
    "session_state": "e3854203-62ac-45c6-9abc-7bf015401e1d",
    "scope": "openid email profile"
}

Le contenu de la valeur du champ "access_token" est à reporter dans l’entête "Authorization: Bearer " comme suit.

curl "https://VOTRE_URL_MARKETPLACE/dmp-api/data/..." -H 'Accept:application/json, text/plain' -H 'Authorization: Bearer eyJhbGciOiJS...'

Utilisation d’un Token Datachain

Selon vos droits dans la console de gestion Datachain, vous pouvez générer un token dans la page "mon compte" de la console ou demander ce token à un administrateur de la console Datachain. Consultez la page de gestion de compte utilisateur pour en savoir plus.

La valeur du token est à reporter dans la requête, dans un entête "DC-X-API-TOKEN".

curl "https://VOTRE_URL_MARKETPLACE/dmp-api/data/..." -H 'Accept:application/json, text/plain' -H 'DC-X-API-TOKEN: <VOTRE TOKEN>'

Dernière mise à jour le 28 avril 2026 à 11:53