Analytics-tracking en AI-assistent

Wat je kunt doen

Met deze vier endpoints configureer je de tracking- en AI-functies op één gehoste flipbook, allemaal gekoppeld aan zijn {flipbookId}:

• Voeg analytics-tracking-ID's toe — codes voor Google Analytics, Google Tag Manager en Facebook Pixel.
• Stel de AI-provider in — de providernaam en de bijbehorende API-sleutel voor de AI-functies.
• Configureer de virtuele assistent — de basisinstellingen van de chat-/hulpassistent in de viewer (knoptekst, kleuren, prompt, embeddings).
• Stel de statustekst van de assistent in — de labels die worden getoond terwijl de assistent luistert, opneemt, verwerkt en spreekt.

Voordat je begint

• Een API-sleutel — meegestuurd als de X-Api-Key-header, of als Authorization: Bearer YOUR_API_KEY, op elk verzoek.
• De {flipbookId} — de numerieke ID van de flipbook/het document. Die wordt teruggegeven door create-by-file / create-by-url (als ID) of door list. Alle vier de endpoints hieronder nemen hem als padparameter.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• De request-body is op elk endpoint hier form-urlencoded (geen JSON) — stuur elk veld met --data-urlencode.

Analytics-tracking-ID's toevoegen

PUT /api/set-analytics-tracking/{flipbookId} voegt je eigen analytics-tracking-ID's (bijv. Google Analytics, GTM, Facebook Pixel) toe aan de gehoste flipbook.

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

Response:

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

De AI-provider instellen

PUT /api/set-ai-provider/{flipbookId} configureert de AI-provider voor de AI-functies — de providernaam (AIProvider) en de bijbehorende API-sleutel (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='

Response:

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

De virtuele assistent configureren

PUT /api/set-virtual-assistant/{flipbookId} configureert de basisinstellingen van de virtuele assistent (chat/hulp) in de viewer. IsVA schakelt de assistent aan of uit, VAText bevat de assistent-prompt/instructies, en VAEmbeddings bevat de embeddings-blob (een 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='

Response:

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

De statustekst van de assistent instellen

PUT /api/set-virtual-assistant-status-text/{flipbookId} stelt de status-/begroetingstekst in die door de virtuele assistent in de viewer wordt getoond. De vier velden zijn de labels voor elke status: VAButtonStatus1 (luisteren), VAButtonStatus2 (opnemen), VAButtonStatus3 (verwerken) en VAButtonStatus4 (spreken).

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

Response:

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

Mogelijke fouten

Alle vier de endpoints hebben hetzelfde foutgedrag:

• Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Controleer of de X-Api-Key-header (of Authorization: Bearer) aanwezig en correct is.
• Item-ID niet gevonden of niet in eigendom van je sleutel → HTTP 200 met Message: "Item not found".
• Onbekend of verkeerd gespeld body-veld → HTTP 200 met Message: "Unknown field(s) '…'. Expected: …".