Flow Service O é usado para coletar e centralizar dados do cliente de várias fontes diferentes no Adobe Experience Platform. O serviço fornece uma interface de usuário e uma RESTful API da qual todas as fontes compatíveis são conectáveis.
Este tutorial usa a API Flow Service para orientá-lo pelas etapas para se conectar Experience Platform a uma conta Amazon Kinesis.
Este guia requer uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:
As seções a seguir fornecem informações adicionais que você precisará saber para se conectar com êxito a uma conta Amazon Kinesis usando a API Flow Service.
Para que Flow Service se conecte com sua conta Amazon Kinesis, você deve fornecer valores para as seguintes propriedades de conexão:
Credencial | Descrição |
---|---|
accessKeyId |
A ID da chave de acesso para sua conta Kinesis. |
secretKey |
A chave de acesso secreta para sua conta Kinesis. |
region |
A região da sua conta Kinesis. |
connectionSpec.id |
A ID da especificação de conexão Kinesis: 86043421-563b-46ec-8e6c-e23184711bf6 |
Para obter mais informações sobre esses valores, consulte este documento Kinesis.
Este tutorial fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações do . Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de exemplo retornado nas respostas da API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de exemplo, consulte a seção sobre como ler chamadas de API de exemplo no Experience Platform guia de solução de problemas.
Para fazer chamadas para Platform APIs, primeiro complete o tutorial de autenticação. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API Experience Platform, conforme mostrado abaixo:
Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {IMS_ORG}
Todos os recursos em Experience Platform, incluindo aqueles pertencentes a Flow Service, são isolados para sandboxes virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifica o nome da sandbox em que a operação ocorrerá:
x-sandbox-name: {SANDBOX_NAME}
Todas as solicitações que contêm uma carga útil (POST, PUT, PATCH) exigem um cabeçalho de tipo de mídia adicional:
Content-Type: application/json
Uma conexão especifica uma fonte e contém suas credenciais para essa fonte. Somente uma conexão é necessária por conta Amazon Kinesis, pois pode ser usada para criar vários conectores de origem para trazer dados diferentes.
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: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Amazon Kinesis connection",
"description": "Connector for Amazon Kinesis",
"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"
}
}'
Propriedade | Descrição |
---|---|
auth.params.accessKeyId |
A ID da chave de acesso para sua conta Kinesis. |
auth.params.secretKey |
A chave de acesso secreta para sua conta Kinesis. |
auth.params.region |
A região da sua conta Kinesis. Para obter mais informações sobre regiões, consulte o documento em lista de permissões de endereço IP |
connectionSpec.id |
A ID da especificação de conexão Kinesis: 86043421-563b-46ec-8e6c-e23184711bf6 |
Resposta
Uma resposta bem-sucedida retorna detalhes da conexão recém-criada, incluindo seu identificador exclusivo (id
). Essa ID é necessária para explorar seus dados de armazenamento em nuvem no próximo tutorial.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Ao seguir este tutorial, você criou uma conexão Amazon Kinesis usando APIs e uma ID exclusiva foi obtida como parte do corpo da resposta. Você pode usar essa ID de conexão para coletar dados de transmissão usando a API do Serviço de Fluxo.