Rastreamento de analytics e assistente de IA

O que você pode fazer

Estes quatro endpoints permitem configurar os recursos de rastreamento e de IA em um único flipbook hospedado, todos identificados pelo {flipbookId}:

• Adicionar IDs de rastreamento de analytics — códigos do Google Analytics, do Google Tag Manager e do Facebook Pixel.
• Definir o provedor de IA — o nome do provedor e a chave de API usada nos recursos de IA.
• Configurar o assistente virtual — as configurações básicas do assistente de chat/ajuda dentro do visualizador (texto do botão, cores, prompt, embeddings).
• Definir o texto de status do assistente — os rótulos exibidos enquanto o assistente está ouvindo, gravando, processando e falando.

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

Adicione IDs de rastreamento de analytics

PUT /api/set-analytics-tracking/{flipbookId} adiciona seus próprios IDs de rastreamento de analytics (por exemplo, Google Analytics, GTM, Facebook Pixel) ao flipbook hospedado.

curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=' \
  --data-urlencode 'GoogleAnalyticsCode=' \
  --data-urlencode 'GoogleTagManager='

Resposta:

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

Defina o provedor de IA

PUT /api/set-ai-provider/{flipbookId} configura o provedor de IA usado nos recursos de IA — o nome do provedor (AIProvider) e a chave de API dele (AIKey).

curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=' \
  --data-urlencode 'AIKey='

Resposta:

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

Configure o assistente virtual

PUT /api/set-virtual-assistant/{flipbookId} configura as configurações básicas do assistente virtual (chat/ajuda) dentro do visualizador. IsVA ativa ou desativa o assistente, VAText guarda o prompt / as instruções do assistente, e VAEmbeddings guarda o blob de embeddings (uma string).

curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=' \
  --data-urlencode 'VAButtonColor=' \
  --data-urlencode 'VAButtonTextColor=' \
  --data-urlencode 'VAText=' \
  --data-urlencode 'VAEmbeddings='

Resposta:

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

Defina o texto de status do assistente

PUT /api/set-virtual-assistant-status-text/{flipbookId} define o texto de status/saudação exibido pelo assistente virtual dentro do visualizador. Os quatro campos são os rótulos de cada estado: VAButtonStatus1 (ouvindo), VAButtonStatus2 (gravando), VAButtonStatus3 (processando) e VAButtonStatus4 (falando).

curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=' \
  --data-urlencode 'VAButtonStatus2=' \
  --data-urlencode 'VAButtonStatus3=' \
  --data-urlencode 'VAButtonStatus4='

Resposta:

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

Erros possíveis

Todos os quatro endpoints compartilham o mesmo comportamento de erro:

• 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: …".