Proteger um flipbook com senha

Controle de acesso

Ative ou desative a proteção por senha de um flipbook e personalize a tela de senha — o título, o placeholder do campo e o botão — com uma única chamada de API.

APIs usadas nesta discussão

PUTSet Password Access/api/set-password-access/{flipbookId}

Algo impreciso ou desatualizado neste guia?

O que você pode fazer

A proteção por senha coloca uma barreira na frente de um flipbook: os leitores precisam digitar a senha correta antes de o conteúdo carregar. Com uma chamada de API você pode:

Ativar a proteção e definir a senha de acesso.
Desativar a proteção de novo.
Personalizar a tela de senha — o título, o placeholder do campo e o rótulo do botão.

Antes de começar

Você vai precisar de:

Uma chave de API — enviada como cabeçalho X-Api-Key em toda requisição.
O flipbookId — o id numérico retornado quando você cria um flipbook (como ID) ou vindo dos endpoints de listagem.
As requisições vão para a URL base https://go.fliplink.me.

O corpo é form-urlencoded (não JSON).

Parâmetros

Envie estes como campos urlencoded em PUT /api/set-password-access/{flipbookId}:

Campo	Tipo	O que faz
`IsPasswordProtected`	boolean	`true` ativa a barreira de senha; `false` a desativa
`Password`	text	A senha de acesso que os leitores precisam digitar
`PwdTitle`	text	Título mostrado na tela de senha (opcional)
`PwdPlaceholder`	text	Texto de placeholder dentro do campo de senha (opcional)
`PwdButton`	text	Rótulo do botão de envio (opcional)

Ative a proteção por senha

Defina IsPasswordProtected=true e informe a Password. Os três campos Pwd* são opcionais — inclua-os para personalizar o que o leitor vê.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=true' \
  --data-urlencode 'Password=spring-2026' \
  --data-urlencode 'PwdTitle=Enter the access code' \
  --data-urlencode 'PwdPlaceholder=Access code' \
  --data-urlencode 'PwdButton=View document'

Resposta:

{ "Result": "OK", "Message": "Updated successfully" }

Desative a proteção por senha

Defina IsPasswordProtected=false. Você pode deixar os outros campos vazios.

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=' \
  --data-urlencode 'PwdTitle=' \
  --data-urlencode 'PwdPlaceholder=' \
  --data-urlencode 'PwdButton='

Resposta:

{ "Result": "OK", "Message": "Updated successfully" }

Personalizando a tela de senha

Os campos PwdTitle, PwdPlaceholder e PwdButton permitem adaptar a barreira ao seu público — por exemplo, chamando-a de "código de acesso" para um portal de cliente, ou combinando com o tom da sua marca. Eles são opcionais; omita-os (ou envie-os vazios) para usar os padrões.

Erros possíveis

Chave de API ausente ou inválida → HTTP 401. Isso retorna uma página HTML de Unauthorized simples — não há corpo JSON. Confira se o cabeçalho X-Api-Key está presente e correto.
flipbookId desconhecido (ou que não pertence à sua chave) → HTTP 200 com { "Result": "ERROR", "Message": "Item not found" }.
Campo do corpo digitado errado → HTTP 200 com { "Result": "ERROR", "Message": "Unknown field(s) '…'. Expected: …" }. Confira os nomes dos campos na tabela acima.

Notas

Compartilhe a senha por outro canal. Envie o link do flipbook e a senha por canais separados — uma senha incluída no mesmo e-mail que o link oferece pouca proteção.
A proteção por senha é uma camada só. Ela controla a entrada, não quem é o leitor. Para restringir o acesso a pessoas indicadas, combine-a com uma lista de e-mails permitidos; para limitar o acesso por tempo, junte-a à expiração do link.

Discussões relacionadas

Gerenciar a lista de e-mails permitidos de um flipbook Controlar a indexação em buscadores (noindex)