Explore um sistema de automação de marketing usando a API Flow Service

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 explorar os sistemas de automação de marketing.

Introdução

Este guia exige uma compreensão prática dos seguintes componentes do Adobe Experience Platform:

Fontes: Experience Platform permite que os dados sejam ingeridos de várias fontes e, ao mesmo tempo, fornece a você a capacidade de estruturar, rotular e aprimorar os dados recebidos usando Platform serviços.
Caixas de proteção: Experience Platform fornece caixas de proteção virtuais que particionam uma única Platform instância em ambientes virtuais separados para ajudar a desenvolver e 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 sistema de automação de marketing usando a API Flow Service.

Reunir credenciais obrigatórias

Este tutorial requer uma conexão válida com o aplicativo de automação de marketing de terceiros do qual você deseja assimilar dados. Uma conexão válida envolve a ID de especificação de conexão e a ID de conexão do aplicativo. Para obter mais informações sobre como criar uma conexão de automação de marketing e recuperar esses valores, consulte o tutorial conectar uma fonte de automação de marketing ao Platform.

Lendo chamadas de exemplo da API

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.

Reunir valores para cabeçalhos necessários

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:

Autorização: Portador {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:

Tipo de conteúdo: application/json

Explore suas tabelas de dados

Usando a conexão básica para seu sistema de automação de marketing, você pode explorar suas tabelas de dados realizando solicitações de GET. Use a chamada a seguir para localizar o caminho da tabela que deseja inspecionar ou assimilar em Platform.

Formato da API

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

Parâmetro	Descrição
`{BASE_CONNECTION_ID}`	A ID da conexão básica para seu sistema de automação de marketing.

Solicitação

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=root' \
    -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}'

Resposta

Uma resposta bem-sucedida é uma matriz de tabelas de acordo com seu sistema de automação de marketing. Encontre a tabela que deseja trazer para Platform e anote sua propriedade path, conforme necessário na próxima etapa para inspecionar sua estrutura.

[
    {
        "type": "table",
        "name": "Hubspot.All_Deals",
        "path": "Hubspot.All_Deals",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Blog_Authors",
        "path": "Hubspot.Blog_Authors",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Blog_Comments",
        "path": "Hubspot.Blog_Comments",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Contacts",
        "path": "Hubspot.Contacts",
        "canPreview": true,
        "canFetchSchema": true
    },
]

Inspect a estrutura de uma tabela

Para inspecionar a estrutura de uma tabela do seu sistema de automação de marketing, execute uma solicitação de GET enquanto especifica o caminho de uma tabela como um parâmetro de query.

Formato da API

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

Parâmetro	Descrição
`{BASE_CONNECTION_ID}`	A ID de conexão do seu sistema de automação de marketing.
`{TABLE_PATH}`	O caminho de uma tabela dentro do seu sistema de automação de marketing.

Solicitação

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=table&object=Hubspot.Contacts' \
    -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}'

Resposta

Uma resposta bem-sucedida retorna a estrutura de uma tabela. Os detalhes referentes a cada coluna da tabela estão localizados em elementos da matriz columns.

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "Properties_Firstname_Value",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Properties_Lastname_Value",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Added_At",
                "type": "string",
                "meta:xdmType": "date-time",
                "xdm": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            {
                "name": "Portal_Id",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
        ]
    }
}

Próximas etapas

Ao seguir este tutorial, você explorou seu sistema de automação de marketing, encontrou o caminho da tabela que deseja trazer para Platform e obteve informações sobre sua estrutura. Você pode usar essas informações no próximo tutorial para coletar dados do seu sistema de automação de marketing e trazê-los para a Plataforma.