Adicionar chamadas para ação a um flipbook

O que você pode fazer

O visualizador de um flipbook pode exibir botões de chamada para ação (CTA) que levam os leitores a um destino que você escolhe. Três endpoints permitem configurá-los pela API:

• Definir o botão de CTA primário — seu rótulo, URL, cor e se ele é exibido.
• Definir o botão de CTA secundário — um segundo botão que usa os campos com sufixo 2.
• Definir as regras de pré-visualização — controlar se a CTA fica oculta enquanto o leitor está na pré-visualização.

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.
• O flipbookId — o ID numérico do flipbook que você quer configurar (parâmetro de caminho nos três endpoints). Ele é 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.
• O corpo da requisição é form-urlencoded (não JSON) nos três endpoints — envie cada campo com --data-urlencode.

Defina o botão de CTA primário

Configura o botão de chamada para ação primário no visualizador (rótulo, URL, cor). Os campos são IsCTAButton, CTAButtonText, CTAButtonURL (além dos campos de cor) — não Text/URL/Position. Um valor de CTAButtonURL com prefixo mailto: / tel: é normalizado automaticamente no lado do servidor.

curl -X PUT 'https://go.fliplink.me/api/set-cta-primary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton=false' \
  --data-urlencode 'CTAButtonText=' \
  --data-urlencode 'CTAButtonColor=' \
  --data-urlencode 'CTAButtonURL=' \
  --data-urlencode 'CTAButtonTextColor='

Resposta:

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

Defina o botão de CTA secundário

Configura o botão de chamada para ação secundário no visualizador. O botão secundário usa os campos com sufixo 2 — IsCTAButton2, CTAButtonText2, CTAButtonURL2 (além dos campos de cor com sufixo 2).

curl -X PUT 'https://go.fliplink.me/api/set-cta-secondary/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAButton2=false' \
  --data-urlencode 'CTAButtonText2=' \
  --data-urlencode 'CTAButtonColor2=' \
  --data-urlencode 'CTAButtonTextColor2=' \
  --data-urlencode 'CTAButtonURL2='

Resposta:

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

Defina as regras de pré-visualização

Configura quando a chamada para ação é exibida aos leitores — a regra da barreira de pré-visualização. Envie IsCTAHiddenInPreview para controlar se a CTA fica oculta enquanto o leitor está na pré-visualização.

curl -X PUT 'https://go.fliplink.me/api/set-cta-preview-rules/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsCTAHiddenInPreview=false'

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: …". Confira a grafia exata do campo (por exemplo, os campos com sufixo 2 do botão secundário).

Notas

• Os três endpoints compartilham o mesmo parâmetro de caminho {flipbookId} e o mesmo formato de sucesso { "Result": "OK", "Message": "Updated successfully" }.
• Os botões primário e secundário são configurados de forma independente — o endpoint secundário só aceita os nomes de campo com sufixo 2.