Prise en charge des liens privés pour les sources dans l’API
Vous pouvez utiliser la fonction Lien privé pour créer des points d’entrée privés auxquels vos sources Adobe Experience Platform peuvent se connecter. Connectez vos sources à un réseau virtuel en toute sécurité à l’aide d’adresses IP privées, éliminant ainsi le besoin d’adresses IP publiques et réduisant votre surface d’attaque. Simplifiez la configuration de votre réseau en supprimant la nécessité de configurations complexes de pare-feu ou de traduction d’adresses réseau, tout en veillant à ce que le trafic de données atteigne uniquement les services approuvés.
Lisez ce guide pour savoir comment utiliser des API pour créer et utiliser un point d’entrée privé.
Droits d’utilisation de licence pour la prise en charge des liens privés
Les mesures de droits d’utilisation de licence pour la prise en charge des liens privés dans les sources sont les suivantes :
- Les clients ont droit à un transfert de données allant jusqu’à 2 To par an via des sources prises en charge (Azure Blob Storage, ADLS Gen2 et Azure File Storage), sur l’ensemble des sandbox et des organisations.
- Chaque organisation peut avoir un maximum de 10 points d’entrée pour tous les sandbox de production.
- Chaque organisation peut avoir un point d’entrée maximum pour tous les sandbox de développement.
Commencer
Ce guide nécessite une compréhension professionnelle des composants suivants d’Experience Platform :
- Sources : Experience Platform permet d’ingérer des données provenant de diverses sources tout en vous offrant la possibilité de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide des services d’Experience Platform.
- Sandbox : Experience Platform fournit des sandbox virtuels qui divisent une instance Experience Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience digitale.
Utiliser les API Platform
Pour plus d’informations sur la manière d’effectuer des appels vers les API Platform, consultez le guide Prise en main des API Platform.
Créer un point d’entrée privé create-private-endpoint
Pour créer un point d’entrée privé, envoyez une requête POST à /privateEndpoints
.
Format d’API
POST /privateEndpoints
Requête
La requête suivante crée un point d’entrée privé :
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 | |
---|---|
Propriété | Description |
name |
Nom de votre point d’entrée privé. |
subscriptionId |
ID associé à votre abonnement Azure. Pour plus d’informations, consultez le guide de Azure sur la récupération des ID d’abonnement et de client de l’ Azure Portal. |
resourceGroupName |
Nom de votre groupe de ressources sur Azure. Un groupe de ressources contient les ressources associées à une solution Azure. Pour plus d’informations, consultez le guide Azure sur la gestion des groupes de ressources. |
resourceName |
Nom de la ressource. Dans Azure, une ressource fait référence à des instances telles que des machines virtuelles, des applications web et des bases de données. Pour plus d’informations, consultez le guide Azure sur présentation du gestionnaire Azure ressources. |
connectionSpec.id |
Identifiant de spécification de connexion de la source que vous utilisez. |
connectionSpec.version |
Version de l’identifiant de spécification de connexion que vous utilisez. |
Réponse
Une réponse réussie renvoie les éléments suivants :
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
Propriété | Description |
id |
L’identifiant du point d’entrée privé que vous venez de créer. |
name |
Nom de votre point d’entrée privé. |
subscriptionId |
ID associé à votre abonnement Azure. Pour plus d’informations, consultez le guide de Azure sur la récupération des ID d’abonnement et de client de l’ Azure Portal. |
resourceGroupName |
Nom de votre groupe de ressources sur Azure. Un groupe de ressources contient les ressources associées à une solution Azure. Pour plus d’informations, consultez le guide Azure sur la gestion des groupes de ressources. |
resourceName |
Nom de la ressource. Dans Azure, une ressource fait référence à des instances telles que des machines virtuelles, des applications web et des bases de données. Pour plus d’informations, consultez le guide Azure sur présentation du gestionnaire Azure ressources. |
connectionSpec.id |
Identifiant de spécification de connexion de la source que vous utilisez. |
connectionSpec.version |
Version de l’identifiant de spécification de connexion que vous utilisez. |
state |
État actuel de votre point d’entrée privé. Les états valides sont les suivants :
|
Récupération d’une liste de points d’entrée privés retrieve-private-endpoints
Pour récupérer une liste de points d’entrée privés d’un sandbox donné de votre organisation, envoyez une requête GET à /privateEndpoints
.
Format d’API
GET /privateEndpoints
Requête
La requête suivante récupère une liste de tous les points d’entrée privés qui existent dans votre organisation.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie une liste de points d’entrée privés de votre organisation.
code language-json |
---|
|
Récupération d’une liste de points d’entrée privés pour une source donnée retrieve-private-endpoints-by-source
Pour récupérer une liste de points d’entrée privés qui correspondent à une source spécifique, envoyez une requête GET au point d’entrée /privateEndpoints
et indiquez le connectionSpec.id
de la source.
Format d’API
GET /privateEndpoints?property=connectionSpec.id=={CONNECTION_SPEC_ID}
{CONNECTION_SPEC_ID}
Requête
La requête suivante récupère une liste de tous les points d’entrée privés qui correspondent à la source avec l’identifiant de spécification de connexion : 4c10e202-c428-4796-9208-5f1f5732b1cf
.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie une liste de tous les points d’entrée privés qui correspondent à la source avec l’identifiant de spécification de connexion : 4c10e202-c428-4796-9208-5f1f5732b1cf
.
code language-json |
---|
|
Récupérer un point d’entrée privé retrieve-specific-private-endpoint
Pour récupérer un point d’entrée privé spécifique, envoyez une requête GET à /privateEndpoints
et indiquez l’identifiant du point d’entrée privé que vous souhaitez récupérer.
Format d’API
GET /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
Requête
La requête suivante récupère le point d’entrée privé avec l’ID :2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie le point d’entrée privé avec l’identifiant : 2c5699b0-b9b6-486f-8877-ee5e21fe9a9d
code language-json |
---|
|
Résoudre un point d’entrée privé resolve-private-endpoint
Format d’API
GET /privateEndpoints?op=autoResolve
Requête
code language-shell |
---|
|
Réponse
code language-json |
---|
|
Activer le Interactive Authoring enable-interactive-authoring
Interactive Authoring est utilisé pour des fonctionnalités telles que l’exploration d’une connexion ou d’un compte et la prévisualisation de données. Pour Interactive Authoring activer, envoyez une requête POST à /privateEndpoints/interactiveAuthoring
et spécifiez enable
en tant qu’opérateur dans vos paramètres de requête.
Format d’API
POST /privateEndpoints/interactiveAuthoring?op=enable
op
op
sur enable
.Requête
La requête suivante active Interactive Authoring pour votre point d’entrée privé et définit la durée de vie sur 60 minutes.
code language-shell |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Propriété | Description |
autoTerminationMinutes |
Durée de vie (TTL) Interactive Authoring en minutes. Interactive Authoring est utilisé pour des fonctionnalités telles que l’exploration d’une connexion ou d’un compte et la prévisualisation de données. Vous pouvez définir une durée de vie maximale de 120 minutes. La durée de vie par défaut est de 60 minutes. |
Réponse
Une réponse réussie renvoie le statut HTTP 202 (Accepté).
Récupérer le statut du Interactive Authoring retrieve-interactive-authoring-status
Pour afficher le statut actuel de Interactive Authoring pour votre point d’entrée privé, envoyez une requête GET à /privateEndpoints/interactiveAuthoring
.
Format d’API
GET /privateEndpoints/interactiveAuthoring
Requête
La requête suivante récupère le statut de Interactive Authoring :
code language-shell |
---|
|
Réponse
code language-json |
---|
|
table 0-row-2 1-row-2 | |
---|---|
Propriété | Description |
status |
Statut de Interactive Authoring. Les valeurs valides sont les suivantes : disabled , enabling , enabled . |
Supprimer le point de terminaison privé delete-private-endpoint
Pour supprimer votre point d’entrée privé, envoyez une requête DELETE à /privateEndpoints
et indiquez l’identifiant du point d’entrée que vous souhaitez supprimer.
Format d’API
DELETE /privateEndpoints/{PRIVATE_ENDPOINT_ID}
{PRIVATE_ENDPOINT_ID}
Requête
La requête suivante supprime le point d’entrée privé avec l’ID : 02a74b31-a566-4a86-9cea-309b101a7f24
.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie un statut HTTP 200 (Succès). Vous pouvez vérifier la suppression en effectuant une requête GET et en /privateEndpoints
et en fournissant l’identifiant supprimé comme paramètre de requête.
Service de flux flow-service
Lisez les sections suivantes pour savoir comment utiliser des points d’entrée privés conjointement avec l’Flow Service API.
Créer une connexion avec un point d’entrée privé create-base-connection
Pour créer une connexion avec un point d’entrée privé dans Experience Platform, envoyez une requête POST au point d’entrée /connections
de l’API Flow Service.
Format d’API
POST /connections/
Requête
La requête suivante crée une connexion de base authentifiée pour Azure Blob Storage, tout en utilisant un point d’entrée privé.
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 | |
---|---|
Propriété | Description |
name |
Nom de votre connexion de base. |
description |
(Facultatif) Description qui fournit des informations supplémentaires sur votre connexion. |
auth.specName |
Authentification utilisée pour connecter votre source à Experience Platform. |
auth.params.connectionString |
Chaîne de connexion Azure Blob Storage. Pour plus d’informations, consultez le Azure Blob Storage guide d’authentification des API. |
auth.params.usePrivateLink |
Valeur booléenne qui détermine si vous utilisez ou non un point d’entrée privé. Définissez cette valeur sur true si vous utilisez un point d’entrée privé. |
connectionSpec.id |
Identifiant de spécification de connexion de Azure Blob Storage. |
connectionSpec.version |
Version de l’identifiant de spécification de connexion Azure Blob Storage. |
Réponse
Une réponse réussie renvoie l’identifiant de connexion de base et l’etag que vous venez de générer.
code language-json |
---|
|
Récupérer les connexions liées à un point d’entrée privé donné retrieve-connections-by-endpoint
Pour récupérer des connexions liées à un point d’entrée privé spécifique, envoyez une requête GET au point d’entrée /connections
et indiquez l’identifiant du point d’entrée privé comme paramètre de requête.
Format d’API
GET /connections?property=auth.params.privateEndpointId=={PRIVATE_ENDPOINT_ID}
Requête
La requête suivante récupère les connexions existantes liées à un point d’entrée privé avec l’ID : 02a74b31-a566-4a86-9cea-309b101a7f24
.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie une liste de connexions liées au point d’entrée privé interrogé.
code language-json |
---|
|
Récupérer les connexions associées à un point d’entrée privé retrieve-connections
Pour récupérer les connexions associées à un point d’entrée privé, envoyez une requête GET au point d’entrée /connections
et indiquez le property=auth.params.usePrivateLink==true
comme paramètre de requête.
Format d’API
GET /connections?property=auth.params.usePrivateLink==true
Requête
La requête suivante récupère toutes les connexions de votre organisation qui utilisent des points d’entrée privés.
code language-shell |
---|
|
Réponse
Une réponse réussie renvoie toutes les connexions liées à des points d’entrée privés.
code language-json |
---|
|
Annexe
Lisez cette section pour plus d’informations sur l’utilisation de liens privés Azure dans l’API.
Approuver un point d’entrée privé pour Azure Blob et Azure Data Lake Gen2
Pour approuver une demande de point d’entrée privé pour les sources Azure Blob et Azure Data Lake Gen2, connectez-vous au Azure Portal . Dans le volet de navigation de gauche, sélectionnez Data storage, puis accédez à l’onglet Security + networking et choisissez Networking. Sélectionnez ensuite Private endpoints pour afficher la liste des points d’entrée privés associés à votre compte et leurs états de connexion actuels. Pour approuver une demande en attente, sélectionnez le point d’entrée souhaité, puis cliquez sur Approve.