Saltar al contenido principal
API Documentation

Autenticación

La API de WorkFlows usa autenticación Bearer Token. Genera una API key desde el Dashboard, inclúyela en cada request, y gestiona los límites de tu plan.

Obtener una API Key

Las API keys se generan desde Dashboard → Desarrolladores → API Keys. Solo los usuarios con rol admin pueden crear o revocar keys.

La key completa solo se muestra una vez al momento de la creación. Cópiala y guárdala en un lugar seguro. Si la pierdes, tendrás que crear una nueva.

El formato de las keys es: wf_live_<64 hex chars>. Internamente se almacena un hash SHA-256 — WorkFlows nunca guarda la key en texto plano.

Usar la API Key

Incluye tu API key en el header Authorization de cada request:

cURL
curl https://www.workflows.com.es/api/v1/projects \
  -H "Authorization: Bearer wf_live_abc123..."
JavaScript (fetch)
const res = await fetch("https://www.workflows.com.es/api/v1/projects", {
  headers: {
    "Authorization": "Bearer wf_live_abc123...",
    "Content-Type": "application/json",
  },
});
const { data, meta } = await res.json();
Python (requests)
import requests

headers = {"Authorization": "Bearer wf_live_abc123..."}
r = requests.get("https://www.workflows.com.es/api/v1/projects", headers=headers)
data = r.json()["data"]

Requisitos de plan

La API REST está disponible a partir del plan Business. Los planes inferiores recibirán 403 PLAN_UPGRADE_REQUIRED en cada llamada.

Rate Limits

Los límites se aplican por organización, por minuto. Cada response incluye headers con el estado del rate limit:

PlanLímiteNota
FreeAPI no disponible
StarterAPI no disponible
ProAPI no disponible
TeamAPI no disponible
Business120 req/min
Enterprise600 req/min

Headers de rate limit en cada response:

Response Headers
X-RateLimit-Limit: 120          # Requests permitidos por minuto
X-RateLimit-Remaining: 87       # Requests restantes en la ventana actual
X-RateLimit-Reset: 1716134400   # Unix timestamp cuando se reinicia la ventana
Cuando recibes 429, el header Retry-After indica cuántos segundos esperar antes de reintentar.

Códigos de error

Todos los errores siguen el mismo formato JSON:

Error Response Format
{
  "error": "Descripción legible del error",
  "code": "ERROR_CODE"
}
StatusCodeDescripción
401UNAUTHORIZEDAPI key ausente, inválida o expirada.
403PLAN_UPGRADE_REQUIREDEl plan actual no tiene acceso a la API. Actualiza a Business o Enterprise.
404NOT_FOUNDEl recurso no existe o no pertenece a tu organización.
422VALIDATION_ERRORCampos requeridos faltantes o valores inválidos.
429RATE_LIMITEDLímite de requests excedido. Espera el tiempo indicado en Retry-After.
503SERVICE_UNAVAILABLEServicio de IA no configurado en esta instancia.

Base URL

Todos los endpoints de la API v1 están bajo:

Base URL
https://www.workflows.com.es/api/v1

Por ejemplo, para listar alertas: GET /api/v1/alerts