1. IronSecureDoc
  2. Tutoriais
  3. API REST para IronSecureDoc

REST API for IronSecureDoc in C#

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

Esta é a Referência da API REST para sua instância do IronSecureDoc. Este tutorial pressupõe que você já tenha uma instância de contêiner em execução. Se você deseja começar, siga nosso guia.

Ir para as funcionalidades:

Pontas

  • O espaço reservado http://localhost:8080/ será usado para o URL em todos os exemplos. Certifique-se de substituir pelo seu URL.
  • Certifique-se de substituir os valores de espaço reservado (por exemplo, path/to/your/file.pdf, certificate_password, etc.) por valores reais.
  • Os cabeçalhos author, title e subject estão incluídos em todos os exemplos de solicitação.
    )}]

[OBTER] Verificação de saúde

Endpoint: http://localhost:8080/v1/document-services/ping

Ponto de extremidade de verificação de integridade para verificar se o servidor está em execução.

Resposta: 200 OK: pong

[OBTER] Verificar Licença

Endpoint: http://localhost:8080/v1/document-services/check-license

Verifica a validade da licença.

Resposta: 200 OK: Valid

[POSTAGEM] Redigir texto

Endpoint: http://localhost:8080/v1/document-services/pdfs/redact-text

Oculta palavras sensíveis em um documento em formato PDF usando redação verdadeira. Inclua um arquivo PDF como um objeto pdf_file no corpo da solicitação.

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

Nome Tipo de dados Descrição
`pdf_file` aplicativo/arquivo pdf O arquivo PDF a ser editado.
`words_to_redact` array[string] Uma série de palavras a serem omitidas do documento.

Perguntas frequentes

Qual é a finalidade da API REST do IronSecureDoc?

A API REST do IronSecureDoc foi projetada para ajudar desenvolvedores a proteger e gerenciar documentos PDF, fornecendo funcionalidades como redação de texto, aplicação de assinatura digital, criptografia de documentos e verificação de senha.

Como posso garantir que meu servidor esteja operacional usando a API IronSecureDoc?

Você pode verificar se o seu servidor está operacional enviando uma solicitação GET para o endpoint `/v1/document-services/ping`. Se a solicitação for bem-sucedida, o servidor responderá com o status `200 OK` e a mensagem `pong`.

Como faço para ocultar texto ou padrões específicos em um PDF usando a API?

Você pode ocultar textos ou padrões específicos em um PDF enviando uma solicitação POST para o endpoint `/v1/document-services/pdfs/redact-text` com o PDF e o texto ou expressões regulares que deseja ocultar.

Como posso verificar se as assinaturas digitais de um PDF são válidas?

Para verificar assinaturas digitais em um PDF, você pode enviar uma solicitação POST para o endpoint `/v1/document-services/pdfs/verify-signatures` com o arquivo PDF. A API retornará informações sobre a validade de cada assinatura.

Quais são os passos envolvidos na criptografia de um PDF usando a API IronSecureDoc?

Para criptografar um PDF, envie uma solicitação POST para o endpoint `/v1/document-services/pdfs/encrypt` com o arquivo PDF, especificando as senhas de usuário e proprietário e quaisquer permissões que você deseje definir, como extração de conteúdo ou preenchimento de formulários.

Como posso assinar digitalmente um documento PDF usando a API IronSecureDoc?

Você pode assinar digitalmente um PDF enviando uma solicitação POST para o endpoint `/v1/document-services/pdfs/certify` com o arquivo PDF, um certificado digital e a senha do certificado.

Quais opções estão disponíveis para proteger documentos PDF?

As opções para proteger PDFs incluem criptografar o documento, definir permissões de acesso, adicionar senhas de usuário e proprietário e verificar senhas existentes usando a API do IronSecureDoc.

É possível extrair texto de um PDF usando a API IronSecureDoc?

Sim, você pode extrair texto de um PDF enviando uma solicitação POST para o endpoint `/v1/document-services/pdfs/extract`. Você pode especificar parâmetros para extrair texto de páginas específicas ou do documento inteiro.

Como faço para verificar as senhas de um documento PDF?

Para verificar senhas, envie uma solicitação POST para o endpoint `/v1/document-services/pdfs/verify-password` com o arquivo PDF. Inclua as senhas do usuário e do proprietário na sua solicitação para confirmar a validade delas.

Quais são as principais funcionalidades da API REST do IronSecureDoc?

As principais funcionalidades da API REST do IronSecureDoc incluem verificação da integridade do servidor, verificação de licença, redação de texto, aplicação de assinatura digital, criptografia de PDF e extração de texto.

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 acaba de ser lançado
Still Scrolling Icon

Ainda está rolando a tela?

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