Analytics-Tracking und KI-Assistent

Was du tun kannst

Mit diesen vier Endpunkten konfigurierst du die Tracking- und KI-Funktionen eines einzelnen gehosteten Flipbooks, alle über dessen {flipbookId}:

• Analytics-Tracking-IDs hinzufügen – Codes für Google Analytics, Google Tag Manager und Facebook Pixel.
• Den KI-Anbieter festlegen – den Anbieternamen und dessen API-Schlüssel für die KI-Funktionen.
• Den virtuellen Assistenten konfigurieren – die Grundeinstellungen des Chat-/Hilfe-Assistenten im Viewer (Button-Text, Farben, Prompt, Embeddings).
• Den Statustext des Assistenten festlegen – die Beschriftungen, die angezeigt werden, während der Assistent zuhört, aufnimmt, verarbeitet und spricht.

Bevor du loslegst

• Einen API-Schlüssel – wird bei jeder Anfrage als X-Api-Key-Header oder als Authorization: Bearer YOUR_API_KEY gesendet.
• Die {flipbookId} – die numerische ID des Flipbooks/Dokuments. Sie wird von create-by-file / create-by-url (als ID) oder von list zurückgegeben. Alle vier Endpunkte unten nehmen sie als Pfadparameter entgegen.
• Alle Anfragen gehen an die Basis-URL https://go.fliplink.me.
• Der Request-Body ist bei jedem Endpunkt hier form-urlencoded (kein JSON) – sende jedes Feld mit --data-urlencode.

Analytics-Tracking-IDs hinzufügen

PUT /api/set-analytics-tracking/{flipbookId} fügt dem gehosteten Flipbook deine eigenen Analytics-Tracking-IDs hinzu (z. B. Google Analytics, GTM, Facebook Pixel).

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

Antwort:

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

Den KI-Anbieter festlegen

PUT /api/set-ai-provider/{flipbookId} konfiguriert den KI-Anbieter für die KI-Funktionen – den Anbieternamen (AIProvider) und dessen API-Schlüssel (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='

Antwort:

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

Den virtuellen Assistenten konfigurieren

PUT /api/set-virtual-assistant/{flipbookId} konfiguriert die Grundeinstellungen des virtuellen Assistenten (Chat/Hilfe) im Viewer. IsVA schaltet den Assistenten ein oder aus, VAText enthält den Assistenten-Prompt bzw. die Anweisungen, und VAEmbeddings enthält den Embeddings-Blob (einen 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='

Antwort:

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

Den Statustext des Assistenten festlegen

PUT /api/set-virtual-assistant-status-text/{flipbookId} legt den Status-/Begrüßungstext fest, den der virtuelle Assistent im Viewer anzeigt. Die vier Felder sind die Beschriftungen für die einzelnen Zustände: VAButtonStatus1 (zuhören), VAButtonStatus2 (aufnehmen), VAButtonStatus3 (verarbeiten) und VAButtonStatus4 (sprechen).

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

Antwort:

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

Mögliche Fehler

Alle vier Endpunkte verhalten sich bei Fehlern gleich:

• Fehlender oder ungültiger API-Schlüssel → HTTP 401. Das gibt eine reine Unauthorized-HTML-Seite zurück – es gibt keinen JSON-Body. Prüfe, ob der X-Api-Key-Header (oder Authorization: Bearer) vorhanden und korrekt ist.
• Item-ID nicht gefunden oder nicht im Besitz deines Schlüssels → HTTP 200 mit Message: "Item not found".
• Unbekanntes oder falsch geschriebenes Body-Feld → HTTP 200 mit Message: "Unknown field(s) '…'. Expected: …".