Páginas de capa, expiração do link e fixação

O que você pode fazer

Estes cinco endpoints permitem gerenciar as páginas de capa de um flipbook, a expiração do link e se ele está fixado — sem tocar no painel:

• Anexar páginas de capa da frente e/ou do verso a partir de um arquivo PDF enviado.
• Anexar páginas de capa da frente e/ou do verso a partir de uma URL de PDF remota.
• Remover o envoltório de frente/verso, restaurando o flipbook ao seu PDF principal sem envoltório.
• Definir ou remover uma autoexpiração no flipbook.
• Fixar ou desafixar o flipbook para que ele fique no topo do seu painel.

Antes de começar

• Uma chave de API — enviada como cabeçalho X-Api-Key, ou como Authorization: Bearer YOUR_API_KEY, em toda requisição.
• Todo endpoint aqui recebe o parâmetro de caminho {flipbookId} — o ID numérico do flipbook, retornado por create-by-file / create-by-url (como ID) ou por list. Os exemplos abaixo usam 96216.
• Todas as requisições vão para a URL base https://go.fliplink.me.
• Os endpoints de página de capa por URL e set-expiry enviam um corpo form-urlencoded (não JSON). O endpoint de página de capa por arquivo envia multipart form-data (uploads de arquivo). Os endpoints clear e pin não recebem corpo.

Defina páginas de capa da frente/verso a partir de um arquivo

Anexe páginas de capa e/ou do verso a partir de arquivos PDF enviados. Front/Back são ambos opcionais — pelo menos um é obrigatório. As páginas são mescladas de novo com o PDF principal existente.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

Resposta:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Defina páginas de capa da frente/verso a partir de uma URL

A variante por URL do endpoint acima — anexa páginas de capa/verso a partir de uma URL de PDF remota em vez de um arquivo enviado. Os campos Front e Back são enviados form-urlencoded.

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

Resposta:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Remova as páginas de capa da frente/verso

Remove o envoltório de frente/verso, restaurando FilePDF ao PDF principal sem envoltório (MiddlePDF). É idempotente — um flipbook sem envoltório retorna OK e não muda nada. A resposta inclui a URL do S3 do PDF principal restaurado. Objetos S3 antigos mesclados/da frente/do verso não são excluídos. Não recebe corpo.

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

Resposta:

{
  "Result": "OK",
  "Message": "Pages updated successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

Defina ou remova a expiração

Define ou remove a autoexpiração de um flipbook. Envie Days e Hours como inteiros. Hours é opcional e tem padrão 0. Enviar Days=-1, Hours=0 remove a expiração por completo.

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

Resposta:

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

Para remover a expiração, envie Days=-1:

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=-1' \
  --data-urlencode 'Hours=0'

Fixe ou desafixe

Fixa ou desafixa o flipbook (o estado com estrela) para que ele fique no topo do seu painel. É um toggle e não recebe corpo.

curl -X PUT 'https://go.fliplink.me/api/set-pin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

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 está presente e correto.
• flipbookId desconhecido (ou que não pertence à sua chave) → HTTP 200 com "Message": "Item not found".
• Set front/back page (arquivo) — PDF inválido → HTTP 200 com "Message": "File is not a valid PDF." quando o arquivo enviado não é um PDF legível.
• Set front/back page (arquivo) — arquivo grande demais → HTTP 413 com "Message": "File exceeds the maximum allowed upload size." quando o upload excede o tamanho máximo de arquivo do plano.
• Set front/back page (URL) e Set expiry — campo desconhecido → HTTP 200 com "Message": "Unknown field(s) '…'. Expected: …" quando um campo do corpo está digitado errado ou não é reconhecido.