DocumentationExperience PlatformGuide des connecteurs sources

Créez une connexion de base à Phoenix à l’aide de l’API Flow Service.

Last update: Wed Jul 26 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Developer

Une connexion de base représente la connexion authentifiée entre une source et Adobe Experience Platform.

Ce tutoriel décrit les étapes à suivre pour créer une connexion de base et connecter votre Phoenix à Adobe Experience Platform à l’aide de la variable Flow Service API.

Prise en main

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 permettant de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide des services d’Experience Platform.
  • Environnements de test: Experience Platform fournit des environnements de test virtuels qui divisent une instance d’Experience Platform unique en environnements virtuels distincts pour favoriser le développement et l’évolution d’applications d’expérience numérique.

Les sections suivantes apportent des informations supplémentaires dont vous aurez besoin pour vous connecter. Phoenix en utilisant la variable Flow Service API.

Collecter les informations d’identification requises

Vous devez fournir les informations d’authentification suivantes pour vous connecter à votre Phoenix compte à Experience Platform.

Informations d’identification
Description
host
L’adresse IP ou le nom d’hôte de la variable Phoenix serveur.
username
Nom d’utilisateur auquel vous accédez Phoenix Serveur.
password
Mot de passe correspondant à l’utilisateur.
port
Le port TCP que la variable Phoenix Le serveur utilise pour écouter les connexions client. Si vous vous connectez à Azure HDInsights, puis spécifiez le port 443. Si ce paramètre n’est pas fourni, la valeur par défaut est 8765.
httpPath
L’URL partielle correspondant au Phoenix serveur. Spécifiez /hbasephoenix0 si vous utilisez Azure Grappe HDInsights .
enableSsl
Une valeur booléenne. Indique si les connexions au serveur sont chiffrées à l’aide de SSL.
connectionSpec.id
La spécification de connexion renvoie les propriétés du connecteur d’une source, y compris les spécifications d’authentification liées à la création des connexions de base et source. L’identifiant de spécification de connexion pour Phoenix est : 102706fb-a5cd-42ee-afe0-bc42f017ff43

Pour plus d’informations sur la prise en main, voir ce document Phoenix.

Utiliser les API Platform

Pour plus d’informations sur la manière d’effectuer avec succès des appels vers les API Platform, consultez le guide sur la Prise en main des API Platform.

Créer une connexion de base

Une connexion de base conserve les informations échangées entre votre source et Platform, y compris les informations d’authentification de votre source, l’état actuel de la connexion et votre identifiant de connexion de base unique. L’identifiant de connexion de base vous permet d’explorer et de parcourir des fichiers à partir de votre source et d’identifier les éléments spécifiques que vous souhaitez ingérer, y compris des informations concernant leurs types et formats de données.

Pour créer une connexion de base, envoyez une requête de POST au /connections point de terminaison lors de la fourniture de Phoenix informations d’identification d’authentification dans le corps de la requête.

Format d’API

POST /connections

Requête

La requête suivante permet de créer une connexion de base pour Phoenix :

curl -X POST \
  'https://platform.adobe.io/data/foundation/flowservice/connections' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}' \
  -H 'Content-Type: application/json' \
  -d '{
      "name": "Phoenix test connection",
      "description": "Phoenix test connection",
      "auth": {
          "specName": "Basic Authentication",
      "params": {
          "host":  "{HOST}",
          "username": "{USERNAME}",
          "password":"{PASSWORD}",
          "port": {PORT},
          "httpPath": "{PATH}",
          "enableSsl": {SSL}
          }
      },
      "connectionSpec": {
          "id": "102706fb-a5cd-42ee-afe0-bc42f017ff43",
          "version": "1.0"
      }
  }'
Propriété
Description
auth.params.host
L’hôte du Phoenix serveur.
auth.params.username
Le nom d’utilisateur associé à votre Phoenix connexion.
auth.params.password
Le mot de passe associé à votre Phoenix connexion.
auth.params.port
Le port TCP pour votre Phoenix connexion.
auth.params.httpPath
Le chemin d’accès http partiel pour votre Phoenix connexion.
auth.params.enableSsl
Valeur boolean qui spécifie si les connexions au serveur sont chiffrées à l’aide de SSL.
connectionSpec.id
La variable Phoenix identifiant de spécification de connexion : 102706fb-a5cd-42ee-afe0-bc42f017ff43.

Réponse

Une réponse réussie renvoie les détails de la connexion nouvellement créée, y compris son identifiant unique (id). Cet identifiant est nécessaire pour explorer vos données dans le tutoriel suivant.

{
    "id": "0d982fff-c443-403e-982f-ffc443f03e37",
    "etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}

Étapes suivantes

Ce tutoriel vous a permis de créer une connexion de base à Phoenix à l’aide de l’API Flow Service. Vous pouvez utiliser cet identifiant de connexion de base dans les tutoriels suivants :

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089