Suivi statistique et assistant IA

Ce que tu peux faire

Ces quatre endpoints te permettent de configurer les fonctionnalités de suivi et d'IA sur un seul flipbook hébergé, toutes identifiées par son {flipbookId} :

• Ajouter des identifiants de suivi statistique — les codes Google Analytics, Google Tag Manager et Facebook Pixel.
• Définir le fournisseur d'IA — le nom du fournisseur et sa clé d'API utilisés pour les fonctionnalités d'IA.
• Configurer l'assistant virtuel — les paramètres de base de l'assistant de chat/d'aide intégré au lecteur (texte du bouton, couleurs, prompt, embeddings).
• Définir le texte de statut de l'assistant — les libellés affichés pendant que l'assistant écoute, enregistre, traite et parle.

Avant de commencer

• Une clé d'API — envoyée dans l'en-tête X-Api-Key, ou via Authorization: Bearer YOUR_API_KEY, à chaque requête.
• Le {flipbookId} — l'ID numérique du flipbook/document. Il est renvoyé par create-by-file / create-by-url (sous la forme ID) ou par list. Les quatre endpoints ci-dessous le prennent comme paramètre de chemin.
• Toutes les requêtes sont envoyées à l'URL de base https://go.fliplink.me.
• Le corps de la requête sur chaque endpoint ici est au format form-urlencoded (pas JSON) — envoie chaque champ avec --data-urlencode.

Ajouter des identifiants de suivi statistique

PUT /api/set-analytics-tracking/{flipbookId} ajoute tes propres identifiants de suivi statistique (par exemple Google Analytics, GTM, Facebook Pixel) au flipbook hébergé.

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

Réponse :

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

Définir le fournisseur d'IA

PUT /api/set-ai-provider/{flipbookId} configure le fournisseur d'IA utilisé pour les fonctionnalités d'IA — le nom du fournisseur (AIProvider) et sa clé d'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='

Réponse :

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

Configurer l'assistant virtuel

PUT /api/set-virtual-assistant/{flipbookId} configure les paramètres de base de l'assistant virtuel intégré au lecteur (chat/aide). IsVA active ou désactive l'assistant, VAText contient le prompt / les instructions de l'assistant, et VAEmbeddings contient le blob d'embeddings (une chaîne de caractères).

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

Réponse :

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

Définir le texte de statut de l'assistant

PUT /api/set-virtual-assistant-status-text/{flipbookId} définit le texte de statut/d'accueil affiché par l'assistant virtuel intégré au lecteur. Les quatre champs sont les libellés de chaque état : VAButtonStatus1 (écoute), VAButtonStatus2 (enregistrement), VAButtonStatus3 (traitement) et VAButtonStatus4 (parole).

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

Réponse :

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

Erreurs possibles

Les quatre endpoints partagent le même comportement en cas d'erreur :

• Clé d'API manquante ou invalide → HTTP 401. Renvoie une simple page HTML « Unauthorized » — il n'y a pas de corps JSON. Vérifie que l'en-tête X-Api-Key (ou Authorization: Bearer) est présent et correct.
• ID d'élément introuvable ou non associé à ta clé → HTTP 200 avec Message: "Item not found".
• Champ de corps inconnu ou mal orthographié → HTTP 200 avec Message: "Unknown field(s) '…'. Expected: …".