Saltar a contenido

Recetas — Flujos completos paso a paso

Las recetas son guías end-to-end: cada una te lleva de principio a fin a través de un flujo real de integración, con los curl exactos en cada paso. A diferencia de la referencia de endpoints (que documenta cada endpoint por separado), una receta encadena varios endpoints en el orden correcto para lograr un objetivo concreto.

Todas usan la base URL canónica https://api.neuronstudio.ai y autenticación por API Key (X-API-Key). Si todavía no tienes tu key, mira Autenticación y Primeros pasos.

Índice de recetas

# Receta Cuándo usarla
1 Primera integración Tu primera vez. El "happy path" canónico de punta a punta: autenticar → listar agents → armar el CSV → lanzar la campaña → monitorear → leer resultados. Empieza aquí.
2 Probar sin impacto Antes de lanzar una campaña real a tu base completa. Cómo validar el flujo entero con una sola llamada real a tu propio número, de forma segura (no existe un modo sandbox).
3 Sincronizar resultados Cuando ya operas campañas y quieres mantener tu sistema (CRM, data warehouse) al día. Loop de sincronización por polling con paginación por cursor.
4 Carga por archivo CSV Cuando tu CSV es grande, lo exportas directo de Excel, o tu pipeline genera un archivo .csv. Subida multipart vs. CSV inline, y cuándo conviene cada una.

Cómo leer una receta

  • Cada receta arranca con qué vas a lograr y los prerrequisitos.
  • Los pasos van numerados; cada uno trae el curl listo para copiar.
  • En todos los snippets definimos arriba dos variables, para que pegues tu valor una sola vez:
API_BASE_URL="https://api.neuronstudio.ai"
API_KEY="nrn_live_tu_key_aqui"
  • Donde un paso depende del resultado del anterior (por ejemplo, el campaign_id que devuelve start), la receta lo marca explícitamente.

¿Por dónde empiezo?

Si es tu primera integración: Receta 1 — Primera integración. Antes de mandar llamadas reales a tu base completa, pasa por la Receta 2 — Probar sin impacto.

Recuerda: no existe un modo de prueba (dry-run / sandbox). Un start exitoso dispara llamadas reales de inmediato. La Receta 2 te enseña la disciplina segura para validar sin riesgo.