Create a Phoenix base connection using the Flow Service API

NOTE

The Phoenix connector is in beta. See the Sources overview for more information on using beta-labelled connectors.

Flow Service is used to collect and centralize customer data from various disparate sources within Adobe Experience Platform. The service provides a user interface and RESTful API from which all supported sources are connectable.

This tutorial uses the Flow Service API to walk you through the steps to connect a Phoenix database to Experience Platform.

Getting started

This guide requires a working understanding of the following components of Adobe Experience Platform:

  • Sources: Experience Platform allows data to be ingested from various sources while providing you with the ability to structure, label, and enhance incoming data using Platform services.
  • Sandboxes: Experience Platform provides virtual sandboxes which partition a single Platform instance into separate virtual environments to help develop and evolve digital experience applications.

The following sections provide additional information that you will need to know in order to successfully connect to Phoenix using the Flow Service API.

Gather required credentials

In order for Flow Service to connect with Phoenix, you must provide values for the following connection properties:

Credential Description
host The IP address or host name of the Phoenix server.
username The user name that you use to access Phoenix Server.
password The password corresponding to the user.
port The TCP port that the Phoenix server uses to listen for client connections. If you connect to Azure HDInsights, specify port as 443.
httpPath The partial URL corresponding to the Phoenix server. Specify /hbasephoenix0 if using Azure HDInsights cluster.
enableSsl A boolean value. Specifies whether the connections to the server are encrypted using SSL.
connectionSpec.id The connection specification returns a source’s connector properties, including authentication specifications related to creating the base and source connections. The connection specification ID for Phoenix is: 102706fb-a5cd-42ee-afe0-bc42f017ff43

For more information about getting started refer to this Phoenix document.

Using Platform APIs

For information on how to successfully make calls to Platform APIs, see the guide on getting started with Platform APIs.

Create a base connection

A base connection retains information between your source and Platform, including your source’s authentication credentials, the current state of the connection, and your unique base connection ID. The base connection ID allows you to explore and navigate files from within your source and identify the specific items that you want to ingest, including information regarding their data types and formats.

To create a base connection ID, make a POST request to the /connections endpoint while providing your Phoenix authentication credentials as part of the request parameters.

API format

POST /connections

Request

The following request creates a base connection for 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: {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"
        }
    }'
Property Description
auth.params.host The host of the Phoenix server.
auth.params.username The username associated with your Phoenix connection.
auth.params.password The password associated with your Phoenix connection.
auth.params.port The TCP port for your Phoenix connection.
auth.params.httpPath The partial http path for your Phoenix connection.
auth.params.enableSsl The boolean value that specifies whether the connections to the server are encrypted using SSL.
connectionSpec.id The Phoenix connection specification ID: 102706fb-a5cd-42ee-afe0-bc42f017ff43.

Response

A successful response returns details of the newly created connection, including its unique identifier (id). This ID is required to explore your data in the next tutorial.

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

Next steps

By following this tutorial, you have created a Phoenix connection using the Flow Service API and have obtained the connection’s unique ID value. You can use this ID in the next tutorial as you learn how to explore databases using the Flow Service API.

On this page