Organizar flipbooks com pastas e modelos

O que você pode fazer

Estes três endpoints permitem manter seus flipbooks organizados sem tocar no painel:

• List — suas pastas, cada uma retornada como um nome e um GUID de pasta.
• Assign — atribua um flipbook a uma pasta — as pastas são criadas sob demanda, e enviar uma pasta vazia remove o flipbook da pasta dele.
• Save — salve um flipbook como modelo reutilizável, ou remova-o dos seus modelos.

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.
• Todas as requisições vão para a URL base https://go.fliplink.me.
• Os dois endpoints de escrita (assign-to-folder e save-as-template) usam um parâmetro de caminho {flipbookId} — o ID numérico do flipbook, retornado por create-by-file / create-by-url (como ID) ou por list.
• Esses endpoints de escrita recebem um corpo form-urlencoded (não JSON).

List — liste suas pastas

GET /api/list-folders lista suas pastas, cada uma como { Folder (nome), URL (um GUID de pasta) }. As pastas são derivadas das atribuições de flipbooks, então uma pasta vazia não é listada.

curl -X GET 'https://go.fliplink.me/api/list-folders' \
  -H 'X-Api-Key: YOUR_API_KEY'

Resposta:

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

Assign — atribua um flipbook a uma pasta

PUT /api/assign-to-folder/{flipbookId} move o flipbook para uma pasta. As pastas são criadas sob demanda — atribua a um nome de pasta que ainda não existe e ela é criada automaticamente (não há uma chamada separada de "criar pasta"). Os nomes de pasta podem conter / (por exemplo, Marketing/Q2). Uma pasta existe apenas enquanto houver pelo menos um flipbook nela, então mover o último flipbook para fora faz a pasta sumir do list-folders.

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'

Resposta:

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

Para remover o flipbook da pasta dele, envie um Folder vazio:

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder='

Save — salve um flipbook como modelo

PUT /api/save-as-template/{flipbookId} marca o flipbook como modelo reutilizável (Status=true) ou o remove dos modelos (Status=false). Os modelos aparecem no list-templates e podem servir de base para novos flipbooks. Status tem padrão true se omitido.

curl -X PUT 'https://go.fliplink.me/api/save-as-template/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'

Resposta:

{
  "Result": "OK",
  "Message": "Saved as template"
}

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.
• ID do item não encontrado ou não pertencente à sua chave (assign-to-folder, save-as-template) → HTTP 200 com Message: "Item not found".
• Campo do corpo desconhecido ou digitado errado (assign-to-folder, save-as-template) → HTTP 200 com Message: "Unknown field(s) '…'. Expected: …".

Notas

• O nome de Folder que você atribui é o mesmo valor que aparece em Folder no list-folders, então você pode reutilizar um nome de pasta existente para adicionar mais flipbooks a ela.