API Modulo Forms

API Módulo Forms

Introducción

El API del Módulo Forms permite la consulta, creación y gestión de los formularios dentro del sistema.

• URL Base: https://api.tudominio.com/v1/
• Formato de respuesta: JSON

Autenticación

Todas las peticiones a los endpoints protegidos deben incluir un token JWT en las cabeceras (headers) de la petición.

Authorization: Bearer TU_TOKEN_AQUI

---

Endpoints

1. Obtener lista de formularios

Retorna una lista paginada de los formularios disponibles.

• Endpoint: /forms
• Método: GET

Parámetros de Consulta (Query Params)

Parámetro	Tipo	Obligatorio	Descripción
limit	Integer	No	Cantidad máxima de registros a devolver (por defecto: 20).
status	String	No	Filtra por estado (ej. active, archived).

Respuesta Exitosa

• Código: 200 OK
• Cuerpo:

{
  "success": true,
  "data": [
    {
      "_id": "60d5ecb8b392d7",
      "title": "Inspección de Calidad",
      "createdAt": "2026-08-21T10:00:00Z"
    }
  ]
}

2. Crear un nuevo formulario

Permite registrar la estructura de un nuevo formulario.

• Endpoint: /forms
• Método: POST

Cuerpo de la Petición (Payload)

{
  "title": "Formulario de Novedades",
  "fields": ["empleado_id", "fecha", "descripcion"]
}

Respuesta Exitosa

• Código: 201 Created

---

Códigos de Error Frecuentes

Código HTTP	Mensaje	Descripción
400	Bad Request	La petición está mal formada o faltan campos obligatorios.
401	Unauthorized	El token de acceso es inválido o ha expirado.
500	Internal Server Error	Error interno en el servidor de la aplicación.