Criar uma conexão de origem FTP usando a API Flow Service

OBSERVAÇÃO

O conector FTP está em beta. Os recursos e a documentação estão sujeitos a alterações. Consulte a Visão geral das fontes para obter mais informações sobre o uso de conectores marcados com beta.

Este tutorial usa a API Flow Service para guiá-lo pelas etapas para conectar Experience Platform a um servidor FTP (File Transfer Protocol).

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 servidor FTP usando a API Flow Service.

Reunir credenciais obrigatórias

Para que Flow Service se conecte ao FTP, é necessário fornecer valores para as seguintes propriedades de conexão:

Credencial Descrição
host O nome ou endereço IP associado ao servidor FTP.
username O nome de usuário com acesso ao servidor FTP.
password A senha do servidor FTP.

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:

  • 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

Criar uma conexão

Uma conexão especifica uma fonte e contém suas credenciais para essa fonte. Somente uma conexão é necessária por conta FTP, pois pode ser usada para criar vários conectores de origem para trazer dados diferentes.

Criar uma conexão FTP usando autenticação básica

Para criar uma conexão FTP usando autenticação básica, faça uma solicitação POST para a API Flow Service, fornecendo valores para os host, userName e password da sua conexão.

Formato da API

POST /connections

Solicitação

Para criar uma conexão FTP, 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 FTP é fb2e94c9-c031-467d-8103-6bd6e0a432f2.

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": "FTP connector with password",
        "description": "FTP connector password",
        "auth": {
            "specName": "Basic Authentication for FTP",
            "params": {
                "host": "{HOST}",
                "userName": "{USERNAME}",
                "password": "{PASSWORD}"
            }
        },
        "connectionSpec": {
            "id": "fb2e94c9-c031-467d-8103-6bd6e0a432f2",
            "version": "1.0"
        }
    }'
Propriedade Descrição
auth.params.host O nome do host do servidor FTP.
auth.params.username O nome de usuário associado ao servidor FTP.
auth.params.password A senha associada ao servidor FTP.
connectionSpec.id A ID da especificação da conexão do servidor FTP: fb2e94c9-c031-467d-8103-6bd6e0a432f2

Resposta

Uma resposta bem-sucedida retorna o identificador exclusivo (id) da conexão recém-criada. Essa ID é necessária para explorar o servidor FTP no próximo tutorial.

{
    "id": "bf367b0d-3d9b-4060-b67b-0d3d9bd06094",
    "etag": "\"1700cc7b-0000-0200-0000-5e3b3fba0000\""
}

Próximas etapas

Ao seguir este tutorial, você criou uma conexão FTP usando a API Flow Service e obteve o valor de ID exclusivo da conexão. Você pode usar essa ID de conexão para explorar armazenamentos em nuvem usando a API do Serviço de Fluxo ou assimilar dados do Parquet usando a API do Serviço de Fluxo.

Nesta página

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free