Excluir um fluxo de dados de destino usando a API do Serviço de fluxo

Você pode excluir fluxos de dados que contêm erros ou se tornaram obsoletos usando o Flow Service API.

Este tutorial aborda as etapas para excluir fluxos de dados para destinos em lote e de transmissão usando Flow Service.

Introdução get-started

Este tutorial requer que você tenha uma ID de fluxo válida. Se você não tiver um ID de fluxo válido, selecione seu destino de escolha no catálogo de destinos e siga as etapas descritas em conectar ao destino e ativar dados 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. Você pode usar destinos para ativar seus dados conhecidos e desconhecidos para campanhas de marketing entre canais, campanhas por email, publicidade direcionada e muitos outros casos de uso.
  • Sandboxes: Experience Platform O 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 as informações adicionais que você precisará saber para excluir com êxito um fluxo de dados usando o Flow Service API.

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 cargas de solicitação formatadas corretamente. O exemplo de JSON 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 chamadas de API de exemplo no Experience Platform guia de solução de problemas.

Coletar valores para cabeçalhos obrigatórios gather-values-for-required-headers

Para fazer chamadas para Platform APIs, primeiro conclua o tutorial de autenticação. Concluir o tutorial de autenticação fornece os valores para cada um dos cabeçalhos necessários em todos os 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 as que pertencem a Flow Service, são isolados em sandboxes virtuais específicas. Todas as solicitações para Platform As APIs exigem um cabeçalho que especifique o nome da sandbox em que a operação ocorrerá:

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

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

Excluir um fluxo de dados de destino delete-destination-dataflow

Com uma ID de fluxo existente, é possível excluir um fluxo de dados de destino executando uma solicitação DELETE para Flow Service API.

Formato da API

DELETE /flows/{FLOW_ID}
Parâmetro
Descrição
{FLOW_ID}
O único id para o fluxo de dados de destino que deseja excluir.

Solicitação

curl -X DELETE \
    'https://platform.adobe.io/data/foundation/flowservice/flows/455fa81b-f290-4222-94b6-540a73e3fbc2' \
    -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 202 (Sem conteúdo) e um corpo em branco. Você pode confirmar a exclusão tentando uma solicitação de pesquisa (GET) para o fluxo de dados. A API retornará um erro HTTP 404 (Não encontrado), indicando que o fluxo de dados foi excluído.

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 para obter mais informações sobre como interpretar respostas de erro.

Próximas etapas next-steps

Ao seguir este tutorial, você usou com êxito o Flow Service API para excluir um fluxo de dados existente para um destino.

Para obter etapas sobre como executar essas operações usando a interface do usuário, consulte o tutorial em exclusão de fluxos de dados na interface.

Agora você pode continuar e excluir contas de destino usando o Flow Service API.

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