Documentação Experience Platform Guia dos conectores de origem

Explorar um banco de dados usando a API Flow Service

Última atualização: 4 de abril de 2025

Tópicos:

Criado para:

Desenvolvedor

Este tutorial usa a API Flow Service para explorar o conteúdo e a estrutura de arquivos de um banco de dados de terceiros.

Introdução

Este manual necessita de uma compreensão funcional dos seguintes componentes da Adobe Experience Platform:

Fontes: Experience Platform permite que os dados sejam assimilados de várias fontes e fornece a capacidade de estruturar, rotular e aprimorar os dados recebidos usando os serviços do Experience Platform.
Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância do Experience 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 a um banco de dados de terceiros usando a API Flow Service.

Coletar credenciais necessárias

Este tutorial requer uma conexão válida com o banco de dados de terceiros do qual você deseja assimilar dados. Uma conexão válida envolve a ID da especificação da conexão do banco de dados e a ID da conexão. Mais informações sobre como criar uma conexão de banco de dados e recuperar esses valores podem ser encontradas na visão geral dos conectores de origem.

Leitura de chamadas de API de amostra

Este tutorial fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações. Isso inclui caminhos, cabeçalhos necessários e conteúdos de solicitação formatados corretamente. Também fornece exemplos de JSON retornado nas respostas da API. 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 guia de solução de problemas Experience Platform.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para APIs do Experience Platform, primeiro complete o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todas as chamadas de API Experience Experience Platform, conforme mostrado abaixo:

Authorization: Bearer {ACCESS_TOKEN}
x-api-key: {API_KEY}
x-gw-ims-org-id: {ORG_ID}

Todos os recursos em Experience Platform, incluindo aqueles pertencentes a Flow Service, estão isolados em sandboxes virtuais específicas. Todas as solicitações para Experience Platform APIs exigem um cabeçalho que especifique o nome da sandbox 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

Explore suas tabelas de dados

Usando a ID de conexão do banco de dados, você pode explorar as tabelas de dados executando solicitações do GET. Use a chamada a seguir para localizar o caminho da tabela que você deseja inspecionar ou assimilar em Experience Platform.

Formato da API

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root

Parâmetro

Descrição

{BASE_CONNECTION_ID}

A ID de conexão da origem do banco de dados.

Solicitação

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=root' \
    -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}'

Resposta

Uma resposta bem-sucedida retorna uma matriz de tabelas do banco de dados. Encontre a tabela que você deseja trazer para Experience Platform e anote sua propriedade path, pois você deverá fornecê-la na próxima etapa para inspecionar sua estrutura.

[
    {
        "type": "table",
        "name": "test1.Mytable",
        "path": "test1.Mytable",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "test1.austin_demo",
        "path": "test1.austin_demo",
        "canPreview": true,
        "canFetchSchema": true
    }
]

Inspecionar a estrutura de uma tabela

Para inspecionar a estrutura de uma tabela do banco de dados, execute uma solicitação GET enquanto especifica o caminho de uma tabela como um parâmetro de consulta.

Formato da API

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}

Parâmetro

Descrição

{BASE_CONNECTION_ID}

A ID de uma conexão de banco de dados.

{TABLE_PATH}

O caminho de uma tabela.

Solicitação

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
    -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}'

Resposta

Uma resposta bem-sucedida retorna a estrutura da tabela especificada. Detalhes sobre cada coluna da tabela estão localizados em elementos da matriz columns.

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "TestID",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Name",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}

Próximas etapas

Seguindo este tutorial, você explorou seu banco de dados, encontrou o caminho da tabela que deseja assimilar em Experience Platform e obteve informações sobre sua estrutura. Você pode usar essas informações no próximo tutorial para coletar dados do banco de dados e trazê-los para a Experience Platform.

recommendation-more-help