Guía de inicio rápido

Fase 1: Configuración de la plataforma

Nota: Para esta guía, configuraremos manualmente la estructura en la interfaz web para comenzar rápidamente. Sin embargo, para integraciones avanzadas o a escala, todos los pasos a continuación (crear grupos, definir fuentes de datos y publicar) pueden realizarse programáticamente mediante los endpoints de la API (p. ej., /api/input/survey/create).

1. Inicia sesión en la plataforma BoundaryAI.

2. Crear un Grupo de Feedback

   Esto sirve como tu contenedor principal (por ejemplo, “Registros de Atención al Cliente”).

3. Crear un Endpoint (Fuente de Datos)

   Dentro del Grupo de Feedback, crea un nuevo endpoint (por ejemplo, “Registros de Chat en Vivo”).

   • Haz clic en Comenzar a recopilar feedback → Conectores → Endpoint de API

   • Define el formato de payload esperado para tus datos.

   • Guarda toda la información compartida, ya que será esencial para enviar los datos correctamente

4. Habilitar la recopilación continua (Opcional)

   • Localiza el Endpoint/Fuente de Datos recién creado.

   • Haz clic en el menú de tres puntos (…).

   • Abre Opciones avanzadas.

   • Activa la recopilación continua de feedback.

Por qué esto importa: Habilitar la recopilación continua indica a BoundaryAI que trate los datos entrantes como un flujo continuo en lugar de una carga única. Esto es necesario para el análisis longitudinal, la detección de tendencias y el seguimiento de la evolución a lo largo del tiempo.

---

Fase 2: Autenticación

1. Navega a la pestaña Integraciones en la barra lateral.

2. Selecciona API.

3. Haz clic en Crear clave API.

4. Selecciona el nivel de permiso Push (suficiente para enviar datos) o All.

5. Copia la clave inmediatamente (comienza con inpk_). Esta clave no se mostrará nuevamente.

---

Fase 3: Integración (Envío de datos)

Para enviar datos, necesitas tres identificadores: survey_series_id (Grupo), survey_id (Fuente), y question_id (El campo específico para texto y datos). Estos campos te fueron proporcionados cuando creaste el endpoint pero también puedes obtenerlos usando GET método.

Enviar datos

Ahora que tienes tus IDs (p. ej., Grupo 101, Serie de encuesta 505, Pregunta 888), usa el endpoint push para enviar datos.

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

Ejemplo en Python:

import requests

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

payload = {
    "survey_series_id": "101",   # De la Paso A
    "survey_id": "505",          # De la Paso A
    "question": {
        "question_id": "888",    # De la Paso A
        "content": [
            "El botón de inicio de sesión está roto en móvil.",
            "Gran servicio hoy, ¡gracias!",
            "No puedo encontrar la función de exportar PDF."
        ]
    },
    # Opcional: Usa una referencia única para este lote para evitar duplicados
    "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())

_{Ejemplo 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": [
        "El botón de inicio de sesión está roto en móvil.",
        "Gran servicio hoy, ¡gracias!",
        "No puedo encontrar la función de exportar PDF."
      ]
    },
    "source_reference": "batch_2023_10_27_001"
  }'

Respuesta (Fragmento JSON):

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

---

Resumen de mejores prácticas

• Agrupamiento: Puedes enviar hasta 10.000 ítems por solicitud. Acumula los comentarios de los usuarios y envíalos en lotes en lugar de una llamada API por comentario.

• Idempotencia: Incluye siempre un encabezado 'Idempotency-Key'. Si ocurre un error de red y reintentas la solicitud, la API utilizará esta referencia para reconocer el lote y prevenir la entrada de datos duplicados.

• Límites de tasa: La API permite 60 solicitudes/minuto por clave. El valor predeterminado es 60/min, el máximo es 300/min.