Remover uma referência de envio não utilizada

Escolha uma referência de envio não utilizada

Este endpoint remove um registro de referência de envio pertencente à sua conta. Use-o somente quando tiver certeza de que a referência não é mais necessária para a vinculação de um comprovante ou a vinculação de um documento de apoio. Ele não exclui uma identidade nem um endereço do cadastro.

Obtenha o identificador externo do arquivo na fonte original, seja ela a resposta de envio ou a lista de envios disponíveis. O controlador primeiro procura esse identificador para a sua conta e, se não o encontrar, recorre ao identificador do provedor do sistema legado. Novas integrações devem usar a referência externa exatamente como ela é retornada. Não é necessário um corpo de requisição.

Solicite a remoção de forma deliberada

Use uma conta habilitada da API da MultiTEL por HTTPS, com as credenciais e restrições de IP configuradas para ela. Use POST para que sua aplicação trate essa operação como uma alteração deliberada:

curl --silent --show-error --request POST \
  --user "$API_USER:$API_PASSWORD" \
  https://api.multitel.net/v3/delete_encrypted_file/0123456789abcdef0123456789abcdef

O controlador atual não impõe uma restrição de método HTTP: uma requisição GET também pode provocar a exclusão. Não exponha esta URL como um link comum clicável, uma imagem, um favorito ou um destino de pré-visualização ou de busca antecipada. Exija uma ação explícita de remoção na sua aplicação e não repita a tentativa automaticamente.

Interprete o resultado e suas limitações

Leia tanto o resultado HTTP quanto o campo status.code do JSON. A resposta normal em caso de sucesso é:

{
  "status": {"code": 200, "msg": "Success"},
  "response": []
}

O código 404 da API com Failed, Not found significa que nenhuma das duas buscas encontrou uma referência correspondente para esta conta. Portanto, repetir a remoção pode retornar 404. Os espaços no início e no fim do valor do caminho são removidos. Aqui não se verifica se a referência ainda está dentro do prazo de validade ou se não está sendo utilizada por outra etapa; por isso, confirme seu fluxo de trabalho antes de removê-la.

O controlador informa sucesso após tentar a exclusão no banco de dados, sem verificar se essa exclusão foi bem-sucedida. Trate a resposta como o resultado informado, e não como uma prova independente da eliminação dos dados. Se uma referência criada pela API e ainda dentro do prazo de validade estava visível em get_encrypted_files, essa lista pode ajudar a verificar se ela continua visível, mas sua ausência na lista também pode significar que o prazo de validade expirou.

A remoção não representa a eliminação completa dos dados

O controlador executa uma operação de exclusão na tabela de referências de envio. Ele não exclui explicitamente a linha que armazena o conteúdo do documento, o arquivo enviado localmente, o comprovante anexado, a identidade, o documento de apoio nem a cópia mantida pelo provedor. O comportamento das operações em cascata do banco de dados e da retenção de dados não foi verificado. Não apresente esta operação aos usuários como uma exclusão de todas as cópias de seu documento de identidade ou como o atendimento a uma solicitação de eliminação integral dos dados.

Depois que a referência local for removida, as etapas posteriores de vinculação que precisarem dela poderão falhar. Preserve os resultados das vinculações já concluídas e use o fluxo de gerenciamento de identidades ou comprovantes correspondente ao alterar as informações de cadastro enviadas.