POST Protect file

Changed on

Este endpoint permite proteger um arquivo PDF com uma senha, impedindo sua visualização por pessoas não autorizadas. Após a aplicação da senha, o documento só poderá ser aberto mediante a inserção da senha definida no momento da solicitação.

Atenção: na prática as duas senhas precisam ser enviadas juntas: com apenas uma delas a API responde erro interno (500) atualmente. A proteção gera um novo arquivo físico (o file_name muda) e é registrada no histórico do documento.

post/api/files/protect

Request

  • Base URL
    https://app.plugsign.com.br
  • URL
    https://app.plugsign.com.br/api/files/protect
  • Auth
    API key in header Authorization

Request body

pass_ownerstring required

Senha do proprietário (permissões totais). Envie junto com pass_user.

pass_userstring required

Senha de abertura do documento. Envie junto com pass_owner.

document_keystring required

Document key do arquivo.

Response

200

messagestring

Mensagem de confirmação retornada pela API.

Example response

{
  "message": "Senha criada"
}

Changes

    • breaking

      the request property became required

    • breaking

      the request property became required

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status