API Documentation | 2F Valencia

Introducción

Bienvenido a la documentación de la API REST de 2F Valencia. Esta API proporciona acceso programático a los datos de transacciones, vendedores, clientes y productos del sistema.

La API sigue el estándar RESTful y devuelve respuestas en formato JSON. Todas las solicitudes deben incluir el token de autenticación en los headers.

GET /api/status

Verifica el estado de la API. Este endpoint no requiere autenticación.

Ejemplo de Solicitud

curl -X GET "https://api.2fvalencia.com/api/status"

Ejemplo de Respuesta

200 OK

application/json

{
    "status": "online",
    "version": "1.0.0",
    "timestamp": "2023-12-10T10:30:00Z",
    "services": {
        "database": "connected",
        "cache": "online",
        "queue": "idle"
    }
}

Autenticación

Todas las solicitudes a la API (excepto /api/status) requieren autenticación mediante token Bearer.

POST /api/auth/login

Obtén un token de acceso válido para autenticar las solicitudes.

Parámetros

Parámetro	Tipo	Requerido	Descripción
username	string	Requerido	Nombre de usuario del sistema
password	string	Requerido	Contraseña del usuario

Líneas

Endpoints para la gestión de líneas de productos. Permite crear, leer, actualizar y eliminar líneas.

GET /api/lineas

Obtiene la lista completa de líneas, ordenadas por código.

Ejemplo de Respuesta

200 OK

application/json

[
    {
        "codlinea": "L01",
        "nomlinea": "Línea Principal",
        "estatus": "A"
    },
    {
        "codlinea": "L02",
        "nomlinea": "Línea Secundaria",
        "estatus": "A"
    }
]

GET /api/lineas/activos

Obtiene solo las líneas con estatus activo (estatus = 'a').

GET /api/lineas/{codlinea}

Obtiene una línea específica por su código.

Path Parameters

Parámetro	Tipo	Requerido	Descripción
codlinea	string	Requerido	Código de la línea (1-3 caracteres alfanuméricos)

Ejemplo de Solicitud

curl -X GET "https://api.2fvalencia.com/api/lineas/L01"

GET /api/lineas/estatus/{estatus}

Filtra líneas por estatus específico.

Path Parameters

Parámetro	Tipo	Requerido	Descripción
estatus	string	Requerido	Estatus de la línea (A=Activo, I=Inactivo)

POST /api/lineas

Crea una nueva línea de producto.

Body Parameters

Parámetro	Tipo	Requerido	Descripción
codlinea	string	Requerido	Código único de la línea (1-3 caracteres)
nomlinea	string	Requerido	Nombre de la línea (max 30 caracteres)
estatus	string	Opcional	Estatus (default: 'A')

Ejemplo de Solicitud

curl -X POST "https://api.2fvalencia.com/api/lineas" \
  -H "Content-Type: application/json" \
  -d '{
    "codlinea": "L03",
    "nomlinea": "Nueva Línea",
    "estatus": "A"
  }'

PUT /api/lineas/{codlinea}

Actualiza una línea existente. Permite actualización parcial.

Ejemplo de Solicitud

curl -X PUT "https://api.2fvalencia.com/api/lineas/L01" \
  -H "Content-Type: application/json" \
  -d '{
    "nomlinea": "Línea Principal Actualizada"
  }'

DELETE /api/lineas/{codlinea}

Elimina permanentemente una línea del sistema.

Ejemplo de Solicitud

curl -X DELETE "https://api.2fvalencia.com/api/lineas/L01"

Transacciones

Endpoints para consultar y gestionar transacciones históricas.

GET /api/historico/historicodetalle.php

Obtiene el detalle histórico de transacciones con filtros por año y vendedor.

Query Parameters

Parámetro	Tipo	Requerido	Descripción
anio	integer	Opcional	Año de las transacciones
vendedor	string	Opcional	Código del vendedor

Vendedores

GET /api/vendedores/vendedores.php

Obtiene la lista completa de vendedores activos en el sistema.

Detalle Documento

GET /api/historico/detalle.php

Obtiene el detalle completo de un documento específico por número.

Query Parameters

Parámetro	Tipo	Requerido	Descripción
numero	string	Requerido	Número del documento

Clientes

Endpoints para gestión de clientes (en desarrollo).

GET /api/clientes

Obtiene la lista de clientes (próximamente).

Productos

Endpoints para catálogo de productos (en desarrollo).

GET /api/productos

Obtiene el catálogo de productos (próximamente).