Descripción general de la API

Endpoint

Todas las solicitudes van a una única URL mediante POST. Pasa el nombre del método y los parámetros en JSON.

POST https://api.formbase.so/api/v1

Autenticación

Pasa tu token de API como bearer token en el encabezado Authorization. Los tokens están vinculados a un espacio de trabajo — créalos desde OAuth y claves de API en la barra lateral.

curl -X POST https://api.formbase.so/api/v1 \
  -H "Authorization: Bearer fb_..." \
  -H "Content-Type: application/json" \
  -d '{"method": "forms.list", "params": {}}'

const res = await fetch('https://api.formbase.so/api/v1', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.FORMBASE_TOKEN}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ method: 'forms.list', params: {} }),
})
const data = await res.json()

import os, requests
res = requests.post(
    "https://api.formbase.so/api/v1",
    headers={"Authorization": f"Bearer {os.environ['FORMBASE_TOKEN']}"},
    json={"method": "forms.list", "params": {}},
)
data = res.json()

Formato de solicitud

Cada solicitud es un objeto JSON con dos campos:

{
  "method": "forms.list",
  "params": {
    "workspaceId": "abc123..."
  }
}

Formato de respuesta

Cada respuesta es un objeto JSON con un campo ok. En caso de éxito:

{
  "ok": true,
  "data": { ... }
}

Errores

En caso de fallo, ok es false y un objeto error contiene un código legible por máquina y un mensaje legible por humanos:

{
  "ok": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Field 'name' is required."
  }
}

Códigos de error comunes:

• VALIDATION_ERROR (400) — parámetros inválidos o faltantes

• UNAUTHORIZED (401) — token de API ausente o inválido

• UPGRADE_REQUIRED (402) — la funcionalidad requiere un nivel de suscripción superior

• FORBIDDEN (403) — el token no tiene acceso al recurso

• CONFLICT (409) — conflicto de estado del recurso, como un nombre duplicado

• NOT_FOUND (404) — el recurso no existe

• METHOD_NOT_FOUND (404) — nombre de método desconocido

• RATE_LIMITED (429) — demasiadas solicitudes

• INTERNAL_ERROR (500) — error inesperado del servidor

Límites de velocidad

Las solicitudes a la API están limitadas a 120 solicitudes por minuto por token. Superar el límite devuelve 429 Too Many Requests.

Próximos pasos