API
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.
En dehors de DataChain
Les APIs peuvent être consommées en dehors de DataChain.
Pour cela vous devez entrer un jeton d’authentification valide dans un header de type Authorization: Bearer TOKEN.
Consultez la page de gestion de compte utilisateur pour en savoir plus.
Syntaxes et opérateurs de requêtes
Vous devez respecter la syntaxe DataChain pour construire des requêtes et interroger les API.
https://monModule/dmarketplace-datachain-api/version/data/exposition?select=id,nom&filter=nom=beginsWith=A
| Syntaxe | Description | Obligatoire ? |
|---|---|---|
URL d’accès de base |
|
|
exposition? |
Nom du point d’accès attribué lors du paramétrage de l’API au niveau du DataBlock |
|
select= |
Sélectionne les colonnes à renvoyer dans la réponse. |
|
filter= |
Filtres en fonction des paramètres de filtres définis |
|
page= |
Indique la page retournée. Par défaut, il s’agit de la page 1 |
|
hitsPerPage= |
Indique le nombre de lignes par page |
|
useCache= |
Indique si le cache (persistance) est utilisé ou non |
|
sort= |
Tri en fonction des paramètres définis |
|
ctx: |
Indique le contexte de l’instance utilisée |
|
& |
Caractère à ajouter entre chaque filtre |
