API: interfaz de programación de aplicaciones

Tema
Herramientas y ajustes de encuestas
Contenidos

Qué es una API

Una API (interfaz de programación de aplicaciones) es un conjunto de reglas que permite que un programa pida datos o acciones a otro. En lugar de que una persona haga clic en pantallas, tu aplicación envía una solicitud y recibe una respuesta estructurada, casi siempre en JSON.

Una API web funciona sobre HTTP. El cliente llama a una dirección (un endpoint) con un método como GET o POST y una clave que demuestra quién es. El servidor revisa la clave y devuelve los datos o un código de error, por ejemplo 401 si la clave falta o es incorrecta.

Cómo funciona en SurveyNinja

  • La API REST está disponible en todos los planes, incluido el Gratuito, y devuelve JSON.
  • Creas la clave en el menú del perfil, en API / MCP, y la envías en el encabezado Authorization de cada solicitud. Una cuenta puede tener hasta 5 claves.
  • Con la API puedes listar encuestas, leer respuestas, descargarlas en CSV o Excel y gestionar variables ocultas y webhooks.
  • Cada solicitud devuelve hasta 100 respuestas. Para el resto, usa limit y offset.
  • La misma clave conecta asistentes de IA como Claude o Cursor mediante MCP.

Los pasos están en el artículo de ayuda API, y todos los endpoints, en la referencia de la API. Para asistentes de IA, consulta Conectar asistentes de IA (MCP).

API o webhook

Con una API, tu sistema pide los datos cuando los necesita. Un webhook funciona al revés: SurveyNinja envía cada respuesta completa a tu dirección en cuanto llega. Usa la API para sincronizaciones e informes periódicos, y un webhook cuando cada respuesta tenga que llegar de inmediato a tu CRM.

Consejos

  • Guarda la clave como una contraseña. Las solicitudes con ella tienen el mismo acceso que el propietario del espacio de trabajo, y solo se muestra una vez.
  • Para cortar el acceso de una aplicación, elimina su clave. Las solicitudes con una clave eliminada reciben el código 401.
0