Ultimate

Crear un Amazon Kinesis conexión de origen mediante la API de Flow Service

IMPORTANT
El Amazon Kinesis La fuente de está disponible en el catálogo de fuentes de para los usuarios que han adquirido Real-time Customer Data Platform Ultimate.

Este tutorial lo acompañará durante los pasos para conectarse Amazon Kinesis (en lo sucesivo, "Kinesis") al Experience Platform, utilizando Flow Service API.

Introducción

Esta guía requiere una comprensión práctica de los siguientes componentes de Adobe Experience Platform:

  • Fuentes: el Experience Platform permite la ingesta de datos desde varias fuentes y, al mismo tiempo, le ofrece la capacidad de estructurar, etiquetar y mejorar los datos entrantes mediante Platform servicios.
  • Zonas protegidas: el Experience Platform proporciona entornos limitados virtuales que dividen un solo Platform en entornos virtuales independientes para ayudar a desarrollar y evolucionar aplicaciones de experiencia digital.

Las secciones siguientes proporcionan información adicional que deberá conocer para conectarse correctamente Kinesis a Platform mediante el Flow Service API.

Recopilar credenciales necesarias

Para que Flow Service para conectarse con su Amazon Kinesis En su cuenta de, 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 claves de acceso que se utiliza para autenticar su Kinesis a Platform.
secretKey
La clave secreta de acceso es la otra mitad del par de claves de acceso que se utiliza para autenticar su Kinesis a Platform.
region
La región para su Kinesis cuenta. Consulte la guía de 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 origen, incluidas las especificaciones de autenticación relacionadas con la creación de las conexiones base y origen. El Kinesis ID de especificación de conexión: 86043421-563b-46ec-8e6c-e23184711bf6.

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

Uso de API de Platform

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.

Cree una conexión base

El primer paso para crear una conexión de origen es autenticar su 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 /connections extremo al proporcionar su Kinesis credenciales de autenticación 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: {ORG_ID}' \
    -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 la clave de acceso de su Kinesis cuenta.
auth.params.secretKey
La clave secreta de acceso para su Kinesis cuenta.
auth.params.region
La región para su Kinesis cuenta.
connectionSpec.id
El Kinesis identificador de especificación de conexión: 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 siguiente paso 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 source

Una conexión de origen crea y administra la conexión con el origen externo desde el que se incorporan los datos. Una conexión de origen consta de 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 de un inquilino y una organización.

Para crear una conexión de origen, realice una solicitud de POST al /sourceConnections punto final del Flow Service API.

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: {ORG_ID}' \
    -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 de su Kinesis origen que se generó en el paso anterior.
connectionSpec.id
Identificador de especificación de conexión fija para Kinesis. Este ID es: 86043421-563b-46ec-8e6c-e23184711bf6
data.format
El formato del Kinesis datos que desea introducir. Actualmente, el único formato de datos admitido es json.
params.stream
Nombre del flujo de datos desde el que se extraen registros.
params.dataType
Este parámetro define el tipo de datos que se están introduciendo. Los tipos de datos admitidos son: raw y xdm.
params.reset
Este parámetro define cómo se leerán los datos. Uso latest para empezar a leer los datos más recientes, y utilice earliest para comenzar a leer los primeros datos disponibles en la secuencia.

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

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

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