[Ultimate]{class="badge positive"}
Criar uma conexão de origem Amazon Kinesis usando a API de Serviço de Fluxo
Este tutorial guiará você pelas etapas para conectar Amazon Kinesis (a seguir denominado "Kinesis") ao Experience Platform, usando a Flow Service API.
Introdução
Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:
- Fontes: o Experience Platform permite que os dados sejam assimilados de várias fontes, fornecendo a capacidade de estruturar, rotular e aprimorar os dados recebidos usando os serviços do Platform.
- Sandboxes: o Experience Platform fornece sandboxes virtuais que particionam uma única instância do Platform em ambientes virtuais separados para ajudar a desenvolver aplicativos de experiência digital.
As seções a seguir fornecem informações adicionais que você precisará saber para se conectar com êxito ao Kinesis à Platform usando a API Flow Service.
Coletar credenciais necessárias
Para que Flow Service se conecte à sua conta Amazon Kinesis, você deve fornecer valores para as seguintes propriedades de conexão:
accessKeyId
secretKey
region
connectionSpec.id
86043421-563b-46ec-8e6c-e23184711bf6
.Para obter mais informações sobre Kinesis chaves de acesso e como gerá-las, consulte este AWS guia sobre como gerenciar chaves de acesso para usuários do IAM.
Uso de APIs da plataforma
Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual sobre introdução às APIs da Platform.
Criar uma conexão básica
A primeira etapa na criação de uma conexão de origem é autenticar sua origem Kinesis e gerar uma ID de conexão base. Uma ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar itens específicos que você deseja assimilar, incluindo informações sobre os tipos de dados e formatos.
Para criar uma ID de conexão base, faça uma solicitação POST para o ponto de extremidade /connections
enquanto fornece suas credenciais de autenticação Kinesis como parte dos parâmetros de solicitação.
Formato da API
POST /connections
Solicitação
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"
}
}'
auth.params.accessKeyId
auth.params.secretKey
auth.params.region
connectionSpec.id
86043421-563b-46ec-8e6c-e23184711bf6
Resposta
Uma resposta bem-sucedida retorna detalhes da conexão base recém-criada, incluindo seu identificador exclusivo (id
). Essa ID é necessária na próxima etapa para criar uma conexão de origem.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Criar uma conexão de origem source
Uma conexão de origem cria e gerencia a conexão com a origem externa de onde os dados são assimilados. Uma conexão de origem consiste em informações como fonte de dados, formato de dados e a ID da conexão de origem necessária para criar um fluxo de dados. Uma instância de conexão de origem é específica para um locatário e uma organização.
Para criar uma conexão de origem, faça uma solicitação POST para o ponto de extremidade /sourceConnections
da API Flow Service.
Formato da API
POST /sourceConnections
Solicitação
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"
}
}'
name
description
baseConnectionId
connectionSpec.id
86043421-563b-46ec-8e6c-e23184711bf6
data.format
json
.params.stream
params.dataType
raw
e xdm
.params.reset
latest
para começar a ler os dados mais recentes e use earliest
para começar a ler os primeiros dados disponíveis no fluxo.Resposta
Uma resposta bem-sucedida retorna o identificador exclusivo (id
) da conexão de origem recém-criada. Essa ID é necessária no próximo tutorial para criar um fluxo de dados.
{
"id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
"etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}
Próximas etapas
Seguindo este tutorial, você criou uma conexão de origem Kinesis usando a API Flow Service. Você pode usar esta ID de conexão de origem no próximo tutorial para criar um fluxo de dados de streaming usando a Flow Service API.