Tracciamento analytics e assistente AI

Cosa puoi fare

Questi quattro endpoint ti permettono di configurare le funzionalità di tracciamento e AI su un singolo flipbook ospitato, tutte identificate dal suo {flipbookId}:

• Aggiungere ID di tracciamento analytics — i codici di Google Analytics, Google Tag Manager e Facebook Pixel.
• Impostare il provider AI — il nome del provider e la sua chiave API usata per le funzionalità AI.
• Configurare l'assistente virtuale — le impostazioni di base dell'assistente di chat/aiuto interno al viewer (testo del pulsante, colori, prompt, embedding).
• Impostare il testo di stato dell'assistente — le etichette mostrate mentre l'assistente ascolta, registra, elabora e parla.

Prima di iniziare

• Una chiave API — inviata come header X-Api-Key, o come Authorization: Bearer YOUR_API_KEY, in ogni richiesta.
• Il {flipbookId} — l'ID numerico del flipbook/documento. Viene restituito da create-by-file / create-by-url (come ID) o da list. Tutti e quattro gli endpoint qui sotto lo accettano come parametro nel percorso.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• Il body della richiesta in ognuno di questi endpoint è form-urlencoded (non JSON) — invia ogni campo con --data-urlencode.

Aggiungere ID di tracciamento analytics

PUT /api/set-analytics-tracking/{flipbookId} aggiunge i tuoi ID di tracciamento analytics (per esempio Google Analytics, GTM, Facebook Pixel) al flipbook ospitato.

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

Risposta:

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

Impostare il provider AI

PUT /api/set-ai-provider/{flipbookId} configura il provider AI usato per le funzionalità AI — il nome del provider (AIProvider) e la sua chiave 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='

Risposta:

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

Configurare l'assistente virtuale

PUT /api/set-virtual-assistant/{flipbookId} configura le impostazioni di base dell'assistente virtuale (chat/aiuto) interno al viewer. IsVA attiva o disattiva l'assistente, VAText contiene il prompt / le istruzioni dell'assistente e VAEmbeddings contiene il blob degli embedding (una stringa).

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

Risposta:

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

Impostare il testo di stato dell'assistente

PUT /api/set-virtual-assistant-status-text/{flipbookId} imposta il testo di stato/saluto mostrato dall'assistente virtuale interno al viewer. I quattro campi sono le etichette per ciascuno stato: VAButtonStatus1 (in ascolto), VAButtonStatus2 (in registrazione), VAButtonStatus3 (in elaborazione) e VAButtonStatus4 (mentre parla).

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

Risposta:

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

Errori possibili

Tutti e quattro gli endpoint condividono lo stesso comportamento in caso di errore:

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key (o Authorization: Bearer) sia presente e corretto.
• ID dell'elemento non trovato o non di proprietà della tua chiave → HTTP 200 con Message: "Item not found".
• Campo del body sconosciuto o scritto male → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …".