Criptografar documento PDF API
PDF4me Proteger Documento é um endpoint REST que protege um PDF com senha e restringe o que os destinatários podem fazer com ele. Envie o arquivo via POST em Base64 para /api/v2/Protect Com uma senha e uma permissão específica, a resposta é um novo PDF criptografado com AES. Impressão, cópia, edição e preenchimento de formulários só são permitidos se você autorizar.
O que este endpoint faz
PDF4me Proteger documento criptografa um PDF com uma senha e define sinalizadores de permissão em um único REST ligar. Enviar o PDF como Base64Escolha a senha e as ações permitidas (impressão, cópia, anotações, preenchimento de formulários) e receba uma nova AES-criptografado PDF na resposta. A criptografia aplicada é AES-128 ou AES-256 por PDF especificação, adequada para GDPR, HIPAAe outros fluxos de trabalho orientados para a conformidade.
Autenticando seu API Solicitar
Todo PDF4me REST API A chamada deve incluir o seu API chave no Authorization Crie ou selecione uma chave no painel do desenvolvedor e mantenha-a no servidor. Nunca a exponha no código do navegador.
Fatos importantes que você não deve perder
senha Os portões do campo documentam a abertura. O Permissão pdf A enumeração controla o que os usuários podem fazer depois que o documento é aberto. Use ambos juntos para enviar um PDF que exige uma senha E desativa a impressão ou a cópia.Permissão pdf está bloqueado. Defina-o para Nenhum para bloquear todas as ações, exceto a abertura, ou para uma flag específica, como Preencha os formulários. Permitir apenas o preenchimento de formulários e nada mais.REST API ponto final
Método: PUBLICAR
URL: https://api.pdf4me.com/api/v2/Protect
Enviar Tipo de conteúdo: application/json e um Autorização cabeçalho com o seu API chave. Definir assíncrono para falso para uma resposta síncrona (HTTP 200 com o criptografado PDF como bytes binários brutos), ou verdadeiro para receber HTTP 202 mais um Localização cabeçalho que você consulta até que retorne 200 com o binário PDF.
Configuração de solicitação do Postman
| Contexto | Valor |
|---|---|
| Method | POST |
| URL | https://api.pdf4me.com/api/v2/Protect |
| Headers | Content-Type: application/json |
| Authorization | Basic Auth with your API key, or header Authorization: Basic YOUR_API_KEY |
| Body | raw JSON with docContent, docName, password, pdfPermission, and async fields |
| Response (sync) | When async is false: HTTP 200 with the encrypted PDF as raw binary bytes. Save the response body directly to a .pdf file. |
| Response (async) | When async is true: HTTP 202 with a Location header. GET that URL until you receive 200 plus the binary PDF. Useful for large files or slow networks. |
Parâmetros
Sempre necessário: conteúdo do documento, nomeDoDocumento, senha, Permissão pdf. O assíncrono A flag é opcional (o padrão é falso) e controla se a resposta é retornada imediatamente ou por meio de uma URL de sondagem.
| Parâmetro | Obrigatório | Tipo | O que faz | Exemplo |
|---|---|---|---|---|
docContent | Required | Base64 String | The source PDF file encoded as Base64 (no data: prefix). Read the file as bytes and run it through your language's Base64 encoder. | JVBERi0xLjQK... |
docName | Required | String | Filename of the source PDF including the .pdf extension. Used for tracking and the output filename. | invoice.pdf |
password | Required | String | The password applied to the encrypted PDF. Users must enter this to open the document. | Str0ng-P@ss! |
pdfPermission | Required | Enum | What the user can do once the PDF is unlocked. One of: All, None, Copy, Annotate, Fill Forms, Support Disabilities, Assemble, Digital Print. See the flag reference card grid below. | Fill Forms |
async | Optional | Boolean | Defaults to false. When false the API returns the encrypted PDF immediately as binary bytes (HTTP 200). When true the API returns HTTP 202 with a Location header; poll that URL with GET until you receive 200 with the binary PDF. Use true for large PDFs or batch processing. | false |
Qual opção de permissão para PDF devo escolher?
A senha e o sinalizador de permissão protegem contra coisas diferentes. A senha controla a abertura; o sinalizador de permissão controla o que acontece depois da abertura.
| Senhas versus permissões | password campo | pdfPermission campo |
|---|---|---|
| Protege contra | Abertura não autorizada | Ações indesejadas após a abertura |
| A quem isso afeta | Todos sem a senha | Todos que abriram o documento |
| Uso típico | Entrega confidencial | Contratos somente leitura, cópias de prova |
| Valor mais restritivo | Uma senha forte e exclusiva | None (Aberto apenas) |
TodosTudo é permitido.NenhumApenas aberturaCópiaAbra e copie texto ou imagens.AnotarAbra e faça anotações.Preencha os formulários.Abra e preencha os campos do formulário.Apoio a pessoas com deficiênciaAbrir com ferramentas de acessibilidadeMontarAlterações permitidas ao nível da páginaImpressão digitalImpressão em baixa resolução apenasSolicitar exemplos
Exemplo A: Criptografar apenas com senha (All permissões)
{
"docContent": "JVBERi0xLjQK...",
"docName": "invoice.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "All",
"async": false
}
Exemplo B: Criptografar com restrições máximas (None)
Blocos de notas para impressão, cópia, edição, anotação e preenchimento de formulários.
{
"docContent": "JVBERi0xLjQK...",
"docName": "confidential.pdf",
"password": "Str0ng-P@ss!",
"pdfPermission": "None",
"async": false
}
Exemplo C: Criptografar e permitir apenas o preenchimento do formulário
Útil para formulários de cadastro confidenciais que o destinatário deve preencher, mas não redistribuir.
{
"docContent": "JVBERi0xLjQK...",
"docName": "intake-form.pdf",
"password": "Form-2026",
"pdfPermission": "Fill Forms",
"async": true
}
Resposta bem-sucedida (sincronização, async: false)
HTTP 200 com o criptografado PDF como o corpo da resposta bruta (binária) application/pdf). Não JSON Encapsulamento. Salve os bytes da resposta diretamente em um arquivo.
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="protected.pdf"
<binary PDF bytes>
Resposta bem-sucedida (assíncrona, async: true)
HTTP 202 com um Location cabeçalho. Pesquisa que URL com GET (mesmo Authorization cabeçalho) até que você receba HTTP 200 com o binário PDF.
HTTP/1.1 202 Accepted
Location: https://api.pdf4me.com/api/v2/JobStatus/<job-id>
exemplos de curl
Modo de sincronização (salvar o corpo da resposta diretamente em um arquivo):
curl -X POST https://api.pdf4me.com/api/v2/Protect \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-o protected.pdf \
-d '{"docContent":"JVBERi0xLjQK...","docName":"invoice.pdf","password":"Str0ng-P@ss!","pdfPermission":"Fill Forms","async":false}'
Modo assíncrono (nota) -D headers.txt para capturar o Location cabeçalho para votação):
curl -X POST https://api.pdf4me.com/api/v2/Protect \
-H "Content-Type: application/json" \
-H "Authorization: Basic YOUR_API_KEY" \
-D headers.txt \
-d '{"docContent":"...","docName":"invoice.pdf","password":"Str0ng-P@ss!","pdfPermission":"Fill Forms","async":true}'
O que a API retorna?
O próprio documento criptografado. A proteção é aplicada com Criptografia AES conforme definido por Especificação em PDFAssim, qualquer leitor compatível com os padrões solicitará a senha e aplicará o sinalizador de permissão.
| Campo | Tipo | O que contém |
|---|---|---|
| Response body (HTTP 200) | Binary | The encrypted PDF bytes (Content-Type application/pdf). Write them straight to a new .pdf file; the source file is never modified. |
| Location header (HTTP 202) | String (URL) | Returned when async is true and processing continues in the background. GET this URL with the same Authorization header. |
| Poll response (HTTP 200) | Binary | The finished encrypted PDF, returned once the async job completes. |
| Poll response (HTTP 202) | Empty | Job still processing. Wait and poll the same Location URL again. |
Exemplos de código
Exemplos de integração
Padrões comuns de integração RESTTypical ways developers call Protect Document.
- Leia cada fatura. PDF de uma pasta, S3 balde ou fila de banco de dados.
- Base64-codificar os bytes e POST Para proteger com
Permissão pdfdefinido paraPreencha os formulários.. - Escreva os bytes de resposta diretamente em um arquivo .pdf (binário bruto) e, em seguida, carregue o arquivo criptografado por e-mail ou armazenamento de objetos.
- Percorra cada arquivo. O endpoint não mantém estado e é seguro para chamadas paralelas dentro do seu limite de taxa.
- POST a fonte PDF para
/api/v2/Protegercom a senha do destinatário e a permissão escolhida. - Pegue os bytes da resposta binária e recodifique-os para Base64e alimentá-los como
conteúdo do documentopara o Sinalização digital ponto final. - Receba um único PDF isso é ambos AES-Criptografado e assinado criptograficamente. À prova de adulteração para uso em casos de uso legais e de conformidade.
- Gere uma senha exclusiva para cada destinatário (UUID ou derivado de segredo compartilhado).
- POST Para proteger com essa senha e
Permissão pdfdefinido paraNenhumBloquear todas as cópias e impressões. - Envie o e-mail criptografado por e-mail. PDF e a senha por meio de um canal separado para fins de auditoria de conformidade.