Saltar a contenido

Glosario

Término Definición
Kordata ERP ERP en la nube de Kordata para ventas, facturación, inventario y operaciones empresariales. Este portal documenta solo la capa de integración REST.
API Gateway Punto de entrada HTTP (https://api.kordata.mx) que expone la API REST versionada de Kordata, autentica cada petición y devuelve respuestas en formato uniforme (data + meta).
API Key Credencial enviada en el header x-api-key que identifica a su empresa y los permisos de módulo/ruta habilitados en su contrato.
Contrato API Conjunto acordado de rutas, métodos HTTP, formatos JSON y versión (v1) que su integración puede consumir.
Endpoint Ruta HTTP concreta del gateway (p. ej. GET /productos/{id}).
RequestId Identificador único en meta.requestId para trazabilidad y soporte técnico.
x-api-version Header obligatorio que fija la versión del contrato; use v1 en todas las peticiones.
Autenticación Verificación de identidad mediante API Key válida y activa.
Autorización Comprobación de que su API Key tiene permiso para el módulo o endpoint solicitado (errores 403).
Body / payload Cuerpo JSON enviado en peticiones POST, PUT o PATCH.
Listado paginado Respuestas de colección con content, totalElements, page y size.
Rate limit Límite de peticiones por API Key; al superarlo el gateway responde HTTP 429.
OpenAPI Especificación machine-readable del contrato; disponible en /openapi/v1.json y en el explorador Scalar.

Ver también Preguntas frecuentes y Autenticación.