Show Menu
SUJETS×

Création d’un Phoenix connecteur à l’aide de l’ Flow Service API

Le Phoenix connecteur est en version bêta. Pour plus d’informations sur l’utilisation de connecteurs bêta, consultez l’aperçu des sources.
Flow Service est utilisée pour collecter et centraliser les données client provenant de diverses sources disparates au sein de l’Adobe Experience Platform. Le service fournit une interface utilisateur et une API RESTful à partir de laquelle toutes les sources prises en charge sont connectables.
Ce didacticiel utilise l’ Flow Service API pour vous guider dans les étapes de connexion d’une Phoenix base de données à Experience Platform.

Prise en main

Ce guide exige une compréhension pratique des éléments suivants de l'Adobe Experience Platform :
  • Sources : Experience Platform permet l’assimilation de données à partir de diverses sources tout en vous permettant de structurer, d’étiqueter et d’améliorer les données entrantes à l’aide de Platform services.
  • Sandbox : Experience Platform fournit des sandbox virtuels qui partitionnent une Platform instance unique en environnements virtuels distincts pour aider à développer et développer des applications d'expérience numérique.
Les sections suivantes contiennent des informations supplémentaires dont vous aurez besoin pour vous connecter à Phoenix l’aide de l’ Flow Service API.

Collecte des informations d’identification requises

Pour Flow Service établir une connexion avec Phoenix, vous devez fournir des valeurs pour les propriétés de connexion suivantes :
Informations d’identification
Description
host
Adresse IP ou nom d’hôte du Phoenix serveur.
username
Nom d’utilisateur utilisé pour accéder au Phoenix serveur.
password
Mot de passe correspondant à l’utilisateur.
port
port TCP utilisé par le Phoenix serveur pour écouter les connexions client. Si vous vous connectez à Azure HDInsights, spécifiez le port 443.
httpPath
URL partielle correspondant au Phoenix serveur. Spécifiez /hbasephoenix0 si vous utilisez Azure la grappe HDInsights.
enableSsl
Valeur booléenne. Indique si les connexions au serveur sont chiffrées à l’aide de SSL.
connectionSpec.id
Identificateur unique nécessaire pour créer une connexion. L'ID de spécification de connexion pour Phoenix est : 102706fb-a5cd-42ee-afe0-bc42f017ff43
Pour plus d'informations sur la prise en main, consultez ce document Phoenix.

Lecture des exemples d’appels d’API

Ce didacticiel fournit des exemples d’appels d’API pour montrer comment formater vos requêtes. Il s’agit notamment des chemins d’accès, des en-têtes requis et des charges de requête correctement formatées. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. Pour plus d’informations sur les conventions utilisées dans la documentation pour les exemples d’appels d’API, voir la section sur la façon de lire des exemples d’appels d’API dans le guide de Experience Platform dépannage.

Rassembler les valeurs des en-têtes requis

Pour lancer des appels aux Platform API, vous devez d'abord suivre le didacticiel d' authentification. Le didacticiel d’authentification fournit les valeurs de chacun des en-têtes requis dans tous les appels d’ Experience Platform API, comme indiqué ci-dessous :
  • Autorisation : Porteur {ACCESS_TOKEN}
  • x-api-key : {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Toutes les ressources de Experience Platform, y compris celles appartenant à la Flow Service, sont isolées dans des sandbox virtuels spécifiques. Toutes les requêtes aux Platform API nécessitent un en-tête spécifiant le nom du sandbox dans lequel l'opération aura lieu :
  • x-sandbox-name : {SANDBOX_NAME}
Toutes les requêtes qui contiennent une charge utile (POST, PUT, PATCH) nécessitent un en-tête de type de support supplémentaire :
  • Content-Type : application/json

Création d’une connexion

Une connexion spécifie une source et contient vos informations d’identification pour cette source. Une seule connexion est requise par Phoenix compte, car elle peut être utilisée pour créer plusieurs connecteurs source pour importer des données différentes.
Format d’API
POST /connections

Requête
Pour créer une Phoenix connexion, son identifiant de spécification de connexion unique doit être fourni dans le cadre de la demande POST. L'ID de spécification de connexion pour Phoenix est 102706fb-a5cd-42ee-afe0-bc42f017ff43 .
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: {IMS_ORG}' \
    -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
Hôte du Phoenix serveur.
auth.params.username
Nom d’utilisateur associé à votre Phoenix connexion.
auth.params.password
Mot de passe associé à votre Phoenix connexion.
auth.params.port
Port TCP de votre Phoenix connexion.
auth.params.httpPath
Chemin d’accès http partiel pour votre Phoenix connexion.
auth.params.enableSsl
Valeur booléenne qui spécifie si les connexions au serveur sont chiffrées à l’aide de SSL.
connectionSpec.id
ID de spécification de Phoenix 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 didacticiel suivant.
{
    "id": "0d982fff-c443-403e-982f-ffc443f03e37",
    "etag": "\"830082dc-0000-0200-0000-5e84ee560000\""
}

Étapes suivantes

En suivant ce didacticiel, vous avez créé une Phoenix connexion à l’aide de l’ Flow Service API et obtenu la valeur d’ID unique de la connexion. Vous pouvez utiliser cet identifiant dans le didacticiel suivant lorsque vous apprendrez à explorer des bases de données à l’aide de l’API Flow Service.