Guide de migration des Expositions API
HandleData
Ce guide détaille la procédure de migration qui permet de créer des Expositions API dans la nouvelle version HandleData à partir des paramètres des Expositions API liées aux DataBlock.
- Pour réaliser la migration des APIs, vous devez posséder les droits suivants
-
-
Permissions globales (portées par l’utilisateur ou le groupe présent dans le Projet)
-
"Exposition API" : pour voir et modifier des Expositions API HandleData
-
"Exposition API - Création" : pour créer et migrer de nouvelles Expositions
-
-
Droit sur la source des données (DataBlock)
-
Modification
-
-
À partir de la version 8.6 de DataChain Core, les Expositions API liées aux DataBlocks disponibles dans GenericsData peuvent être migrées dans la nouvelle version liée à la gestion des éléments partagés depuis HandleData.
La migration ne supprime pas les APIs sources : elles restent donc publiées si elles l’étaient et devront être supprimées manuellement par la suite.
Détail de la migration
Les APIs migrées sont iso-fonctionnelles avec la première version.
Nous vous recommandons néanmoins de vérifier les accès pour affiner les accès aux colonnes si vous utilisiez les restrictions au niveau de la gestion des droits sur colonnes depuis les DataBlocks.
La migration des APIs nécessite quelques adaptations, notamment sur les utilisateurs consommateurs des APIs.
Les utilisateurs et les groupes présents dans les filtres des Expositions sources, ainsi que tous les membres du Projet sont considérés comme des potentiels consommateurs : ils doivent être associés à des utilisateurs ou des groupes qui possèdent un accès actif au module de partage (future Market Place) dans l’étape de mapping de la migration.
Les Expositions déjà migrées ne peuvent plus être migrées (sauf si l’Exposition migrée est supprimée).
Métadonnées de l’Exposition (privées)
Les métadonnées dites privées sont les métadonnées de l’Exposition : elles ne sont visibles que par les membres des Projets DataChain, jamais par les consommateurs.
L’exposition API est désormais un élément à part entière des Projets DataChain : les droits sur élément s’appliquent de la même manière que sur les autres éléments DataChain (lecture, modification, )
| Element | V1 Exposition DataBlock | V2 Partages : Exposition API |
|---|---|---|
Libellé Exposition API |
Non existant |
Exposition API - [Label du Datablock] |
Description Exposition API |
Non existant |
Aucune |
Tags |
Non existant |
Aucune |
Statut de la Publication API
Les APIs migrées ne sont pas automatiquement publiées, leur statut de publication est "Non publiée" : elles doivent être publiées manuellement après la migration.
Paramètres de Publication API
Les paramètres de Publication permettent de créer la configuration de l’API au moment de sa publication.
Une fois que l’API est publiée, vous pouvez modifier ces paramètres pour mettre ensuite à jour la configuration.
Les paramètres de l’Exposition V1 qui sont copiés comme Paramètres de Publication dans la V2 sont ceux de la version publiée de l’API.
Si l’API n’est pas publiée, ce sont les paramètres "brouillon" qui sont copiés.
Les métadonnées dites publiques sont les métadonnées de la Publication API, elles sont visibles par les membres des Projets mais aussi par les consommateurs.
| Element | V1 Exposition DataBlock | V2 Partages : Exposition API |
|---|---|---|
Point d’accès |
access_point |
access_point (copié à l’identique) |
Titre |
Non existant |
Exposition API - [Label du DataBlock] |
Détail |
Description V1 visible par les consommateurs (ou aucun) |
Description V1 visible par les consommateurs (ou aucun) |
Mots clés |
Non existant |
Aucun |
Paramètres généraux des colonnes
Les paramètres généraux permettent de définir les colonnes disponibles pour être exposées dans les accès à l’API.
Une colonne active dans les paramètres généraux peut être inactive dans un accès pour bloquer l’accès aux données de cette colonne à certains utilisateurs.
| Element | V1 Exposition DataBlock | V2 Partages : Exposition API |
|---|---|---|
Alias |
AliasColonne |
AliasColonne |
Description |
Description colonne (ou aucune) |
Description colonne (ou aucune) |
id |
|
|
Filtrable |
- |
|
I.C. |
|
|
Hachable |
Non existant |
Inactif |
Masqué |
|
|
Accès à l’API
Les accès sont la version évoluée des filtres présents sur les Expositions V1.
Ils permettent de définir différents droits d’accès sur les données (colonnes et ligne) pour une même API.
Il est possible de réservé l’accès aux données à certains utilisateurs et/ou de créer un accès ouvert.
Pour toutes les APIs migrées (avec ou sans filtre) un accès par défaut est créé.
| Element | Contenu |
|---|---|
Libellé |
[Accès généré automatiquement] |
Description |
“Cet accès a été créé automatiquement au moment de la migration. Il ne possède aucun filtre sur lignes et aucune restriction sur colonnes. Les consommateurs correspondent aux utilisateurs et aux groupes qui ont été mappés sur les membres du Projet au moment de la migration.” |
État |
Actif |
Type d’accès |
Réservé |
Consommateurs |
Correspond au résultat du mapping de tous les membres du Projet (groupes + utilisateurs) |
Si l’API contient 1 filtre ou plus, un accès est créé pour chaque filtre paramétré avec des utilisateurs.
| Element | V1 Filtre Exposition DataBlock | V2 Partages : Accès à l’Exposition API |
|---|---|---|
Libellé |
Filtre A |
Filtre A |
Description |
|
|
État |
|
|
Type d’accès |
Non existant |
Limité |
Consommateurs |
Utilisateurs et groupes définis pour ce filtre |
Correspond au résultat du mapping de tous les groupes et utilisateurs définis dans le filtre |