Flow Service é usada 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 a partir da qual todas as fontes compatíveis são conectáveis.
Este tutorial usa a API Flow Service para guiá-lo pelas etapas para conectar Experience Platform a um armazenamento Amazon S3 (a seguir denominado "S3").
Se você preferir usar a interface do usuário em Experience Platform, o tutorial da interface do usuário do conector de origem do Amazon S3](…/…/…/ui/create/cloud-storage/s3.md) fornece instruções passo a passo para executar ações semelhantes.[
Este guia exige uma compreensão prática 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 um armazenamento S3 usando a API Flow Service.
Para que Flow Service se conecte ao seu armazenamento S3, é necessário fornecer valores para as seguintes propriedades de conexão:
Credencial | Descrição |
---|---|
s3AccessKey |
A ID da chave de acesso para seu armazenamento S3. |
s3SecretKey |
A ID da chave secreta para seu armazenamento S3. |
Para obter mais informações sobre a introdução, visite este documento AWS.
Este tutorial fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de amostra retornado em respostas de API também é fornecido. Para obter informações sobre as convenções usadas na documentação para chamadas de API de amostra, consulte a seção em como ler chamadas de API de exemplo no guia de solução de problemas Experience Platform.
Para fazer chamadas para Platform APIs, você deve primeiro concluir 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, como 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 os pertencentes a Flow Service, são isolados para caixas de proteção virtuais específicas. Todas as solicitações para Platform APIs exigem um cabeçalho que especifique o nome da caixa de proteção em que a operação ocorrerá:
x-sandbox-name: {SANDBOX_NAME}
Todas as solicitações que contêm uma carga (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 S3, pois pode ser usada para criar vários conectores de origem para trazer dados diferentes.
Formato da API
POST /connections
Solicitação
Para criar uma conexão S3, sua ID exclusiva de especificação de conexão deve ser fornecida como parte da solicitação de POST. A ID de especificação de conexão para S3 é ecadc60c-7455-4d87-84dc-2a0e293d997b
.
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": "S3 Connection",
"description": "Connection for an Amazon S3 account",
"auth": {
"specName": "Access Key",
"params": {
"s3AccessKey": "{S3_ACCESS_KEY}",
"s3SecretKey": "{S3_SECRET_KEY}"
}
},
"connectionSpec": {
"id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
"version": "1.0"
}
}'
Propriedade | Descrição |
---|---|
auth.params.s3AccessKey |
A chave de acesso associada ao seu armazenamento S3. |
auth.params.s3SecretKey |
Sua chave secreta associada ao seu armazenamento S3. |
connectionSpec.id |
A ID da especificação da conexão do armazenamento S3: ecadc60c-7455-4d87-84dc-2a0e293d997b |
Resposta
Uma resposta bem-sucedida retorna detalhes da conexão recém-criada, incluindo seu identificador exclusivo (id
). Essa ID é necessária para explorar seu armazenamento no próximo tutorial.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}
Ao seguir este tutorial, você criou uma conexão S3 usando APIs e uma ID exclusiva foi obtida como parte do corpo da resposta. Você pode usar essa ID de conexão para explorar armazenamentos em nuvem usando a API do Serviço de Fluxo ou assimilar dados de parquet usando a API do Serviço de Fluxo.