API de envíos
ProDisponible en el plan Pro — próximamente
Además del endpoint público de envío (POST /api/v1/submit), Farvane tendrá una API de solo lectura para consultar tus formularios y envíos programáticamente: sincronizarlos con un CRM, volcarlos a una hoja de cálculo o construir tu propio panel sobre ellos. El contrato de abajo ya está fijado para que no cambie cuando se active — puedes diseñar tu integración contra esta referencia desde ahora.
Base URL
https://api.farvane.com/v1 — un prefijo distinto del endpoint público de envío (api.farvane.com/api/v1/submit, sin /v1 y sin autenticación). El prefijo v1 sin /api marca claramente que esta es la API autenticada de lectura.
Autenticación
Cada petición debe incluir tu clave personal en la cabecera Authorization: Bearer frv_live_<tu_clave>. La clave se generará desde Cuenta → Claves API en el dashboard cuando esta feature esté disponible.
Authorization: Bearer frv_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxEndpoints
| Método | Ruta | Qué hace |
|---|---|---|
GET | /v1/forms | Lista los formularios de tu cuenta, con el recuento total de envíos (total_count) de cada uno. |
GET | /v1/submissions?form_id=&limit=&cursor= | Lista envíos, paginados por cursor (has_more, next_cursor) en vez de número de página — evita duplicados o huecos si llegan envíos nuevos entre páginas. |
GET | /v1/submissions/{id} | Un envío concreto por id. |
Errores
Todos los errores comparten el mismo sobre:
{"error":{"code":"not_found","message":"Submission not found"}}| Código | code | Cuándo ocurre |
|---|---|---|
400 | bad_request | Parámetros inválidos (por ejemplo, un cursor mal formado). |
401 | unauthorized | La clave falta o no es válida. |
403 | forbidden | La clave es válida pero no tiene acceso a ese recurso. |
404 | not_found | El formulario o el envío no existen. |
429 | rate_limit_exceeded | Demasiadas peticiones para esta clave. |
500 | server_error | Error interno. |
Mientras tanto
Cada formulario puede enviarte los envíos en cuanto llegan mediante un webhook, y la bandeja de cada formulario se exporta a CSV desde el dashboard — sin esperar a esta API.