v1.0 · Disponível
API de Anonimização de Textos
Integre detecção e remoção automática de dados pessoais diretamente na sua aplicação. Envie um bloco de texto e receba de volta o conteúdo anonimizado junto com o relatório dos dados encontrados.
Visão Geral
O que é esta API
A API de Anonimização processa textos livres e substitui automaticamente dados pessoais identificados por asteriscos (*), preservando o comprimento original de cada dado removido. O processamento é assíncrono: você envia o texto, recebe um hash de rastreamento e consulta o resultado quando estiver pronto.
O resultado não é retornado imediatamente na chamada de envio. Após submeter o texto, utilize o
hash recebido para verificar o status e obter o resultado final.Autenticação
API Key via Header
Todas as requisições devem incluir o header Authorization com sua chave de API. As chaves são gerenciadas no painel do MavenDoc em Configurações → Chaves de API.
Nunca exponha sua API key em código client-side, repositórios públicos ou logs. Utilize variáveis de ambiente no servidor para armazená-la.
Créditos
Como o consumo é calculado
Cada chamada à API consome créditos da sua conta com base no volume de texto enviado.
Regra de consumo
A cada bloco de até 3.000 caracteres, é consumido 1 crédito. O cálculo é feito com arredondamento para cima:
créditos = ⌈ total_caracteres / 3000 ⌉
Fluxo de Integração
Passo a passo
Faça um POST /text/analyze com o bloco de texto no corpo da requisição. Você receberá imediatamente um hash único e o status PENDENTE.
O servidor processa o texto de forma assíncrona usando IA para identificar e classificar os dados pessoais. O tempo varia conforme o tamanho do texto.
Faça requisições periódicas ao GET /text/result/{hash} até receber "status": "FINALIZADO". Recomendamos intervalos de 2 a 5 segundos entre as tentativas.
O resultado contém o texto anonimizado (content) e a lista de dados pessoais encontrados (data_removed) com tipo e valor original.
Endpoints
Referência completa
Códigos HTTP
Respostas da API
status no corpo da resposta para saber o estado do processamento./result/{hash} não existe.Exemplos Completos
Fluxo end-to-end
Tipos de Dados Detectados
Categorias identificadas pela IA
O sistema detecta automaticamente diversas categorias de dados pessoais conforme a LGPD. Abaixo estão os tipos mais comuns retornados no campo data-type:
Este artigo foi útil?
Que bom!
Obrigado pelo seu feedback
Desculpe! Não conseguimos ajudar você
Obrigado pelo seu feedback
Feedback enviado
Agradecemos seu esforço e tentaremos corrigir o artigo