API RESTFUL • DOCUMENTACIÓN DE INTEGRACIÓN • VER 2026

DEVELOPER HUB

NexGestion expone una API REST robusta diseñada para la interoperabilidad total. Desde la captura de leads hasta la gestión de módulos de terceros, cada interacción está gobernada por contratos JSON estrictos y seguridad por scopes.

Flujo de Desarrollo

Las 5 Fases de Integración

FASE 1

Autenticación y Seguridad

Todas las peticiones requieren una API Key válida gestionada desde el panel de administración. Aceptamos Bearer tokens o headers personalizados.

Authorization: Bearer nex_live_xxxxxxxxxxxx
# O bien
X-API-Key: nex_live_xxxxxxxxxxxx
            

Health Check: Utilice GET /api/v1/ping para validar la conectividad sin requerir auth.

FASE 2

Descubrimiento (Capabilities)

Antes de operar, su aplicación debe consultar sus capacidades permitidas. El endpoint de capabilities devuelve los módulos instalados y los scopes asignados a su key.

GET /api/v1/capabilities
FASE 3

Integración de Recursos Core

NexGestion ofrece recursos estándar para el ciclo de vida comercial:

  • /prospects: Captura de nuevos leads.
  • /clients: Gestión de la cartera consolidada.
  • /tickets: Soporte y atención al cliente.
FASE 4

Extensibilidad de Módulos

Si está desarrollando un módulo propio, siga este checklist para exponer sus datos:

  1. Cree el recurso en api/resources/NombreResource.php.
  2. Registre las rutas en api/index.php bajo el prefijo /v1.
  3. Proteja cada acción con Auth::requireScope('modulo:read').
  4. Añada la definición en api/openapi.json.
FASE 5

Validación y Contrato

Todas las respuestas siguen un formato predecible. El request_id es obligatorio para el soporte técnico.

{
  "ok": true,
  "message": "Operación exitosa",
  "data": { ... },
  "request_id": "req_550e8400"
}
            
Referencia Técnica

Especificación OpenAPI 3.0

Puede importar nuestra definición completa en Postman o Swagger UI para generar clientes automáticamente.