Démarage Rapide

Phase 1 : Configuration de la Plateforme

Note : Pour ce guide, nous allons configurer la structure manuellement via l'interface web pour démarrer rapidement. Toutefois, pour des intégrations avancées ou à grande échelle, toutes les étapes ci-dessous (création de groupes, définition des sources de données et publication) peuvent être effectuées par programmation via les endpoints de l'API (ex: /api/input/survey/create).

1. Connectez-vous à la plateforme BoundaryAI.

2. Créez un Groupe de Feedback (Feedback Group) : Il agit comme votre dossier principal (ex: "Logs du Support Client").

3. Créez un Sondage (Source de Données) : À l'intérieur de ce groupe, créez un nouveau sondage (ex: "Export Chat en Direct").

   • Ajoutez une Question : Créez au moins une question de type Texte / Réponse Longue (ex: "Message Utilisateur"). C'est ici que l'API insérera vos données textuelles brutes.

4. Activez la Collecte Continue (Crucial) :

   • Localisez la carte de votre Sondage / Source de Données nouvellement créé.

   • Cliquez sur les trois petits points (...) sur la carte.

   • Sélectionnez Options Avancées (Advanced Options).

   • Activez l'option "Ongoing feedback collection".

   • Pourquoi ? Cela garantit que le système traite les données comme un flux continu (permettant le suivi de l'évolution) plutôt que comme un jeu de données statique et ponctuel.

5. Publiez : Assurez-vous que le sondage est réglé sur Publié (Published) afin qu'il puisse accepter des données.

---

Phase 2 : Authentification

1. Naviguez vers l'onglet Intégrations dans la barre latérale.

2. Sélectionnez API.

3. Cliquez sur Créer une clé API (Create API Key).

4. Sélectionnez le niveau de permission Push (suffisant pour envoyer des données) ou All.

5. Copiez la clé immédiatement (elle commence par inpk_). Cette clé ne vous sera plus jamais affichée.

---

Phase 3 : Intégration (Envoi de Données)

Pour envoyer des données, vous avez besoin de trois identifiants : survey_series_id (Groupe), survey_id (Source), et question_id (Le champ spécifique pour le texte).

Étape A : Obtenir vos IDs

Exécutez cette requête une fois pour récupérer les identifiants du groupe et du sondage que vous venez de créer.

Requête : GET https://app.boundary-ai.com/api/input/surveys/list

En-têtes (Headers) : Authorization: Bearer <VOTRE_CLÉ_API>

Réponse (Extrait JSON) :

JSON

{
  "survey_series": [
    {
      "id": 101, // Ceci est votre survey_series_id
      "name": "Logs du Support Client",
      "surveys": [
        {
          "id": 505, // Ceci est votre survey_id
          "title": "Export Chat en Direct",
          "questions": [
            {
              "question_id": "888", // Ceci est votre question_id
              "text": "Message Utilisateur",
              "accepts_text": true
            }
          ]
        }
      ]
    }
  ]
}

Étape B : Envoyer (Push) les Données

Maintenant que vous avez vos IDs (ex: Groupe 101, Sondage 505, Question 888), utilisez l'endpoint de push pour envoyer les données.

Endpoint : POST https://app.boundary-ai.com/api/input/content/push

Exemple Python :

Python

import requests

url = "https://app.boundary-ai.com/api/input/content/push"

payload = {
    "survey_series_id": "101",   # Depuis l'Étape A
    "survey_id": "505",          # Depuis l'Étape A
    "question": {
        "question_id": "888",    # Depuis l'Étape A
        "content": [
            "Le bouton de connexion est cassé sur mobile.",
            "Super service aujourd'hui, merci !",
            "Je ne trouve pas la fonction d'export PDF."
        ]
    },
    # Optionnel : Utilisez une référence unique pour ce lot afin d'éviter les doublons
    "source_reference": "lot_2023_10_27_001" 
}

headers = {
    "Authorization": "Bearer inpk_live_votre_cle_api_ici",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

Résumé des Bonnes Pratiques

• Traitement par lots (Batching) : Vous pouvez envoyer jusqu'à 1 000 éléments par requête. Groupez vos commentaires utilisateurs et envoyez-les par lots plutôt que de faire un appel API par commentaire.

• Idempotence : Incluez toujours une source_reference. Si une erreur réseau survient et que vous réessayez la requête, l'API utilisera cette référence pour reconnaître le lot et empêcher la saisie de données en double.