Documentation de l'API

L'API BoundaryAI vous permet d'envoyer des données de retour d'information de manière programmatique, de créer des sources de données et de gérer le flux de collecte des retours de votre organisation.

Aperçu

L'API BoundaryAI vous permet d'importer programmatiquement des données de feedback depuis n'importe quelle source - tickets de support, exportations CRM, enquêtes, journaux de chat - et d'exploiter l'analyse alimentée par l'IA pour extraire des insights.

Concepts clés

Avant de plonger, comprenez ces concepts clés :

Concept

Description

groupe de feedback

Un conteneur qui organise des sources de données liées (par ex. « Retour clients T1 2024 »)

Source de données

Une collection de feedbacks au sein d'un groupe (par ex. « Tickets Zendesk », « Enquête NPS »)

Question

Un champ au sein d'une source de données qui contient le texte du feedback

APS

Points d'analyse - crédits consommés lors de l'envoi de contenu pour analyse par l'IA

Comment ça fonctionne

1. Créez un groupe de feedback (ou utilisez-en un existant)
         ↓
2. Créez une source de données avec des questions
         ↓
3. Publiez la source de données
         ↓
4. Poussez votre contenu de feedback
         ↓
5. BoundaryAI analyse et extrait des insights

Authentification

Clés API

Toutes les requêtes API nécessitent une clé API passée dans le Autorisation en-tête :

Authorization: Bearer inpk_live_abc123xyz_SbcEpUl9DWuI8IOI-YImkxPNSisaAab7t0goFuliM-4

Format de la clé

inpk_{environment}_{key_id}_{secret}

Partie

Description

inpk

Préfixe fixe (Clé API d'entrée)

environnement

live (production) ou test (pas de déduction d'APS)

key_id

Identifiant unique de 10 caractères

secret

Secret encodé en Base64 (44 caractères)

Permissions de la clé

Lors de la création d'une clé API, vous choisissez son niveau d'autorisation :

Permission

Peut faire

Cas d'utilisation

push

Envoyer du contenu vers des sources de données existantes

Scripts d'import automatisés

create

Créer des groupes de feedback et des sources de données

Configurer l'automatisation

all

Tout

Contrôle programmatique complet

Obtenir votre clé API

Allez dans Intégrations → API dans votre tableau de bord BoundaryAI
Cliquez Créer une clé API
Choisissez un nom, un environnement et un niveau d'autorisation
Enregistrez la clé immédiatement — elle n'est affichée qu'une seule fois !

Notes de sécurité

Les clés sont hachées côté serveur ; nous ne stockons jamais le texte en clair
Utilisez test clés d'environnement pour les tests (pas de frais APS)
Faites pivoter les clés régulièrement via le tableau de bord (n'oubliez pas de les copier après rotation car elles n'apparaissent également qu'une seule fois)

Faire des requêtes

URLs de base

Environnement

URL de base

Europe

https://app.boundary-ai.com/

Amérique du Nord

https://app.boundary-ai.com/

APAC

Bientôt disponible

Format de la requête

Toutes les requêtes doivent inclure :

Authorization: Bearer {your_api_key}
Content-Type: application/json

Format de la réponse

Réponse de succès

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

Réponse d'erreur

{
  "error": {
    "code": "SURVEY_NOT_FOUND",
    "message": "La source de données avec l'ID 999 n'existe pas",
    "details": {}
  }
}

Limitation de débit

Trois couches protègent l'API :

Couche

Limite

Portée

Par clé

60/min (max = 300)

Clé API individuelle

Par organisation

1000/min

Toutes les clés de l'organisation

Par IP

1000/min

Protection de secours

En-têtes de réponse :

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 1704067200

Lorsqu'on atteint la limite, vous recevrez HTTP 429 avec un Retry-After en-tête.

Idempotence

Prévenez les doublons en incluant une clé d'idempotence :

Idempotency-Key: import-batch-2024-01-15-001

Scénario

Résultat

Première requête

S'exécute normalement, met en cache la réponse pendant 24h

Même clé + même payload

Retourne la réponse en cache (pas d'insertion en double)

Même clé + payload différent

Retourne HTTP 409 erreur de conflit

Meilleure pratique : Utilisez un identifiant unique comme {source}-{date}-{batch} pour chaque lot d'import.

Référence des endpoints

Référence rapide

Méthode

Endpoint

Description

Permission

GET

/api/input/surveys/list

Lister tous les groupes de feedback et sources de données

n'importe

POST

/api/input/survey_series/create

Créer un groupe de feedback

create

POST

/api/input/survey/create

Créer une source de données

create

POST

/api/input/survey/publish

Publier une source de données

create

POST

/api/input/content/push

Envoyer du contenu vers une question

push

POST

/api/input/content/push/bulk

Envoyer du contenu vers plusieurs questions

push

Lister les sources de données

Récupère tous les groupes de feedback et sources de données auxquels votre clé API peut accéder. Exécutez ceci en premier pour obtenir les IDs dont vous avez besoin pour pousser du contenu.

GET /api/input/surveys/list

Paramètres de requête

Paramètre

Type

Description

survey_series_id

entier

Filtrer vers un groupe de feedback spécifique

survey_id

entier

Filtrer vers une source de données spécifique

Réponse

{
  "org_id": 1,
  "survey_series": [
    {
      "id": 101,
      "name": "Journaux du support client",
      "surveys": [
        {
          "id": 505,
          "title": "Export Chat en direct",
          "description": "Description de l'enquête ici",
          "mode": "ACCESSIBLE",
          "questions": [
            {
              "id": 888,
              "title": "Message utilisateur",
              "type": "long_answer",
              "accepts_text": true
            }
          ]
        }
      ]
    }
  ]
}

Comprendre la réponse

Champ

Description

survey_series

Tableau de groupes de feedback

surveys

Tableau de sources de données au sein d'un groupe

questions

Champs disponibles pour le contenu

accepts_text

Important ! N'envoyez du texte que vers des questions où ceci est true

mode

ACCESSIBLE = publié, EDITING = brouillon

Exemple

curl -X GET "https://app.boundary-ai.com/api/input/surveys/list" \
  -H "Authorization: Bearer $API_KEY"

Envoyer du contenu

Envoyez du texte de feedback vers une question spécifique. C'est le endpoint principal pour l'import de données.

POST /api/input/content/push

Corps de la requête

{
  "survey_series_id": "123",
  "survey_id": "456",
  "question": {
    "question_id": "789",
    "content": [
      "Le processus de paiement était confus",
      "J'adore la nouvelle fonctionnalité de mode sombre !",
      "L'application plante lors du téléchargement de fichiers volumineux"
    ]
  },
  "source_reference": "zendesk-export-2024-01-15"
}

Paramètres

Champ

Type

Requis

Description

survey_series_id

chaîne

Oui

ID du groupe de feedback

survey_id

chaîne

Oui

ID de la source de données

question.question_id

chaîne

Oui

ID de la question (doit avoir accepts_text: true)

question.content

tableau

Oui

Tableau de chaînes de feedback

source_reference

chaîne

Non

Votre référence pour ce lot d'import

Limites de contenu

Limite

Valeur

Max d'éléments par requête

1,000

Max de caractères par élément

10,000

Réponse

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

Champ

Description

inserted

Nombre de nouvelles entrées ajoutées

duplicates

Nombre d'entrées en double ignorées

aps_deducted

Points d'analyse consommés

Exemple : Python

import requests

API_KEY = "inpk_live_xxx_yyy"
BASE_URL = "https://app.boundary-ai.com"

response = requests.post(
    f"{BASE_URL}/api/input/content/push",
    headers={
        "Authorization": f"Bearer {API_KEY}",
        "Content-Type": "application/json"
    },
    json={
        "survey_series_id": "123",
        "survey_id": "456",
        "question": {
            "question_id": "789",
            "content": [
                "Super produit, facile à utiliser !",
                "L'équipe de support a été très aidante",
                "Je le recommanderais à d'autres"
            ]
        },
        "source_reference": "crm-export-2024-01"
    }
)

result = response.json()
print(f"Inserted: {result['inserted']}, APS used: {result['aps_deducted']}")

Exemple : JavaScript

const API_KEY = 'inpk_live_xxx_yyy';
const BASE_URL = 'https://app.boundary-ai.com';

const response = await fetch(`${BASE_URL}/api/input/content/push`, {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    survey_series_id: "123",
    survey_id: "456",
    question: {
      question_id: "789",
      content: [
        'Super produit, facile à utiliser !',
        'L'équipe de support a été très aidante',
        'Je le recommanderais à d'autres'
      ]
    },
    source_reference: 'crm-export-2024-01'
  })
});

const result = await response.json();
console.log(`Inserted: ${result.inserted}, APS used: ${result.aps_deducted}`);

Exemple : Curl

curl -X POST "https://app.boundary-ai.com/api/input/content/push" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: batch-001" \
  -d '{
    "survey_series_id": "123",
    "survey_id": "456",
    "question": {
      "question_id": "789",
      "content": [
        "Super produit, facile à utiliser !",
        "L'équipe de support a été très aidante"
      ]
    }
  }'

Envoi en bloc de contenu

Envoyez du contenu vers plusieurs questions dans une seule requête. Utile lorsque vos données ont plusieurs champs.

POST /api/input/content/push/bulk

Corps de la requête

{
  "survey_series_id": "123",
  "survey_id": "456",
  "questions": [
    {
      "question_id": "789",
      "content": ["Feedback pour la question 1", "Plus de feedback"]
    },
    {
      "question_id": "790",
      "content": ["Feedback pour la question 2"]
    }
  ],
  "source_reference": "bulk-import-001"
}

Paramètres

Champ

Type

Requis

Description

survey_series_id

chaîne

Oui

ID du groupe de feedback

survey_id

chaîne

Oui

ID de la source de données

questions

tableau

Oui

Tableau d'objets question (max 100)

questions[].question_id

chaîne

Oui

ID de la question

questions[].content

tableau

Oui

Tableau de chaînes de feedback

source_reference

chaîne

Non

Votre référence pour ce lot

Réponse

{
  "status": "success",
  "survey_series_id": 2,
  "survey_id": 287,
  "total_inserted": 2,
  "total_aps_deducted": 2,
  "questions": [
    {"question_id": 736, "inserted": 2, "status": "success"}
  ]
}

Créer un groupe de feedback

Créez un nouveau groupe de feedback pour organiser des sources de données liées.

POST /api/input/survey_series/create

Permission requise : create ou all

Corps de la requête

{
  "name": "Feedback Produit 2024"
}

Paramètres

Champ

Type

Requis

Description

nom

chaîne

Oui

Nom du groupe (2-255 caractères)

Réponse

{
  "status": "success",
  "created": true,
  "survey_series": {
    "id": 123,
    "name": "Feedback Produit 2024"
  }
}

Remarque : Si un groupe portant le même nom existe, il renvoie le groupe existant avec "created": false.

Créer une source de données

Créez une nouvelle source de données avec des questions au sein d'un groupe de feedback.

POST /api/input/survey/create

Permission requise : create ou all

Corps de la requête

{
  "survey_series_id": "123",
  "survey_title": "Import Tickets Zendesk",
  "survey_description": "Tickets de support de janvier 2024",
  "questions": [
    {
      "question_title": "Contenu du ticket",
      "question_type": "DEPTH_TEXT",
      "is_mandatory": true
    },
    {
      "question_title": "Sentiment du client",
      "question_type": "SCQ",
      "question_options": ["Positif", "Neutre", "Négatif"],
      "is_mandatory": false
    }
  ]
}

Paramètres

Champ

Type

Requis

Description

survey_series_id

chaîne

Oui

ID du groupe parent de feedback

survey_title

chaîne

Oui

Nom de la source de données (1-100 caractères)

survey_description

chaîne

Non

Description (max 1000 caractères)

questions

tableau

Non

Tableau de questions à créer

Types de questions

Type

Alias

Description

Accepte le texte

DEPTH_TEXT

long_answer

Texte long (analysé par l'IA)

✅ Oui

TEXT

short_answer

Texte court

✅ Oui

MCQ

mcq

Choix multiples (sélection multiple)

❌ Non

SCQ

scq

Choix unique

❌ Non

RATING

rating

Échelle 1-5

❌ Non

NPS

nps

Net Promoter Score (0-10)

❌ Non

Astuce : Utilisez DEPTH_TEXT pour le texte de feedback que vous voulez que l'IA analyse.

Réponse

{
  "status": "success",
  "survey_series_id": 123,
  "survey_id": 456,
  "questions_created": 2,
  "questions": [
    {"id": 789, "title": "Contenu du ticket", "type": "DEPTH_TEXT"},
    {"id": 790, "title": "Sentiment du client", "type": "SCQ"}
  ],
  "message": "Enquête 'Import Tickets Zendesk' créée avec 2 question(s)"
}

Publier une source de données

Publiez une source de données pour permettre la collecte et l'analyse des données.

POST /api/input/survey/publish

Permission requise : create ou all

Corps de la requête

{
  "survey_series_id": 123,
  "survey_id": 456
}

Réponse

{
  "status": "success",
  "survey_id": 456,
  "survey_series_id": 123,
  "mode": "ACCESSIBLE",
  "message": "Enquête publiée avec succès"
}

Remarque : Vous devez publier une source de données avant de pouvoir y pousser du contenu.

Webhooks

Voir Webhooks page

Exemple complet

Voici un flux complet : créez un groupe de feedback, ajoutez une source de données, publiez-la et poussez du contenu.

#!/bin/bash
# Exemple complet de workflow API

API_KEY="inpk_live_xxx_yyy"
BASE_URL="https://app.boundary-ai.com"

# Étape 1 : Créer un groupe de feedback
echo "Création du groupe de feedback..."
SERIES_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/survey_series/create" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Tickets Support T1 2024"}')

SERIES_ID=$(echo $SERIES_RESPONSE | jq -r '.survey_series.id')
echo "ID du groupe de feedback créé : $SERIES_ID"

# Étape 2 : Créer une source de données avec une question texte
echo "Création de la source de données..."
SURVEY_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/survey/create" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d "{
    \"survey_series_id\": \"$SERIES_ID\",
    \"survey_title\": \"Import Zendesk\",
    \"questions\": [
      {\"question_title\": \"Contenu du ticket\", \"question_type\": \"DEPTH_TEXT\"}
    ]
  }")

SURVEY_ID=$(echo $SURVEY_RESPONSE | jq -r '.survey_id')
QUESTION_ID=$(echo $SURVEY_RESPONSE | jq -r '.questions[0].id')
echo "ID de la source de données créé : $SURVEY_ID, ID de la question : $QUESTION_ID"

# Étape 3 : Publier la source de données
echo "Publication de la source de données..."
curl -s -X POST "$BASE_URL/api/input/survey/publish" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"survey_series_id\": $SERIES_ID, \"survey_id\": $SURVEY_ID}"

# Étape 4 : Pousser le contenu de feedback
echo "Envoi du contenu..."
PUSH_RESPONSE=$(curl -s -X POST "$BASE_URL/api/input/content/push" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: zendesk-batch-$(date +%Y%m%d)-001" \
  -d "{
    \"survey_series_id\": \"$SERIES_ID\",
    \"survey_id\": \"$SURVEY_ID\",
    \"question\": {
      \"question_id\": \"$QUESTION_ID\",
      \"content\": [
        \"Le processus de paiement était confus et j'ai abandonné\",
        \"J'adore la nouvelle fonctionnalité de recherche - tellement plus rapide !\",
        \"L'application plante à chaque fois que j'essaie de télécharger un PDF\","}
        "Le support client a résolu mon problème en moins d'une heure",
        "Ce serait génial d'avoir une option mode sombre"
      ]
    },
    "source_reference": "zendesk-export-2024-01-15"
  }")

echo "Résultat du push : $PUSH_RESPONSE"
echo ""
echo "Fait ! Consultez vos retours sur le tableau de bord BoundaryAI."

Assistance

Email : hello@boundary-ai.com
Documentation : docs.boundary-ai.com
Tableau de bord : app.boundary-ai.com

PrécédentGuide de démarrage rapide SuivantWebhooks

Mis à jour il y a 1 mois

hashtagAperçu

hashtagConcepts clés

hashtagComment ça fonctionne

hashtagAuthentification

hashtagClés API

hashtagFormat de la clé

hashtagPermissions de la clé

hashtagObtenir votre clé API

hashtagNotes de sécurité

hashtagFaire des requêtes

hashtagURLs de base

hashtagFormat de la requête

hashtagFormat de la réponse

hashtagRéponse de succès

hashtagRéponse d'erreur

hashtagLimitation de débit

hashtagIdempotence

hashtagRéférence des endpoints

hashtagRéférence rapide

hashtagLister les sources de données

hashtagParamètres de requête

hashtagRéponse

hashtagComprendre la réponse

hashtagExemple

hashtagEnvoyer du contenu

hashtagCorps de la requête

hashtagParamètres

hashtagLimites de contenu

hashtagRéponse

hashtagExemple : Python

hashtagExemple : JavaScript

hashtagExemple : Curl

hashtagEnvoi en bloc de contenu

hashtagCorps de la requête

hashtagParamètres

hashtagRéponse

hashtagCréer un groupe de feedback

hashtagCorps de la requête

hashtagParamètres

hashtagRéponse

hashtagCréer une source de données

hashtagCorps de la requête

hashtagParamètres

hashtagTypes de questions

hashtagRéponse

hashtagPublier une source de données

hashtagCorps de la requête

hashtagRéponse

hashtagWebhooks

hashtagExemple complet

hashtagAssistance

Aperçu

Concepts clés

Comment ça fonctionne

Authentification

Clés API

Format de la clé

Permissions de la clé

Obtenir votre clé API

Notes de sécurité

Faire des requêtes

URLs de base

Format de la requête

Format de la réponse

Réponse de succès

Réponse d'erreur

Limitation de débit

Idempotence

Référence des endpoints

Référence rapide

Lister les sources de données

Paramètres de requête

Réponse

Comprendre la réponse

Exemple

Envoyer du contenu

Corps de la requête

Paramètres

Limites de contenu

Réponse

Exemple : Python

Exemple : JavaScript

Exemple : Curl

Envoi en bloc de contenu

Corps de la requête

Paramètres

Réponse

Créer un groupe de feedback

Corps de la requête

Paramètres

Réponse

Créer une source de données

Corps de la requête

Paramètres

Types de questions

Réponse

Publier une source de données

Corps de la requête

Réponse

Webhooks

Exemple complet

Assistance