Pular para o conteúdo principal
API PDF4meIntegraçõesBase de conhecimentoExtensõesTestador de APIBlog

Documento Seguro - Segurança de Documentos API

PDF4me Documento seguro Permite adicionar proteção por senha e restrições de segurança a documentos do Word com controles de segurança abrangentes e restrições de edição. API O serviço processa arquivos do Word e aplica proteção por senha aberta, restrições de edição de documentos, proteção somente leitura, acesso somente para comentários, edição de campos de formulário e controle de revisões. API recebe conteúdo de documento Word através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com controle total sobre os níveis de segurança e os requisitos de senha, essa solução é ideal para documentos confidenciais, edição colaborativa e fluxos de trabalho de controle de acesso a documentos.

Artigos relacionados no blogue
Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.
Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.
Visite o blogue →

Autenticando seu API Solicitar​

Para acessar o PDF4me REST APIPara que uma solicitação seja aceita, é necessário incluir as credenciais de autenticação adequadas. A autenticação garante a segurança da comunicação e valida sua identidade como usuário autorizado do sistema. REST API.

Get your api Key

Principais características​

  • Proteção por senhaAdicionar requisitos de senha para abrir documentos.
  • Proteção de DocumentosRestringir as capacidades de edição com vários tipos de proteção
  • Segurança somente leituraDefina os documentos como somente leitura para impedir edições não autorizadas.
  • Acesso somente para comentáriosPermitir apenas a adição ou modificação de comentários
  • Edição de campos de formulário: Restringir a edição apenas aos campos do formulário
  • Rastreamento de revisõesPermitir somente alterações e revisões rastreadas
  • Segurança CombinadaAplique proteção por senha e restrições de edição.
  • Controle de acesso flexívelNíveis de segurança diferentes para casos de uso diferentes.

REST API Ponto final​

O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de segurança de documentos são realizadas por meio de um único ponto de extremidade:

  • Método: POST
  • Ponto final: office/ApiV2Word/ApplySecurity

REST API Parâmetros​

Lista completa de parâmetros para o Documento Seguro REST APIOs parâmetros estão organizados por categoria para melhor compreensão e implementação.

Importante: Os parâmetros marcados com um asterisco (*) são obrigatórios. Os parâmetros de senha são obrigatórios quando as respectivas opções de segurança estão ativadas.

Parâmetros obrigatórios​

ParâmetroTipoDescriçãoExemplo
documento*ObjectReferência do documento. Deve conter Nome (string): Nome do arquivo do Word com extensão .docx{ "Name": "document.docx" }
conteúdo do documento*Base64Conteúdo do documento Word codificado em Base64As configurações de segurança foram aplicadas a este documento. Deve ser um documento Word válido (formatos .docx ou .doc).base64EncodedDocumentContent

Parâmetros opcionais (Configurações de segurança)​

ParâmetroTipoDescriçãoExemplo
secureOnOpenStringAtive a proteção por senha para abrir o documento. "yes" = Requer senha para abrir, "no" = Não é necessária senha para abrir (padrão). Requer senha seguraAoAbrir quando ativado"yes"
senha seguraAoAbrirStringSenha necessária para abrir o documento. Necessária quando secureOnOpen é "yes"Deve ser uma senha forte (8+ caracteres). Diferencia maiúsculas de minúsculas."SecurePass123!"
Opções de segurançaObjectOpções de proteção de documentos. Propriedades: tipo de proteção (string: NoProtection, ReadOnly, AllowComments, AllowFormFields, AllowRevisions), proteçãoSenha (string). Obrigatório quando protectionType não for "NoProtection"{ "protectionType": "ReadOnly", "protectionPassword": "EditPass456!" }

Opções de tipo de proteção​

O API Oferece diferentes tipos de proteção para restrições de edição de documentos:

Tipo de proteçãoDescriçãoCaso de uso
NoProtectionSem restrições de edição (padrão)Documentos que podem ser editados livremente
ReadOnlyEste documento não pode ser editado, apenas visualizado.Documentos finais, relatórios publicados
AllowCommentsSomente comentários podem ser adicionados/modificados.Fluxos de trabalho de revisão de documentos
AllowFormFieldsSomente os campos do formulário podem ser editados.Formulários preenchíveis, pesquisas
AllowRevisionsSomente alterações/revisões rastreadas são permitidas.Edição colaborativa com rastreamento de alterações

Configuração de segurança​

Proteção por senha (Abrir senha)​

  • PropósitoÉ necessária uma senha para abrir o documento.
  • Quando usarDocumentos confidenciais, informações sensíveis
  • Exigência: secureOnOpenPassword deve ser fornecido quando secureOnOpen é "yes"
  • ForçaRecomendado: 8 ou mais caracteres, incluindo alfanuméricos e caracteres especiais.

Proteção de Documentos (Restrições de Edição)​

  • PropósitoRestringe as capacidades de edição, mas permite a visualização do documento.
  • Quando usarEdição colaborativa, distribuição de formulários, fluxos de trabalho de revisão
  • Exigência: securityOptions.protectionPassword deve ser fornecido quando securityOptions.protectionType não é "Sem Proteção"
  • FlexibilidadePode ser combinado com senha aberta para segurança em duas camadas.

Saída​

O PDF4me Documento seguro REST API Retorna respostas diferentes dependendo do modo de processamento. API retorna o documento Word como um Base64string codificada em JSON formato, não como dados binários.

Processamento síncrono (padrão)

O API processa a solicitação e retorna:

Código de status: 200 OK

Tipo de conteúdo: application/json

Corpo da resposta:

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

Campos de resposta:

  • documento (string): O documento do Word com as configurações de segurança aplicadas, codificado como Base64 corda
  • nome_do_arquivo (string): O nome do arquivo Word de saída
  • sucesso (boolean): Indica se a solicitação foi bem-sucedida
  • mensagem de erro (string ou nulo): Detalhes do erro quando o sucesso for falso

Como usar:

  1. Extraia o document campo do JSON resposta (Base64)
  2. Decifre o Base64 string para obter os dados binários do documento Word
  3. Salve ou processe o arquivo do Word conforme necessário.
  4. O documento exigirá senha(s) ao ser aberto no Word, dependendo das configurações de segurança.

Exemplo (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes - document is password protected

Exemplo de solicitação​

Cabeçalho​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Observação:

  • Adquira o seu API chave do PDF4me Painel
  • O API a chave deve ser Base64 codificado e prefixado com "Básico" no Authorization cabeçalho
  • Exemplo: Se o seu API chave é abc123, codifique-o para Base64 e usar Authorization: Basic YWJjMTIz

Carga útil​

Exemplo básico (somente proteção por senha):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!"
}

Exemplo avançado (senha + proteção somente leitura):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!",
 "securityOptions": {
 "protectionType": "ReadOnly",
 "protectionPassword": "EditPass456!"
 }
}

Exemplo de proteção somente para comentários:

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowComments",
 "protectionPassword": "ReviewPass789!"
 }
}

Exemplo de proteção de campo de formulário:

{
 "document": { "Name": "form.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowFormFields",
 "protectionPassword": "FormPass2024!"
 }
}

Exemplos de código​

O PDF4me Documento seguro REST API Fornece exemplos de código em várias linguagens de programação. Escolha a linguagem que melhor se adapta ao seu ambiente de desenvolvimento:

C# (CSharp) Amostra

Completo C# Implementação para proteger documentos do Word:

Casos de uso e aplicações industriais​

Casos de uso de serviços jurídicos e profissionais

  • Documentos Confidenciais do ClienteAplique proteção por senha a documentos jurídicos confidenciais.
  • Segurança contratualContratos seguros com proteção de somente leitura para revisão do cliente.
  • Distribuição de Formulários LegaisAplicar proteção de campos de formulário a formulários legais.
  • Revisão de DocumentosUtilize a proteção "somente comentários" para revisão de documentos legais.

Obtenha ajuda​

Get Your API KeyAPI SamplesGetting Started