Schnellstartanleitung

Phase 1: Plattformkonfiguration

Hinweis: Für diese Anleitung richten wir die Struktur manuell in der Weboberfläche ein, um schnell zu starten. Für fortgeschrittene oder skalierte Integrationen können jedoch alle untenstehenden Schritte (Erstellen von Gruppen, Definieren von Datenquellen und Veröffentlichen) programmgesteuert über die API-Endpunkte durchgeführt werden (z. B. /api/input/survey/create).

1. Melden Sie sich bei der BoundaryAI-Plattform an.

2. Erstellen Sie eine Feedback-Gruppe

   Dies dient als Ihr primärer Container (zum Beispiel „Kundensupport-Protokolle“).

3. Erstellen Sie einen Endpunkt (Datenquelle)

   Erstellen Sie innerhalb der Feedback-Gruppe einen neuen Endpunkt (zum Beispiel „Live-Chat-Protokolle“).

   • Klicken Sie auf Feedback sammeln starten → Connectoren → API-Endpunkt

   • Definieren Sie das erwartete Payload-Format für Ihre Daten.

   • Speichern Sie alle geteilten Informationen, da sie für das korrekte Senden der Daten unerlässlich sind

4. Aktivieren Sie fortlaufende Sammlung (optional)

   • Suchen Sie den neu erstellten Endpunkt/Datenquelle.

   • Klicken Sie auf das Drei-Punkte-Menü (…).

   • Öffnen Sie Erweiterte Optionen.

   • Schalten Sie die fortlaufende Feedback-Erfassung auf EIN.

Warum das wichtig ist: Die Aktivierung der fortlaufenden Sammlung weist BoundaryAI an, eingehende Daten als kontinuierlichen Strom statt als einmaligen Upload zu behandeln. Dies ist erforderlich für Langzeitanalysen, Trend­erkennung und Verfolgung von Entwicklungen über die Zeit.

---

Phase 2: Authentifizierung

1. Navigieren Sie zum Reiter Integrationen in der Seitenleiste.

2. Wählen Sie API.

3. Klicken Sie auf API-Schlüssel erstellen.

4. Wählen Sie die Berechtigungsstufe Push (ausreichend zum Senden von Daten) oder Alle.

5. Kopieren Sie den Schlüssel sofort (er beginnt mit inpk_). Dieser Schlüssel wird nicht erneut angezeigt.

---

Phase 3: Integration (Daten senden)

Zum Senden von Daten benötigen Sie drei Kennungen: survey_series_id (Gruppe), survey_id (Quelle) und question_id (Das spezifische Feld für Text & Daten). Diese Felder wurden Ihnen bereitgestellt, als Sie den Endpunkt erstellt haben aber Sie können sie auch mithilfe von GET abrufen Methode.

Daten pushen

Da Sie nun Ihre IDs haben (z. B. Gruppe 101, Umfrage 505, Frage 888), verwenden Sie den Push-Endpunkt, um Daten zu senden.

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

Python-Beispiel:

import requests

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

payload = {
    "survey_series_id": "101",   # Aus Schritt A
    "survey_id": "505",          # Aus Schritt A
    "question": {
        "question_id": "888",    # Aus Schritt A
        "content": [
            "Die Login-Schaltfläche ist auf dem Mobilgerät defekt.",
            "Heute toller Service, danke!",
            "Ich kann die Export-PDF-Funktion nicht finden."
        ]
    },
    # Optional: Verwenden Sie eine eindeutige Referenz für dieses Batch, um Duplikate zu verhindern
    "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())

_{Curl-Beispiel:}

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": [
        "Die Login-Schaltfläche ist auf dem Mobilgerät defekt.",
        "Heute toller Service, danke!",
        "Ich kann die Export-PDF-Funktion nicht finden."
      ]
    },
    "source_reference": "batch_2023_10_27_001"
  }'

Antwort (JSON-Ausschnitt):

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

---

Zusammenfassung der bewährten Verfahren

• Batching: Sie können bis zu 10.000 Elemente pro Anfrage senden. Sammeln Sie Nutzerkommentare und senden Sie sie in Batches statt einer API-Anfrage pro Kommentar.

• Idempotenz: Fügen Sie stets einen 'Idempotency-Key'-Header hinzu. Wenn ein Netzwerkfehler auftritt und Sie die Anfrage erneut senden, verwendet die API diese Referenz, um das Batch zu erkennen und doppelte Dateneinträge zu verhindern.

• Ratenbegrenzungen: Die API erlaubt 60 Anfragen/Minute pro Schlüssel. Standard ist 60/min, maximal 300/min.