Excluir uma conta de destino usando a API de Serviço de Fluxo

Destinations são integrações pré-construídas com plataformas de destino que permitem a ativação perfeita de dados da Adobe Experience Platform. É possível usar destinos para ativar seus dados conhecidos e desconhecidos para campanhas de marketing entre canais, campanhas de email, publicidade direcionada e muitos outros casos de uso.

Antes de ativar os dados, você precisa se conectar ao destino configurando primeiro uma conta de destino. Este tutorial aborda as etapas para excluir contas de destino que não são mais necessárias usando a Flow Service API.

NOTE
No momento, a exclusão de contas de destino é permitida somente na API de Serviço de Fluxo. As contas de destino não podem ser excluídas usando a interface do usuário do Experience Platform.

Introdução get-started

Este tutorial requer que você tenha uma ID de conexão válida. A ID de conexão representa a conexão da conta com o destino. Se você não tiver uma ID de conexão válida, selecione seu destino escolhido no catálogo de destinos e siga as etapas descritas para conectar-se ao destino antes de tentar este tutorial.

Este tutorial também requer que você tenha uma compreensão funcional dos seguintes componentes do Adobe Experience Platform:

  • Destinos: Destinations são integrações pré-criadas com plataformas de destino que permitem a ativação contínua de dados do Adobe Experience Platform. É possível usar destinos para ativar seus dados conhecidos e desconhecidos para campanhas de marketing entre canais, campanhas de email, publicidade direcionada e muitos outros casos de uso.
  • Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única instância do 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 excluir com êxito uma conta de destino usando a API Flow Service.

Leitura de chamadas de API de amostra reading-sample-api-calls

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 gather-values-for-required-headers

Para fazer chamadas para APIs do 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 da 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 Platform APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Se o cabeçalho x-sandbox-name não for especificado, as solicitações serão resolvidas na sandbox prod.

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

Localize a ID de conexão da conta de destino que você deseja excluir find-connection-id

NOTE
Este tutorial usa o Destino da aeronave como exemplo, mas as etapas descritas se aplicam a qualquer um dos destinos disponíveis.

A primeira etapa ao excluir uma conta de destino é descobrir a ID de conexão que corresponde à conta de destino que você deseja excluir.

Na interface do usuário do Experience Platform, navegue até Destinos > Contas e selecione a conta que deseja excluir selecionando o número na coluna Destinos.

Selecione a conta de destino a ser excluída

Em seguida, você pode recuperar a ID de conexão da conta de destino da URL no navegador.

Recuperar ID de conexão da URL

Excluir conexão delete-connection

IMPORTANT
Antes de excluir a conta de destino, você deve excluir todos os fluxos de dados existentes para a conta de destino.
Para excluir fluxos de dados existentes, consulte as páginas abaixo:

Depois de ter uma ID de conexão e verificar se não há fluxos de dados para a conta de destino, execute uma solicitação DELETE para a API Flow Service.

Formato da API

DELETE /connections/{CONNECTION_ID}
Parâmetro
Descrição
{CONNECTION_ID}
O valor id exclusivo da conexão que você deseja excluir.

Solicitação

curl -X DELETE \
    'https://platform.adobe.io/data/foundation/flowservice/connections/c8622ec7-7d94-44a5-a35a-ffcc6bdcc384' \
    -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 o status HTTP 204 (Sem conteúdo) e um corpo em branco. Você pode confirmar a exclusão tentando uma solicitação de pesquisa (GET) para a conexão. A API retornará um erro HTTP 404 (Não encontrado), indicando que a conta de destino foi excluída.

Manipulação de erros de API api-error-handling

Os endpoints de API neste tutorial seguem os princípios gerais de mensagem de erro da API Experience Platform. Consulte códigos de status da API e erros no cabeçalho da solicitação no guia de solução de problemas da Platform.

Próximas etapas

Ao seguir este tutorial, você usou com êxito a API Flow Service para excluir contas de destino existentes. Para obter mais informações sobre o uso de destinos, consulte a visão geral sobre destinos.

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6