Imagens de capa e de pré-visualização

O que você pode fazer

Dois endpoints de escrita controlam os PDFs que representam um flipbook antes de o leitor ter acesso completo:

• Definir o PDF de pré-visualização exibido aos leitores antes da captação de leads / do pagamento.
• Definir o PDF de imagens usado para miniaturas e prévias.

Cada chamada atua sobre um flipbook pelo seu {flipbookId} e retorna um resultado de sucesso simples.

Antes de começar

Você vai precisar de:

• Uma chave de API — enviada como cabeçalho X-Api-Key, ou como Authorization: Bearer YOUR_API_KEY, em toda requisição.
• O {flipbookId} — o ID numérico do flipbook/documento, retornado por create-by-file / create-by-url (como ID) ou por list.
• Todas as requisições vão para a URL base https://go.fliplink.me.

Ambos os endpoints recebem um corpo form-urlencoded (não JSON).

Defina o PDF de pré-visualização

PUT /api/set-preview-pdf/{flipbookId} define o PDF de pré-visualização exibido aos leitores antes da captação de leads / do pagamento. Ele é limpo automaticamente se tanto a captação de leads quanto o modo de venda estiverem desativados.

Envie a URL do PDF a usar em PreviewPDF:

• PreviewPDF — a URL do PDF a exibir como pré-visualização. O valor é armazenado como está; a API não valida se a URL está acessível (testado ao vivo), então envie uma URL de PDF válida e acessível. O padrão é vazio (nenhum PDF de pré-visualização).

curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=https://go.fliplink.me/files/preview.pdf'

Resposta:

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

Defina o PDF de imagens

PUT /api/set-image-pdf/{flipbookId} define o PDF só de imagens/pré-visualização usado para miniaturas e prévias. Envie a URL do PDF a usar em IMGPdf:

• IMGPdf — a URL do PDF só de imagens a usar para miniaturas e prévias. O valor é armazenado como está; a API não valida se a URL está acessível (testado ao vivo), então envie uma URL de PDF válida e acessível. O padrão é um placeholder sem imagem, e enviar um valor vazio mantém o PDF de imagens existente.

curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=https://go.fliplink.me/files/pages.pdf'

Resposta:

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

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 (ou Authorization: Bearer) está presente e correto.
• ID do item não encontrado ou não pertencente à sua chave → HTTP 200 com Message Item not found.
• Campo do corpo desconhecido ou digitado errado → HTTP 200 com Message Unknown field(s) '…'. Expected: ….

Notas

• Nos dois campos, o valor da URL é armazenado como está — a API não verifica se o PDF está acessível (testado ao vivo). Envie sempre uma URL de PDF válida e acessível.
• O PDF de pré-visualização (PreviewPDF) tem padrão vazio e é limpo automaticamente se tanto a captação de leads quanto o modo de venda estiverem desativados.
• O PDF de imagens (IMGPdf) tem como padrão um placeholder sem imagem; enviar um valor vazio mantém o PDF de imagens existente.