Creación de un Azure Data Explorer conector mediante la Flow Service API

Nota

El Azure Data Explorer conector está en versión beta. Consulte la descripción general de Fuentes para obtener más información sobre el uso de conectores con etiquetas beta.

Flow Service se utiliza para recopilar y centralizar datos de clientes de diversas fuentes dentro de Adobe Experience Platform. El servicio proporciona una interfaz de usuario y una API RESTful desde la que se pueden conectar todas las fuentes admitidas.

Este tutorial utiliza la Flow Service API para guiarle por los pasos a los que conectarse Azure Data Explorer (en adelante, "Data Explorer") a Experience Platform.

Primeros pasos

Esta guía requiere un conocimiento práctico de los siguientes componentes de Adobe Experience Platform:

  • Fuentes: Experience Platform permite la ingesta de datos desde varias fuentes, al tiempo que le permite estructurar, etiquetar y mejorar los datos entrantes mediante Platform servicios.
  • Simuladores: Experience Platform proporciona entornos limitados virtuales que dividen una sola Platform instancia en entornos virtuales independientes para ayudar a desarrollar y desarrollar aplicaciones de experiencia digital.

Las siguientes secciones proporcionan información adicional que deberá conocer para conectarse correctamente a Data Explorer través de la Flow Service API.

Recopilar las credenciales necesarias

Para Flow Service conectarse con Data Explorer, debe proporcionar valores para las siguientes propiedades de conexión:

Credencial Descripción
endpoint The endpoint of the Data Explorer server.
database Nombre de la Data Explorer base de datos.
tenant ID de inquilino único que se utiliza para conectarse a la Data Explorer base de datos.
servicePrincipalId ID de principal de servicio único que se utiliza para conectarse a la Data Explorer base de datos.
servicePrincipalKey Clave principal de servicio única utilizada para conectarse a la Data Explorer base de datos.
connectionSpec.id Identificador único necesario para crear una conexión. El ID de especificación de conexión para Data Explorer es 0479cc14-7651-4354-b233-7480606c2ac3.

Para obtener más información sobre cómo empezar, consulte este documentode Data Explorer.

Leer llamadas de API de muestra

Este tutorial proporciona ejemplos de llamadas a API para mostrar cómo dar formato a las solicitudes. Estas incluyen rutas, encabezados requeridos y cargas de solicitud con el formato adecuado. También se proporciona el JSON de muestra devuelto en las respuestas de API. Para obtener información sobre las convenciones utilizadas en la documentación de las llamadas de API de muestra, consulte la sección sobre cómo leer llamadas de API de ejemplo en la guía de solución de problemas Experience Platform .

Recopilar valores para encabezados necesarios

Para realizar llamadas a Platform API, primero debe completar el tutorial deautenticación. La finalización del tutorial de autenticación proporciona los valores para cada uno de los encabezados necesarios en todas las llamadas de la API de Experience Platform , como se muestra a continuación:

  • Autorización: Portador {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Todos los recursos de Experience Platform, incluidos los que pertenecen al Flow Service, están aislados en entornos limitados virtuales específicos. Todas las solicitudes a Platform las API requieren un encabezado que especifique el nombre del entorno limitado en el que se realizará la operación:

  • x-sandbox-name: {SANDBOX_NAME}

Todas las solicitudes que contienen una carga útil (POST, PUT, PATCH) requieren un encabezado de tipo de medio adicional:

  • Content-Type: application/json

Crear una conexión

Una conexión especifica un origen y contiene sus credenciales para ese origen. Solo se requiere un conector por Data Explorer cuenta, ya que se puede utilizar para crear varios conectores de origen para introducir datos diferentes.

Formato API

POST /connections

Solicitud

Para crear una Data Explorer conexión, debe proporcionarse su ID de especificación de conexión única como parte de la solicitud del POST. El ID de especificación de conexión para Data Explorer es 0479cc14-7651-4354-b233-7480606c2ac3.

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": "Azure Data Explorer connection",
        "description": "A connection for Azure Data Explorer",
        "auth": {
            "specName": "Service Principal Based Authentication",
            "params": {
                    "endpoint": "{ENDPOINT}",
                    "database": "{DATABASE}",
                    "tenant": "{TENANT}",
                    "servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
                    "servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}"
                }
        },
        "connectionSpec": {
            "id": "0479cc14-7651-4354-b233-7480606c2ac3",
            "version": "1.0"
        }
    }'
Parámetro Descripción
auth.params.endpoint The endpoint of the Data Explorer server.
auth.params.database Nombre de la Data Explorer base de datos.
auth.params.tenant ID de inquilino único que se utiliza para conectarse a la Data Explorer base de datos.
auth.params.servicePrincipalId ID de principal de servicio único que se utiliza para conectarse a la Data Explorer base de datos.
auth.params.servicePrincipalKey Clave principal de servicio única utilizada para conectarse a la Data Explorer base de datos.
connectionSpec.id ID de especificación de Data Explorer conexión: 0479cc14-7651-4354-b233-7480606c2ac3.

Respuesta

Una respuesta correcta devuelve detalles de la conexión recién creada, incluido su identificador único (id). Este ID es necesario para explorar los datos en el siguiente tutorial.

{
    "id": "f088e4f2-2464-480c-88e4-f22464b80c90",
    "etag": "\"43011faa-0000-0200-0000-5ea740cd0000\""
}

Pasos siguientes

Siguiendo este tutorial, ha creado una Data Explorer conexión mediante la Flow Service API y ha obtenido el valor de ID único de la conexión. Puede utilizar este ID en el siguiente tutorial cuando aprenda a explorar bases de datos mediante la APIde servicio de flujo.

En esta página