Metadados, URL personalizada e publicação

O que você pode fazer

Estes quatro endpoints controlam como um flipbook se apresenta — seu título e metadados de SEO, seu estado de publicação, sua URL de compartilhamento e o visual da experiência de leitura. Cada um atua sobre um único flipbook pelo seu {flipbookId}:

• Definir o título e o meta de SEO — Title, Description, TitleColor e a flag IsPublished.
• Publicar ou despublicar sem mexer no título ou na descrição.
• Dar a ele um slug personalizado para a URL de compartilhamento.
• Configurar a aparência da página do visualizador — profundidade das páginas e tipo de capa.

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, retornado por create-by-file / create-by-url (como ID) ou por list. Todos os quatro endpoints abaixo o usam como parâmetro de caminho.
• Todas as requisições vão para a URL base https://go.fliplink.me.
• Todo corpo de requisição aqui é form-urlencoded (não JSON) — envie cada campo com --data-urlencode.

Defina o título e o meta de SEO

PUT /api/set-meta/{flipbookId} define o título e o meta de SEO do flipbook — Title, Description, TitleColor e a flag IsPublished. Isso sobrescreve Title/Description/TitleColor. Para mudar somente o estado de publicação, use set-published (abaixo). TitleColor recebe uma cor hexadecimal com o # inicial (por exemplo, #1a1a1a; padrão #000000) e é armazenada como está.

curl -X PUT 'https://go.fliplink.me/api/set-meta/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=Spring 2026 Catalog' \
  --data-urlencode 'Description=Our latest product lineup and pricing' \
  --data-urlencode 'IsPublished=true'

Resposta:

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

Publique ou despublique

PUT /api/set-published/{flipbookId} altera SOMENTE a flag de publicação, deixando Title/Description/TitleColor intactos (ao contrário de set-meta). Use-o para (re)publicar um flipbook — por exemplo, um que voltou despublicado de create-by-file. IsPublished é obrigatório: true/1 = publicar, false/0 = despublicar.

curl -X PUT 'https://go.fliplink.me/api/set-published/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPublished=true'

Resposta:

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

Defina uma URL personalizada

PUT /api/set-custom-url/{flipbookId} define o slug personalizado da URL de compartilhamento do flipbook por meio do campo CustomURL. O slug precisa ser único — um slug em uso retorna Result: "ERROR" (veja os erros abaixo).

curl -X PUT 'https://go.fliplink.me/api/set-custom-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=spring-catalog'

Resposta:

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

Defina a aparência da página

PUT /api/set-page-appearance/{flipbookId} configura a aparência da página do visualizador. Este endpoint expõe atualmente apenas dois campos configuráveis: PageDepth (aceita flat, thin ou thick) e CoverType (aceita soft ou hard). Os valores são armazenados literalmente; itens mais antigos podem reportar outros valores (por exemplo, regular, ou o numérico 1) quando lidos de volta via Get one.

curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'

Resposta:

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

Erros possíveis

Estes erros se aplicam aos quatro endpoints (o de URL personalizada adiciona um próprio):

• 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 { "Result": "ERROR", "Message": "Item not found" }.
• URL personalizada já em uso (só no set-custom-url) → HTTP 200 com { "Result": "ERROR", "Message": "This custom URL is already in use. Please choose another." }.
• Campo do corpo desconhecido ou digitado errado → HTTP 200 com Message: "Unknown field(s) '…'. Expected: …".

Uma regra prática: Result: "OK" significa que a mudança foi aplicada; Result: "ERROR" significa que não foi — leia a Message para saber o motivo.

Notas

• set-meta vs set-published: set-meta sobrescreve Title/Description/TitleColor, então, se você só quiser mudar o estado de publicação, use set-published — ele deixa esses campos intactos.