Guide de démarrage rapide

Phase 1 : Configuration de la plateforme

Remarque : Pour ce guide, nous allons configurer manuellement la structure dans l'interface web pour démarrer rapidement. Cependant, 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 réalisées programmatiquement via les points de terminaison de l'API (par exemple, /api/input/survey/create).

1. Connectez-vous à la plateforme BoundaryAI.

2. Créer un groupe de retours

   Ceci sert de conteneur principal (par exemple, « Journaux du support client »).

3. Créer un point de terminaison (source de données)

   Dans le groupe de retours, créez un nouveau point de terminaison (par exemple, « Journaux du chat en direct »).

   • Cliquez sur Commencer la collecte de retours → Connecteurs → Point de terminaison API

   • Définissez le format de charge utile attendu pour vos données.

   • Enregistrez toutes les informations partagées, car elles seront essentielles pour envoyer les données correctement

4. Activer la collecte continue (optionnel)

   • Localisez le point de terminaison/source de données nouvellement créé.

   • Cliquez sur le menu à trois points (…).

   • Ouvrez les options avancées.

   • Activez la collecte continue de retours.

Pourquoi c'est important : Activer la collecte continue indique à BoundaryAI de traiter les données entrantes comme un flux continu plutôt que comme un téléchargement ponctuel. Ceci est nécessaire pour l'analyse longitudinale, la détection de tendances et le suivi de l'évolution au fil du temps.

---

Phase 2 : Authentification

1. Accédez à l'onglet Intégrations dans la barre latérale.

2. Sélectionnez API.

3. Cliquez sur Créer une clé API.

4. Sélectionnez le niveau d'autorisation Push (suffisant pour l'envoi de données) ou Tous.

5. Copiez la clé immédiatement (elle commence par inpk_). Cette clé ne sera plus 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 et les données). Ces champs vous ont été fournis lorsque vous avez créé le point de terminaison mais vous pouvez aussi les récupérer en utilisant GET méthode.

Pousser des données

Maintenant que vous avez vos identifiants (par ex., Groupe 101, Enquête 505, Question 888), utilisez le point de terminaison push pour envoyer des données.

Point de terminaison : POST https://app.boundary-ai.com/api/input/content/push

Exemple 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 fonctionnalité d'exportation en PDF."
        ]
    },
    # Optionnel : Utilisez une référence unique pour ce lot afin d'éviter les doublons
    "source_reference": "batch_2023_10_27_001" 
}

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

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

print(response.json())

_{Exemple Curl :}

curl -X POST "https://app.boundary-ai.com/api/input/content/push" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "survey_series_id": "2",
    "survey_id": "287",
    "question": {
      "question_id": "736",
      "content": [
        "Le bouton de connexion est cassé sur mobile.",
        "Super service aujourd'hui, merci !",
        "Je ne trouve pas la fonctionnalité d'exportation en PDF."
      ]
    },
    "source_reference": "batch_2023_10_27_001"
  }'

Réponse (extrait JSON) :

{
  "status": "success",
  "inserted": 3,
  "aps_deducted": 3,
  "question_id": 736,
  "survey_id": 287,
  "survey_series_id": 2
}

---

Résumé des bonnes pratiques

• Regroupement par lots : Vous pouvez envoyer jusqu'à 10 000 éléments par requête. Tamponnez les commentaires de vos utilisateurs et envoyez-les par lots plutôt qu'un appel API par commentaire.

• Idempotence : Incluez toujours un en-tête 'Idempotency-Key'. Si une erreur réseau survient et que vous retentez la requête, l'API utilisera cette référence pour reconnaître le lot et éviter la duplication des données.

• Limites de taux : L'API autorise 60 requêtes/minute par clé. La valeur par défaut est 60/min, le maximum est 300/min.