Uma conexão base representa a conexão autenticada entre uma origem e o Adobe Experience Platform.
Este tutorial guiará você pelas etapas para criar uma conexão básica para Amazon S3 (a seguir designado por "S3") usando o Flow Service API.
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 um S3 armazenamento usando o Flow Service API.
A fim de Flow Service para se conectar com o seu S3 armazenamento, você deve fornecer valores para as seguintes propriedades de conexão:
Credencial | Descrição |
---|---|
s3AccessKey |
A ID da chave de acesso do S3 balde. |
s3SecretKey |
A ID da chave secreta para o S3 balde. |
serviceUrl |
(Opcional) A janela personalizada S3 terminal ao qual se conectar. Esse campo é obrigatório quando seu S3 O bucket é específico da região. O formato para serviceUrl é: https://s3.{REGION}.amazonaws.com/) . |
bucketName |
A variável S3 contém seus dados e os metadados descritivos correspondentes. Seu S3 o nome do bucket deve ter entre três e 63 caracteres e deve começar e terminar com uma letra ou um número. O nome do bucket só pode ter letras minúsculas, números ou hifens (- ) e não podem ser formatados como um endereço IP. |
folderPath |
O caminho para a pasta no seu S3 bucket onde seus dados são armazenados. Essa credencial é necessária quando o usuário tem acesso restrito. |
s3SessionToken |
(Opcional) Um token temporário de curto prazo que permite fornecer acesso temporário ao S3 recursos para usuários em ambientes não confiáveis. Consulte a S3 visão geral das para obter mais informações. |
connectionSpec.id |
A especificação de conexão retorna as propriedades do conector de uma origem, incluindo especificações de autenticação relacionadas à criação das conexões de base e de origem. A ID da especificação de conexão para S3 é: ecadc60c-7455-4d87-84dc-2a0e293d997b . |
Para obter mais informações sobre a introdução, visite este Amazon Web Services documento.
Para obter informações sobre como fazer chamadas para APIs da Platform com êxito, consulte o manual em introdução às APIs da Platform.
Uma conexão base retém informações entre sua origem e a Platform, incluindo as credenciais de autenticação da origem, o estado atual da conexão e sua ID de conexão base exclusiva. A ID de conexão básica permite explorar e navegar pelos arquivos de dentro da origem e identificar os itens específicos que deseja assimilar, incluindo informações sobre os tipos de dados e formatos.
Para criar um ID de conexão base, faça uma solicitação POST ao /connections
ao fornecer sua S3 credenciais de autenticação como parte dos parâmetros de solicitação.
Formato da API
POST /connections
Solicitação
A solicitação a seguir cria uma conexão básica para S3:
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 S3 base connection",
"description": "Amazon S3 base connection with temporary session token",
"auth": {
"specName": "Access Key",
"params": {
"s3AccessKey": "{S3_ACCESS_KEY}",
"s3SecretKey": "{S3_SECRET_KEY}",
"s3SessionToken": "{S3_SESSION_TOKEN}
}
},
"connectionSpec": {
"id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
"version": "1.0"
}
}'
Propriedade | Descrição |
---|---|
auth.params.s3AccessKey |
A chave de acesso associada ao seu S3 balde. |
auth.params.s3SecretKey |
A chave secreta associada à S3 balde. |
auth.params.s3SessionToken |
(Opcional) A curto prazo, as medidas S3 token usado para acessar seu bucket. |
connectionSpec.id |
A variável S3 ID da especificação de conexão: 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\""
}
Seguindo 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.
A seção a seguir fornece informações adicionais sobre o uso da variável S3 origem.
A variável s3SessionToken
é temporário e deve ser atualizado quando expirar. Você pode atualizar o token de sessão associado à sua conexão básica fazendo uma solicitação PATCH para Flow Service API. Consulte a S3 visão geral para obter mais informações sobre credenciais de segurança temporárias para S3.
A variável If-Match
o cabeçalho é necessário ao fazer uma solicitação PATCH. O valor desse cabeçalho é a tag exclusiva da conexão que você deseja atualizar.
Formato da API
PATCH /connections
Solicitação
A solicitação a seguir cria uma conexão básica para S3:
curl -X PATCH \
'https://platform.adobe.io/data/foundation/flowservice/connections/4cb0c374-d3bb-4557-b139-5712880adc55' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'If-Match: "1700d77b-0000-0200-0000-5e3b41a10000"'
-d '[
{
"op": "replace",
"path": "/auth/params/s3SessionToken",
"value": "{SESSION_TOKEN}"
}
]'
Parâmetro | Descrição |
---|---|
op |
A chamada de operação usada para definir a ação necessária para atualizar a conexão. As operações incluem: add , replace , e remove . |
path |
O caminho do parâmetro a ser atualizado. |
value |
O novo valor com o qual você deseja atualizar seu parâmetro. |
Resposta
Uma resposta bem-sucedida retorna a ID de conexão básica e uma tag atualizada. Você pode verificar a atualização fazendo uma solicitação GET para o Flow Service ao fornecer a ID da conexão.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}