Como Automatizar Flipbooks com a API do FlipLink

Se você está publicando flipbooks um de cada vez pelo painel, está deixando eficiência na mesa. A API do FlipLink permite automatizar cada etapa do processo de criação de flipbooks — desde o upload de PDFs até a configuração e publicação — tudo sem tocar na interface. Seja construindo uma plataforma de publicação, integrando com um CMS ou gerando relatórios automatizados, este guia apresenta tudo que você precisa para começar.

Por que automatizar a criação de flipbooks?

A criação manual de flipbooks funciona bem quando você lida com poucos documentos por semana. Mas o que acontece quando você precisa processar dezenas ou centenas de PDFs em um cronograma regular? É aí que a API do FlipLink se torna essencial. Cada endpoint, parâmetro e resposta deste guia está documentado na referência da API ao vivo, onde você também pode testar as chamadas diretamente no navegador.

A automação oferece várias vantagens:

• Velocidade em escala — Converta centenas de PDFs em flipbooks em minutos, não em horas
• Consistência — Cada flipbook segue o mesmo branding, configurações e padrões
• Redução de erros humanos — Sem etapas perdidas ou configurações esquecidas quando um script cuida do processo
• Integração com fluxos de trabalho — Acione a criação de flipbooks a partir das suas ferramentas e pipelines existentes
• Publicação sob demanda — Gere e distribua flipbooks no momento em que o novo conteúdo estiver pronto

Começando com a API do FlipLink

Autenticação

Cada requisição à API requer uma chave de API para autenticação. Você pode gerar sua chave no painel do FlipLink em Configurações > Acesso à API. Inclua a chave no cabeçalho X-Api-Key de cada requisição:

X-Api-Key: YOUR_API_KEY

Mantenha sua chave de API segura. Armazene-a em variáveis de ambiente ou em um gerenciador de segredos — nunca a codifique diretamente em código client-side nem a envie para o controle de versão. Veja a seção de Autenticação da referência da API para todos os detalhes.

URL base e limites de taxa

Todos os endpoints da API são servidos a partir da URL base https://go.fliplink.me/api. Os limites de taxa se aplicam por chave de API (300 requisições/minuto), então se você está executando operações em lote, inclua pequenas pausas entre as requisições para ficar dentro do limite permitido. Falhas de autenticação retornam HTTP 401; em todos os outros casos a API responde com HTTP 200 e um corpo JSON cujo campo Result é "OK" ou "ERROR" — então sempre verifique o Result, não apenas o código de status. Veja a lista completa de endpoints, com exemplos ao vivo, na referência da API.

Fazendo upload de PDFs programaticamente

O núcleo da criação automatizada de flipbooks é o endpoint Create by File, POST /api/create-by-file. Você envia o PDF como um upload de formulário multipart e o FlipLink o processa em um flipbook. Se o seu PDF já estiver em uma URL pública, use POST /api/create-by-url e passe FileURL em vez de File.

Uma requisição de upload típica inclui:

• O arquivo PDF (File, dados binários via multipart form)
• Um Name (interno) e um Title (exibição) para o flipbook
• O DocType (por exemplo, Flipbook)

curl -X POST 'https://go.fliplink.me/api/create-by-file' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'File=@catalog-spring.pdf' \
  -F 'Name=Spring Product Catalog' \
  -F 'Title=Spring Product Catalog' \
  -F 'DocType=Flipbook'

Uma chamada bem-sucedida retorna {"Result":"OK","ID":"90001","URL":"https://go.fliplink.me/view/<slug>", ...} com a sua cota de publicação restante (Flipbooks_Left). Capture o ID — você vai usá-lo como o parâmetro de caminho {flipbookId} em cada chamada de configuração abaixo.

Configurando flipbooks via API

Fazer upload de um PDF é apenas o primeiro passo. A API também permite configurar cada opção que você normalmente ajustaria no painel. Em vez de uma única chamada de atualização para tudo, o FlipLink expõe um endpoint set-* focado por grupo de configuração — cada um é um PUT form-urlencoded que recebe o ID do flipbook como parâmetro de caminho (/api/set-…/{flipbookId}). Isso mantém cada chamada pequena e previsível em um pipeline em lote.

Opções de configuração comuns

• Acesso por senha — set-password-access para proteger um flipbook atrás de uma senha
• Branding — set-logo, set-background-image, set-skin, set-meta para metadados de SEO e imagem social
• Captura de leads — set-lead-capture (mais set-lead-fields, set-lead-webhook, set-lead-google-sheets) para coletar informações do visualizador
• Domínio personalizado — publique sob seu próprio domínio via os endpoints de CNAME (veja configuração de CNAME)
• Estado de publicação — set-published para publicar ou despublicar sob demanda
• Controles de compartilhamento e visualização — set-share-channels, set-viewer-controls e mais

# Example: password-protect the flipbook you just created
curl -X PUT 'https://go.fliplink.me/api/set-password-access/90001' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=true' \
  --data-urlencode 'Password=spring2026'

Cada chamada de configuração retorna {"Result":"OK","Message":"Updated successfully"}. Essa separação entre upload e configuração facilita a aplicação de diferentes configurações a diferentes flipbooks dentro do mesmo fluxo de trabalho em lote. A referência da API lista cada endpoint set-* com seus parâmetros exatos e um console Try-It ao vivo.

Fluxos de trabalho em lote

Quando você precisa converter uma pasta inteira de PDFs, um fluxo de trabalho em lote cuida do trabalho pesado. O padrão é simples:

1. Escaneie seu diretório de origem para encontrar arquivos PDF
2. Faça upload de cada PDF para a API do FlipLink
3. Configure as opções com base em regras (por exemplo, padrões de nome de arquivo, arquivos de metadados)
4. Registre as URLs dos flipbooks resultantes
5. Notifique as partes interessadas ou sistemas posteriores

Aqui está um exemplo simplificado em Python:

import os
import requests

API_KEY = os.environ["FLIPLINK_API_KEY"]
PDF_DIR = "./catalogs"
BASE = "https://go.fliplink.me/api"
HEADERS = {"X-Api-Key": API_KEY}

results = []

for filename in os.listdir(PDF_DIR):
    if not filename.endswith(".pdf"):
        continue

    filepath = os.path.join(PDF_DIR, filename)
    title = filename.replace(".pdf", "").replace("-", " ").title()

    with open(filepath, "rb") as f:
        response = requests.post(
            f"{BASE}/create-by-file",
            headers=HEADERS,
            files={"File": (filename, f, "application/pdf")},
            data={"Name": title, "Title": title, "DocType": "Flipbook"},
        )

    data = response.json()
    if data.get("Result") == "OK":
        results.append({"title": title, "id": data["ID"], "url": data["URL"]})
        print(f"Created: {title} -> {data['URL']}")
    else:
        print(f"Failed: {title} -> {data.get('Message')}")

print(f"Batch complete: {len(results)} flipbooks created")

Repare no tratamento da resposta: o FlipLink retorna HTTP 200 mesmo para erros de aplicação, então o script verifica o campo JSON Result em vez do código de status. Para lotes maiores, adicione tentativas para uploads que falharam e respeite o limite de taxa (300/min) inserindo uma breve pausa entre as requisições.

Callbacks via webhook para atualizações em tempo real

Depois que um flipbook está no ar, os webhooks permitem reagir à atividade do visualizador em tempo real, em vez de ficar consultando. Você configura um webhook por flipbook com PUT /api/set-lead-webhook/{flipbookId}, apontando-o para o seu próprio endpoint. O FlipLink então envia um POST para essa URL quando o flipbook captura atividade — principalmente novos leads, com eventos de visualização e venda disponíveis através das configurações relacionadas de leads e vendas.

Para configurar isso programaticamente:

# Send new-lead events for flipbook 90001 to your endpoint
curl -X PUT 'https://go.fliplink.me/api/set-lead-webhook/90001' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'WebhookURL_NewLead=https://example.com/hooks/fliplink'

Você pode disparar uma entrega de teste a qualquer momento com POST /api/test-webhook/{flipbookId} para confirmar que o seu handler recebe o payload antes de entrar no ar. Os webhooks possibilitam pipelines em tempo real: quando um novo lead chega, seu handler pode enviar o contato para um CRM, mandar uma notificação no Slack ou acionar uma campanha de e-mail. Prefere sem código? Os mesmos eventos podem passar por Zapier, Make ou n8n. Veja o grupo de endpoints de Captura de Leads na referência da API para as opções de webhook e Google Sheets.

Casos de uso reais

Plataformas de publicação

Empresas de mídia e plataformas de conteúdo podem integrar o FlipLink ao seu pipeline de publicação. Quando um editor finaliza uma edição de revista ou newsletter, o sistema converte automaticamente a exportação em PDF em um flipbook e o incorpora no site — sem etapas manuais.

Integrações com CMS

Conecte o FlipLink ao seu sistema de gerenciamento de conteúdo para que o upload de um PDF em uma pasta ou tipo de conteúdo específico acione a criação automática de flipbook. O código de incorporação resultante é inserido na página ou post relevante. Isso é especialmente poderoso para catálogos de produtos, lookbooks e sites de documentação.

Distribuição automatizada de relatórios

Relatórios financeiros, revisões trimestrais e documentos de compliance frequentemente seguem um cronograma previsível. Automatize todo o fluxo: gere o PDF com sua ferramenta de relatórios, faça upload no FlipLink via API, aplique o branding correto e os controles de acesso, e distribua o link do flipbook para as partes interessadas — tudo acionado por um único cron job ou evento de workflow.

Catálogos de produtos e-commerce

Varejistas com catálogos atualizados frequentemente podem regenerar flipbooks sempre que os dados de produtos mudam. Puxe o PDF do catálogo mais recente do seu sistema de gerenciamento de informações de produto, crie um novo flipbook e substitua o embed na sua loja — mantendo os clientes vendo o inventário atualizado sem intervenção manual.

Combinando acesso à API com integrações de automação

A API é poderosa por si só, mas se torna ainda mais versátil quando combinada com integrações de automação. Use ferramentas como Zapier, Make ou n8n para conectar o FlipLink a centenas de outros apps sem escrever código. Por exemplo:

• Google Drive + FlipLink — Crie automaticamente um flipbook quando um novo PDF aparecer em uma pasta específica do Drive
• Shopify + FlipLink — Gere um flipbook de produto sempre que uma nova coleção for publicada
• HubSpot + FlipLink — Anexe um link de flipbook a um registro de contato quando ele solicitar um folheto

Para mais detalhes sobre como conectar o FlipLink com ferramentas de terceiros, confira nosso guia sobre como usar a API do FlipLink para integrações.

Boas práticas para fluxos de flipbook orientados por API

• Use operações idempotentes — Inclua um ID de referência único com cada upload para poder tentar novamente com segurança sem criar duplicatas
• Trate erros com elegância — Registre falhas, implemente tentativas com backoff exponencial e alerte sobre erros repetidos
• Armazene IDs de flipbooks — Mapeie cada PDF de origem para seu ID no banco de dados; é o parâmetro de caminho {flipbookId} para cada chamada de leitura, atualização e exclusão
• Verifique o Result, não o status — Erros de aplicação voltam como HTTP 200 com Result: "ERROR"; apenas falhas de autenticação usam 401
• Monitore o uso — Acompanhe o volume de chamadas à API em relação ao limite de taxa de 300/min, e observe o Flipbooks_Left nas respostas de criação em relação à sua capacidade de publicações ativas

Comece a automatizar hoje

A API do FlipLink transforma a criação de flipbooks de uma tarefa manual em um fluxo de trabalho escalável e automatizado. Seja processando dez PDFs por semana ou dez mil, a API cuida disso com qualidade consistente e zero trabalho manual.

Pronto para construir seu pipeline automatizado de flipbooks? Crie sua conta no FlipLink, pegue sua chave e abra a referência da API para testar os endpoints ao vivo no seu navegador. Confira nossa página de preços para ver a oferta vitalícia única a partir de $39.