API TitanicSoft - Synergy

Estructura de la API

La API está organizada en tres secciones principales para facilitar la integración:

Autenticación

Sistema de autenticación JWT para asegurar todas las comunicaciones entre sistemas. Ver documentación →

Configuración

Endpoints para gestionar entidades maestras: artículos, personas, tipos de gasto y vehículos. Ver endpoints →

Operaciones

Endpoints para transacciones del negocio: guías de remisión, órdenes, movimientos de caja y viajes. Ver endpoints →

---

Características Principales

🔒 Seguridad

• Autenticación JWT
• Rate limiting
• HTTPS en producción
• Tokens con expiración

📡 Comunicación

• Formato JSON estándar
• Codificación UTF-8
• Respuestas consistentes
• Códigos HTTP estándar

🔄 Sincronización

• Bidireccional
• Idempotencia garantizada
• Manejo de conflictos
• Validaciones exhaustivas

📊 Endpoints

• 25 endpoints documentados
• Ejemplos completos
• Validaciones detalladas
• Casos de error

---

Convenciones Generales

Códigos de Estado HTTP

Código	Significado
200	OK - Solicitud exitosa (actualización)
201	Created - Recurso creado exitosamente
400	Bad Request - Error en los datos enviados
401	Unauthorized - Error de autenticación
404	Not Found - Recurso no encontrado
405	Method Not Allowed - Método HTTP no permitido
409	Conflict - Conflicto con recurso existente
429	Too Many Requests - Límite de peticiones excedido
500	Internal Server Error - Error interno del servidor

Métodos HTTP

• POST: Crear un nuevo recurso (requiere que el recurso NO exista)
• PUT: Actualizar un recurso existente (requiere que el recurso SÍ exista)
• DELETE: Anular/Eliminar un recurso
• GET: Obtener información de recursos

Formato de Respuestas

Todas las respuestas siguen un formato estándar:

{
    "codigo_http": 200,
    "estado": "success",
    "mensaje": "Descripción del resultado",
    "datos": {}
}

---

Inicio Rápido

1. Obtener Autenticación

Empieza leyendo la documentación de autenticación para obtener tu token de acceso.

2. Configurar Entidades Base

Crea las entidades maestras necesarias en la sección de Configuración.

3. Realizar Operaciones

Una vez configurado, puedes realizar transacciones en la sección de Operaciones.

---

Requisitos Técnicos

• ✅ Todas las peticiones deben incluir el header de autenticación
• ✅ El formato de datos debe ser JSON
• ✅ La codificación debe ser UTF-8
• ✅ Se requiere conexión HTTPS en producción
• ✅ Implementar manejo de errores robusto
• ✅ Respetar límites de rate limiting

---

Soporte

Para soporte técnico o consultas sobre la integración, contactar al equipo de TitanicSoft.

Última actualización: Enero 2026