Creación de una conexión de origen Amazon Kinesis mediante la API de servicio de flujo

Este tutorial le guía por los pasos para conectar Amazon Kinesis (en adelante denominado "Kinesis") con el Experience Platform, utilizando la Flow Service API.

Primeros pasos

Esta guía requiere conocer los siguientes componentes de Adobe Experience Platform:

  • Fuentes: Experience Platform permite la ingesta de datos de varias fuentes, al mismo tiempo que permite estructurar, etiquetar y mejorar los datos entrantes mediante Platform servicios.
  • Simuladores para pruebas: 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 secciones siguientes proporcionan información adicional que deberá conocer para conectar correctamente Kinesis a Platform mediante la API Flow Service.

Recopilar las credenciales necesarias

Para que Flow Service se conecte con su cuenta Amazon Kinesis, debe proporcionar valores para las siguientes propiedades de conexión:

Credencial Descripción
accessKeyId El ID de clave de acceso es la mitad del par de clave de acceso utilizado para autenticar su cuenta Kinesis en Platform.
secretKey La clave de acceso secreta es la otra mitad del par de claves de acceso utilizado para autenticar su cuenta Kinesis en Platform.
region Región de la cuenta Kinesis. Consulte la guía adición de direcciones IP a la lista de permitidos para obtener más información sobre las regiones.
connectionSpec.id La especificación de conexión devuelve las propiedades del conector de un origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y de origen. El ID de especificación de conexión Kinesis es: 86043421-563b-46ec-8e6c-e23184711bf6.

Para obtener más información sobre las claves de acceso Kinesis y cómo generarlas, consulte esta AWS guía sobre la administración de claves de acceso para los usuarios de IAM.

Uso de las API de plataforma

Para obtener información sobre cómo realizar llamadas correctamente a las API de Platform, consulte la guía de introducción a las API de Platform.

Creación de una conexión base

El primer paso para crear una conexión de origen es autenticar el origen Kinesis y generar un ID de conexión base. Un ID de conexión base le permite explorar y navegar por archivos desde el origen e identificar elementos específicos que desee introducir, incluida información sobre sus tipos de datos y formatos.

Para crear un ID de conexión base, realice una solicitud de POST al extremo /connections y proporcione las credenciales de autenticación Kinesis como parte de los parámetros de solicitud.

Formato de API

POST /connections

Solicitud

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": "Amazon Kinesis connection",
        "description": "Connector for Amazon Kinesis",
        "providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
        "auth": {
            "specName": "Aws Kinesis authentication credentials",
            "params": {
                "accessKeyId": "{ACCESS_KEY_ID}",
                "secretKey": "{SECRET_KEY}",
                "region": "{REGION}"
            }
        },
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        }
    }'
Propiedad Descripción
auth.params.accessKeyId El ID de clave de acceso para su cuenta Kinesis.
auth.params.secretKey La clave de acceso secreta para su cuenta Kinesis.
auth.params.region Región de la cuenta Kinesis.
connectionSpec.id El ID de especificación de conexión Kinesis: 86043421-563b-46ec-8e6c-e23184711bf6

Respuesta

Una respuesta correcta devuelve detalles de la conexión base recién creada, incluido su identificador único (id). Este ID es necesario en el paso siguiente para crear una conexión de origen.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

Crear una conexión de origen

Una conexión de origen crea y administra la conexión con el origen externo desde el que se introducen los datos. Una conexión de origen consiste en información como el origen de datos, el formato de datos y el ID de conexión de origen necesario para crear un flujo de datos. Una instancia de conexión de origen es específica para un inquilino y una organización IMS.

Para crear una conexión de origen, realice una solicitud de POST al extremo /sourceConnections de la API Flow Service.

Formato de API

POST /sourceConnections

Solicitud

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
    -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": "AWS Kinesis source connection",
        "description": "A source connection for AWS Kinesis",
        "baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
        "connectionSpec": {
            "id": "86043421-563b-46ec-8e6c-e23184711bf6",
            "version": "1.0"
        },
        "data": {
            "format": "json"
        },
        "params": {
            "stream": "{STREAM}",
            "dataType": "raw",
            "reset": "latest"
        }
    }'
Propiedad Descripción
name Nombre de la conexión de origen. Asegúrese de que el nombre de la conexión de origen sea descriptivo, ya que puede utilizarlo para buscar información sobre la conexión de origen.
description Un valor opcional que puede proporcionar para incluir más información sobre la conexión de origen.
baseConnectionId El ID de conexión base del origen Kinesis que se generó en el paso anterior.
connectionSpec.id El ID de especificación de conexión fija para Kinesis. Este ID es : 86043421-563b-46ec-8e6c-e23184711bf6
data.format El formato de los datos Kinesis que desea introducir. Actualmente, el único formato de datos admitido es json.
params.stream Nombre del flujo de datos desde el que se extraerán los registros.
params.dataType Este parámetro define el tipo de datos que se están incorporando. Los tipos de datos admitidos son: raw y xdm.
params.reset Este parámetro define cómo se leerán los datos. Utilice latest para empezar a leer los datos más recientes y utilice earliest para comenzar a leer los primeros datos disponibles del flujo.

Respuesta

Una respuesta correcta devuelve el identificador único (id) de la conexión de origen recién creada. Este ID es necesario en el siguiente tutorial para crear un flujo de datos.

{
    "id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
    "etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}

Pasos siguientes

Siguiendo este tutorial, ha creado una conexión de origen Kinesis utilizando la API Flow Service. Puede utilizar este ID de conexión de origen en el siguiente tutorial para crear un flujo de datos de flujo continuo mediante la Flow Service API.

En esta página