API REST

Cuando necesites mostrar respuestas en tu propia web o importarlas en tu sistema de forma programada, usa la API REST. Devuelve JSON, se autentica con una clave de API y admite los mismos filtros que ya conoces de la tabla de resultados.

Dato útil: el editor y la cuenta de Gatherino están disponibles en inglés o checo. Los formularios que rellenan quienes responden pueden mostrarse en 18 idiomas, incluido el español.

Qué puede hacer la API

  • Lista los formularios de un espacio de trabajo y obtén un formulario concreto con su estructura.
  • Lista respuestas con filtros: por formulario, estado, intervalo de fechas y búsqueda de texto completo, además de ordenación.
  • Obtén una respuesta concreta.
  • Actualiza el estado de una respuesta.
  • Envía respuestas a un formulario por programación: útil para migraciones o para una interfaz personalizada.

Obtener respuestas

Autenticación con la cabecera Authorization (también funciona una cabecera x-api-key):

curl "https://gatherino.com/api/v1/submissions?formId=FORM_ID&limit=50" \
  -H "Authorization: Bearer gk_your_key"

# response
{ "items": [ { "id": "…", "status": "NEW", "createdAt": "…",
               "data": { "field_1778…": "Jan Vondráček" } } ],
  "total": 672, "page": 1, "limit": 50, "totalPages": 14 }

Primeros pasos

  1. 1

    Crea una clave de API

    En Ajustes → Claves de API. La clave solo se muestra una vez, así que guárdala de inmediato.

  2. 2

    Haz tu primera llamada

    Prueba a listar los formularios para comprobar que la clave funciona y obtener el ID del formulario.

  3. 3

    Asocia los ID de campo con sus etiquetas

    El detalle del formulario devuelve el ID y la etiqueta de cada campo; crea una tabla de correspondencias a partir de ahí. Los ID de campo son estables, así que basta con obtenerlos una vez.

  4. 4

    Gestiona la paginación

    El máximo es de 100 respuestas por petición. Para obtener más datos, recorre las páginas hasta llegar a la última.

La clave de API debe estar en tu servidor, nunca en el JavaScript del navegador: cualquiera podría leerla allí y descargar todas tus respuestas. Si publicas respuestas, muestra solo los campos destinados a publicación, nunca datos personales.

Preguntas frecuentes

¿Cómo se autentica la API?

Con una clave de API: mediante la cabecera Authorization: Bearer <clave> o la cabecera x-api-key. Una clave no válida devuelve 401.

¿Cuántas respuestas se devuelven por petición?

Hasta 100. La respuesta incluye total y totalPages para que puedas recorrer las demás páginas.

¿Por qué las claves de los datos tienen el formato field_1778…?

Son los ID de los campos del formulario. Obtén sus etiquetas del detalle del formulario y guarda la correspondencia en tu sistema.

¿La API admite tildes y otros caracteres especiales?

Sí, todo está en UTF-8, así que el checo y otros idiomas funcionan sin problemas.

Relacionados

Prueba Gatherino gratis

Plan gratuito: 3 formularios y 100 respuestas al mes. Sin tarjeta de crédito. Datos alojados en la UE.

Empieza gratis →