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

Destinations são integrações pré-criadas com plataformas de destino que permitem a ativação contínua de dados do Adobe Experience Platform. Você pode usar destinos para ativar seus dados conhecidos e desconhecidos para campanhas de marketing entre canais, campanhas por email, anúncios direcionados e muitos outros casos de uso.

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

OBSERVAÇÃO

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

Introdução

Este tutorial requer 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 o destino escolhido na catálogo de destinos e siga as etapas descritas em conectar-se ao destino antes de tentar este tutorial.

Este tutorial também requer 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. Você pode usar destinos para ativar seus dados conhecidos e desconhecidos para campanhas de marketing entre canais, campanhas por email, anúncios direcionados e muitos outros casos de uso.
  • Sandboxes: Experience Platform fornece sandboxes virtuais que particionam uma única 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 o Flow Service API.

Lendo exemplos de chamadas de API

Este tutorial fornece exemplos de chamadas de API para demonstrar como formatar suas solicitações do . Isso inclui caminhos, cabeçalhos necessários e cargas de solicitação formatadas corretamente. O JSON de exemplo retornado nas respostas da API também é fornecido. 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 exemplos de chamadas de API no Experience Platform guia de solução de problemas.

Coletar valores para cabeçalhos necessários

Para fazer chamadas para Platform As APIs devem ser concluídas primeiro tutorial de autenticação. A conclusão do tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todos Experience Platform Chamadas de API, 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 os pertencentes a Flow Service, são isoladas em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifica o nome da sandbox em que a operação ocorrerá:

  • x-sandbox-name: {SANDBOX_NAME}
OBSERVAÇÃO

Se a variável x-sandbox-name não for especificado, as solicitações serão resolvidas na variável prod sandbox.

Todas as solicitações que contêm uma carga útil (POST, PUT, PATCH) exigem um cabeçalho de tipo de mídia adicional:

  • Content-Type: application/json

Encontre a ID de conexão da conta de destino que deseja excluir

OBSERVAÇÃO

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

A primeira etapa na exclusão de uma conta de destino é descobrir a ID da 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 Destinos coluna.

Selecione a conta de destino a ser excluída

Em seguida, é possível recuperar a ID da conexão da conta de destino do URL no navegador.

Recuperar ID de conexão do URL

Eliminar ligação

IMPORTANTE

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 garantir que nenhum fluxo de dados exista para a conta de destino, execute uma solicitação de DELETE para a Flow Service API.

Formato da API

DELETE /connections/{CONNECTION_ID}
Parâmetro Descrição
{CONNECTION_ID} O único id para a conexão que 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 (Not Found), indicando que a conta de destino foi excluída.

Tratamento de erros da API

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

Próximas etapas

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

Nesta página