Seguimiento de analítica y asistente de IA

Qué puedes hacer

Estos cuatro endpoints te permiten configurar las funciones de seguimiento e IA de un único flipbook alojado, todas identificadas por su {flipbookId}:

• Añadir IDs de seguimiento de analítica — códigos de Google Analytics, Google Tag Manager y Facebook Pixel.
• Definir el proveedor de IA — el nombre del proveedor y su clave de API usados para las funciones de IA.
• Configurar el asistente virtual — los ajustes básicos del asistente de chat/ayuda dentro del visor (texto del botón, colores, prompt, embeddings).
• Definir el texto de estado del asistente — las etiquetas que se muestran mientras el asistente escucha, graba, procesa y habla.

Antes de empezar

• Una clave de API — se envía en el encabezado X-Api-Key, o como Authorization: Bearer YOUR_API_KEY, en cada solicitud.
• El {flipbookId} — el ID numérico del flipbook/documento. Lo devuelven create-by-file / create-by-url (como ID) o list. Los cuatro endpoints de abajo lo toman como parámetro de ruta.
• Todas las solicitudes van a la URL base https://go.fliplink.me.
• El cuerpo de la solicitud en cada endpoint aquí es form-urlencoded (no JSON) — envía cada campo con --data-urlencode.

Añadir IDs de seguimiento de analítica

PUT /api/set-analytics-tracking/{flipbookId} añade tus propios IDs de seguimiento de analítica (p. ej. Google Analytics, GTM, Facebook Pixel) al flipbook alojado.

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='

Respuesta:

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

Definir el proveedor de IA

PUT /api/set-ai-provider/{flipbookId} configura el proveedor de IA usado para las funciones de IA — el nombre del proveedor (AIProvider) y su clave de API (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='

Respuesta:

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

Configurar el asistente virtual

PUT /api/set-virtual-assistant/{flipbookId} configura los ajustes básicos del asistente virtual (chat/ayuda) dentro del visor. IsVA activa o desactiva el asistente, VAText contiene el prompt / las instrucciones del asistente, y VAEmbeddings contiene el blob de embeddings (una cadena).

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='

Respuesta:

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

Definir el texto de estado del asistente

PUT /api/set-virtual-assistant-status-text/{flipbookId} define el texto de estado/saludo que muestra el asistente virtual dentro del visor. Los cuatro campos son las etiquetas de cada estado: VAButtonStatus1 (escuchando), VAButtonStatus2 (grabando), VAButtonStatus3 (procesando) y VAButtonStatus4 (hablando).

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='

Respuesta:

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

Errores posibles

Los cuatro endpoints comparten el mismo comportamiento de error:

• Clave de API ausente o no válida → HTTP 401. Esto devuelve una página HTML de "Unauthorized" sin formato sin formato — no hay cuerpo JSON. Comprueba que el encabezado X-Api-Key (o Authorization: Bearer) esté presente y sea correcto.
• ID del ítem no encontrado o no perteneciente a tu clave → HTTP 200 con Message: "Item not found".
• Campo del cuerpo desconocido o mal escrito → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …".