1. IronSecureDoc
  2. Tutoriais
  3. Redigir texto

How to Redact Text in C# PDF with IronSecureDoc

Curtis Chau
Curtis Chau
Atualizado:
This article was translated from English: Does it need improvement?
Translated
View the article in English

Neste artigo, discutiremos a redação de texto em um PDF usando o IronSecureDoc. Isso permite que o serviço ou processo oculte informações confidenciais de forma rápida e fácil, fazendo uma simples solicitação POST com o PDF para o servidor IronSecureDoc em execução. Iremos demonstrar isso visualmente através do uso de documentos Swagger. A solicitação POST aceita parâmetros obrigatórios e opcionais e é altamente personalizável; A resposta retorna o PDF com o texto ocultado.

Como ocultar texto em um PDF com o IronSecureDoc

  1. Baixe e inicie a imagem Docker do IronSecureDoc.
  2. Teste a API usando o Swagger.
  3. Especifique o texto a ser ocultado.
  4. Execute a chamada da API com os detalhes fornecidos.
  5. Exporte o documento PDF com as informações ocultadas.

Puxe e inicie o IronSecureDoc

Se você ainda não tem o IronSecureDoc instalado, siga os links abaixo para configurá-lo:

Hospedagem local Implantação na nuvem

A API [POST] Redact Text

O endpoint da API [POST] Redact Text permite ocultar texto sensível em um documento PDF usando redação. Essa funcionalidade é essencial para aplicações que lidam com documentos confidenciais, como contratos legais, registros médicos ou relatórios financeiros. O uso desta API garante a remoção permanente de textos específicos, proporcionando maior segurança e assegurando a conformidade com os padrões de proteção de dados.

ObserveUma vez que um texto é redigido, o conteúdo não pode ser recuperado.

Arrogância

O Swagger é uma ferramenta poderosa que permite aos desenvolvedores interagir com APIs RESTful por meio de uma interface web amigável. Independentemente de você usar linguagens como Python, Java ou outras, o Swagger oferece uma maneira prática de testar e implementar essa API.

Passos para Redigir Texto com Swagger

  1. Acesse a interface do usuário do Swagger:

    Se o seu servidor de API estiver sendo executado localmente, você pode acessar o Swagger navegando até http://localhost:8080/swagger/index.html no seu navegador web.

    Documentos Swagger

  2. Localize a API [POST] Redact Text:

    Na interface do Swagger, encontre o endpoint POST /v1/document-services/pdfs/redact-text.

    Redigir texto

  3. Especificar configurações:

    Neste exemplo, estou fornecendo tanto o arquivo PDF quanto as palavras a serem ocultadas na solicitação POST. Ocultaremos a palavra "nós" e sobreporemos uma caixa preta sobre ela. Para esta demonstração, usaremos o arquivo ' sample.pdf ' com as seguintes configurações:

    • draw_black_box: true
    • match_whole_word: true
    • words_to_redact: nós

  4. Carregar um PDF de exemplo:

    No corpo da solicitação, faça o upload de um arquivo PDF de exemplo onde você deseja aplicar a redação. Certifique-se de que o arquivo seja adicionado como pdf_file .

  5. Execute a solicitação:

    Clique em "Executar" para executar a solicitação. A resposta incluirá o PDF com as informações ocultadas. Essa interação com a interface do Swagger permite testar facilmente o processo de redação, fornecendo feedback imediato.

Utilize o comando CURL para solicitar dados através da linha de comando.

Alternativamente, podemos usar o Prompt de Comando com uma solicitação curl POST para obter o mesmo resultado.

curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
 -H 'accept: */*' \
 -H 'Content-Type: multipart/form-data' \
 -F 'pdf_file=@sample.pdf;type=application/pdf' \
 -F 'words_to_redact="we"' \
 -F 'draw_black_box=true' \
 -F 'match_whole_word=true'
curl -X POST 'http://localhost:8080/v1/document-services/pdfs/redact-text' \
 -H 'accept: */*' \
 -H 'Content-Type: multipart/form-data' \
 -F 'pdf_file=@sample.pdf;type=application/pdf' \
 -F 'words_to_redact="we"' \
 -F 'draw_black_box=true' \
 -F 'match_whole_word=true'
SHELL

Observe
Por padrão, o PowerShell pode interpretar curl como um alias para Invoke-WebRequest, um cmdlet integrado do PowerShell. Tente usar curl.exe em vez de curl. 

curl.exe --version
curl.exe --version
SHELL

)}]

Parâmetros obrigatórios no corpo da requisição

Nome Tipo de dados Descrição
arquivo_pdf application/pdf O arquivo PDF que você deseja manipular.
palavras_a_redigir array[string] Este parâmetro recebe uma lista de palavras e oculta o texto que corresponde à entrada.

Parâmetros opcionais do corpo da requisição

Nome Tipo de dados Descrição
senha_do_usuário string Isso é necessário se o PDF de entrada tiver uma senha de usuário. A operação falhará se nenhuma senha for fornecida para o PDF protegido por senha.
senha_do_proprietário string Isso é necessário se o PDF de entrada tiver uma senha de proprietário. A operação falhará se nenhuma senha for fornecida para o PDF protegido por senha.
specific_pages array[int] Permite especificar quais páginas redigir texto. Por padrão, o valor é null, significando que a palavra fornecida em todas as páginas será redigida.
draw_black_box boolean Permite especificar se deve desenhar uma caixa preta sobre o texto redigido. Por padrão, este valor é definido como True.
match_whole_word boolean Especifica se correspondências parciais dentro de palavras também devem ser redigidas. Por exemplo, se a palavra fornecida for "são", quaisquer palavras contendo "são", como "petição", terão o "são" redigido também. Por padrão, isso é definido como True.
match_case boolean Especifica se a palavra fornecida deve ser uma correspondência exata em termos de caixa. Por padrão, este valor é null. Nota: Definir isto como True significa que strings em minúsculas e maiúsculas não serão correspondidas. Por exemplo, se a palavra fornecida for "NÓS", a versão em minúsculas "nós" não seria redigida.
overlay_text string Especifica o texto de sobreposição, como palavras ou símbolos, sobre o texto ocultado. Por padrão, essa string está vazia.
salvar_como_pdfa boolean Salva o PDF modificado com conformidade PDF/A-3. Por padrão, isso é definido como False.
salvar_como_pdfua boolean Salva o PDF modificado com conformidade PDF/UA. Por padrão, isso é definido como False.

Parâmetros de cabeçalho opcionais

Nome Tipo de dados Descrição
autor string Útil para identificar você como o autor do documento PDF. Por padrão, este campo está vazio.
título string Exibe o título do documento PDF. Por padrão, este campo está vazio.
assunto string Útil para identificar o conteúdo do documento PDF rapidamente. Por padrão, este campo está vazio.

Perguntas frequentes

Como posso ocultar texto em um PDF usando uma solicitação POST?

Você pode ocultar texto em um PDF enviando uma solicitação POST para o servidor IronSecureDoc com o arquivo PDF e as palavras que deseja ocultar. O servidor processa a solicitação e retorna um PDF com o texto ocultado.

Quais são os passos para usar a API IronSecureDoc para redação de PDFs?

Para usar a API IronSecureDoc para redação de PDFs, primeiro você deve baixar e iniciar a imagem Docker do IronSecureDoc, testar a API usando o Swagger, especificar o texto a ser redigido, executar a chamada da API e, finalmente, exportar o documento PDF redigido.

Como posso testar a API IronSecureDoc antes de usá-la em produção?

Você pode testar a API IronSecureDoc usando o Swagger acessando a interface do usuário do Swagger, que permite usar os endpoints fornecidos para simular o processo de redação.

Quais parâmetros podem ser personalizados em uma solicitação de redação de PDF?

Em uma solicitação de redação de PDF, você pode personalizar parâmetros como user_password, owner_password, specific_pages, draw_black_box, match_whole_word, match_case, overlay_text, save_as_pdfa e save_as_pdfua para maior personalização.

Como faço para executar uma solicitação de redação de PDF usando curl?

Para executar uma solicitação de redação de PDF usando o curl, você pode usar um comando de solicitação POST do curl, especificando os parâmetros necessários e o caminho do arquivo no seu prompt de comando.

O que devo fazer se meu PDF estiver protegido por senha durante a redação?

Se o seu PDF estiver protegido por senha, você precisa incluir a senha do usuário ou a senha do proprietário nos parâmetros opcionais para garantir que o processo de redação possa acessar e modificar o documento.

Qual é a finalidade do parâmetro 'draw_black_box' na redação de texto?

O parâmetro 'draw_black_box' especifica se o texto ocultado deve ser coberto com uma caixa preta. Essa opção é útil para visualizar as áreas ocultadas e está ativada por padrão.

Como posso hospedar o IronSecureDoc localmente para fins de redação?

Você pode hospedar o IronSecureDoc localmente seguindo os tutoriais fornecidos para diversos sistemas operacionais, como Windows, Mac ou Linux, permitindo que você gerencie o processo de redação em seu servidor local.

É possível ocultar páginas específicas em um PDF?

Sim, você pode especificar quais páginas ocultar usando o parâmetro 'specific_pages', que permite selecionar áreas específicas do documento para ocultação.

Posso sobrepor texto em áreas ocultadas em um PDF?

Sim, você pode sobrepor texto em áreas ocultadas usando o parâmetro 'overlay_text', que permite substituir o texto ocultado por uma mensagem personalizada ou um marcador de posição.

O IronSecureDoc é compatível com o .NET 10 e suas bibliotecas de cliente?

Sim, o IronSecureDoc fornece um cliente .NET através do pacote NuGet IronSoftware.SecureDoc.Client, e é compatível com o .NET 10, além de versões anteriores como .NET 6 a 9. Isso garante que você possa integrar a redação e as APIs relacionadas perfeitamente em aplicativos .NET 10.

Curtis Chau
Curtis Chau
  Converse agora mesmo com a equipe de engenharia.
Redator Técnico

Curtis Chau é bacharel em Ciência da Computação (Universidade Carleton) e se especializa em desenvolvimento front-end, com experiência em Node.js, TypeScript, JavaScript e React. Apaixonado por criar interfaces de usuário intuitivas e esteticamente agradáveis, Curtis gosta de trabalhar com frameworks modernos e criar manuais ...

Leia mais
Pronto para começar?
Versão: 2024.10 just released
Still Scrolling Icon

Ainda está rolando a tela?

Quer provas rápidas?
executar um exemplo Veja seu PDF ser criptografado.