API y documentación

Una clave. Cada módulo.

La mayoría del software empresarial ofrece una API por producto —una para la caja, otra para el inventario, una tercera para las facturas—, cada una con su propia autenticación y su propia concepción de la fecha. Kardopal tiene una. La misma clave, la misma URL base y la misma gramática de consulta alcanzan 129 recursos en 29 módulos.

Crear una clave API Vea lo que alcanza
29
Módulos
129
Recursos
1
Clave, una URL base
200
Filas por página, máx.

Por qué vale la pena construir sobre esta API

Seis cosas que son ciertas aquí y que normalmente no lo son.

Se describe a sí mismo

Acceda a la URL base y la API le devolverá su propio catálogo — cada módulo que su clave puede ver, cada recurso dentro de él, qué campos son buscables y cuáles son filtrables. No necesita esta página para escribir la integración; la necesita para decidir hacerlo.

Permisos que realmente restringen

Los alcances, rutas y los permisos en la aplicación se generan a partir de una lista, por lo que un permiso no puede ofrecerse a menos que haya un punto final detrás. Una clave con alcance a artículos obtiene artículos — solicitarle la nómina devuelve 403, no una página vacía y silenciosa.

Una gramática de consulta, en todas partes

Búsqueda, desde, hasta, saltar y obtener significan lo mismo en las facturas que en los movimientos de stock. Aprenda la estructura una vez y cada uno de los 133 recursos responderá a ella.

Tu instancia, y solo la tuya

Cada tabla lleva un ID de inquilino y cada consulta se limita al inquilino propio de la clave antes de llegar a la base de datos. No hay lecturas entre inquilinos que puedan salir mal, porque no hay ningún parámetro que pueda solicitarlas.

Los campos garantizan su integridad

La lista de campos se lee del esquema en vivo al iniciar, en lugar de mantenerse manualmente. Una nueva columna aparece por sí sola; una eliminada nunca puede dejar una referencia colgante en la documentación o un error 500 en la primera llamada.

Solo lectura, a propósito

Las claves leen; nunca escriben. Una integración que falla no puede anular una factura ni mover existencias. Cualquier cambio en un registro pasa por la aplicación o un inicio de sesión del personal, donde se atribuye a una persona y queda en el registro de auditoría.

Empezar en una solicitud

Todo es un GET. Si puede usar curl, puede usar esto.

GET /api/v1Todo el catálogo que su clave puede ver
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/meSonda de cordura: ¿de quién es esta clave y qué puede leer?
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Cualquier recurso, misma forma
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsRecuento de filas por recurso: ve qué datos existen realmente
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

Los cinco parámetros

ParámetroHaceNotas
BúsquedaCoincidencia sin distinción de mayúsculas y minúsculas en los campos de búsqueda del recursoQué campos son esos se lista en /meta
desdeSolo registros a partir de esta fechaSe aplica al campo por el que se ordena el recurso
hastaSolo registros hasta esta fechaCombinar con desde para una ventana
saltarDesplazamiento en el conjunto de resultadosPor defecto es 0
obtenerNúmero de filas a devolverPor defecto 50, con un límite de 200

Los recursos también aceptan filtros de coincidencia exacta en sus propios campos declarados — ?status=pagado, ?warehouseId=… — y cada uno anuncia cuáles son. Cada respuesta de lista contiene total y hayMás, para que la paginación sea un bucle, no una suposición.

Lo que la API alcanza

29 módulos, 129 recursos. Cada tarjeta es un permiso que puedes otorgar a una clave — y la etiqueta gris indica dónde residen los mismos registros en la aplicación de tu teléfono.

Contactos

2

Clientes, proveedores y los segmentos en los que se encuentran.

contactossegmentos de contacto
contactos Contactos

Artículos

7

El catálogo: productos, variantes, marcas, listas de precios y unidades.

artículoscategoríasmarcasvariantes de artículolistas de preciosunidades+1 más
artículos Artículos

Inventario

7

Almacenes, niveles de stock, movimientos, lotes, números de serie y ubicaciones.

almacenesmovimientos-de-stockniveles de stocklotesnúmeros de serierecuentos-de-existencias+1 más
inventario Inventario

Ventas

7

Facturas, presupuestos, pedidos, notas de crédito y pagos.

facturasestimacionespedidos de ventanotas de créditopagosfacturas recurrentes+1 más
ventas Ventas

POS

11

Cajas, turnos, recibos, mesas y cada venta que pasó por el mostrador.

ventas-posturnos de POSterminales-posusuarios-posmesas-posáreas-de-mesas-POS+5 más
pos POS

CRM

4

Leads, acuerdos, embudos de venta y propuestas.

clientes potencialesofertasFlujospropuestas
crm CRM

Compra

5

Pedidos de compra, solicitudes, devoluciones, facturas y pagos a proveedores.

órdenes de comprasolicitudes-de-compradevoluciones-de-compracuentaspagos-a-proveedores
compra Compra

Contabilidad

5

Gastos, cuentas bancarias, transacciones y tipos impositivos.

gastoscategorías-de-gastoscuentas-bancariasbank-transactionstipos impositivos
contabilidad Contabilidad

Marketing

4

Campañas, destinatarios, páginas de destino y envíos de formularios.

campañasdestinatarios-de-campañapáginas de destinoenvíos de formularios
marketing Marketing

HR

8

Personal, departamentos, ausencias, nóminas, asistencia y contratación.

empleadosdepartamentosleave-requestsnóminasAsistenciaofertas-de-empleo+2 más
hr HR

Hoja de horas

2

Registros de tiempo y los proyectos a los que se imputan.

registros-de-tiempoproyectos de hojas de tiempo
hoja de horas Hoja de horas

Proyectos

3

Proyectos, fases y sus costes asociados.

proyectosfases-de-proyectocostos-de-proyecto
proyectos Proyectos

Reservas

3

Citas, servicios reservables y el personal que los presta.

reservasservicios de reservapersonal de reservas
reservas Reservas

Servicio de campo

7

Trabajos, técnicos, órdenes de trabajo, contratos y equipos.

trabajos de campotécnicossolicitudes-de-serviciocontratos de servicioórdenes-de-trabajotarjetas-de-trabajo+1 más
servicio_de_campo Servicio de campo

Logística

5

Envíos, conductores, vehículos, zonas y transportistas.

envíosrepartidoresvehículoszonas-de-entregatransportistas
logística Logística

Mesa de ayuda

5

Tickets, políticas de SLA, artículos de ayuda y la base de conocimientos.

ticketstickets de clienteartículos de ayudabase de conocimientospolíticas de SLA
soporte Mesa de ayuda

Postventa

5

Devoluciones, reclamaciones de garantía, reparaciones y registros de productos.

rmasreclamaciones-de-garantíaregistros de garantíareparacionesregistros-de-productos
posventa Postventa

Alquiler

3

Activos alquilables, contratos de alquiler y sus líneas.

activosalquilereslíneas de alquiler
alquiler Alquiler

Restaurante

2

El menú y los pedidos realizados.

elementos del menúpedidos de menú
restaurante Alimentos y bebidas

Cola

5

Tickets, servicios, mostradores, sucursales y las pantallas de visualización.

tickets de colaservicios-de-colacontadores-de-colasucursales en colapantallas-de-cola
cola Cola

Fidelización

6

Miembros, cuentas, niveles, recompensas y transacciones de puntos.

loyalty-memberscuentas-de-fidelidadrecompensas-por-fidelidadniveles-de-fidelidadtransacciones-de-fidelidadloyalty-coupons
fidelización Fidelización

Ubicaciones

2

Sitios y sucursales.

ubicacionessucursales
ubicaciones Ubicaciones

IOT

6

Dispositivos, sitios, cajas, alertas, eventos y contenido de señalización.

dispositivos-iotiot-sitesalertas-ioteventos-iotcajas iotcontenido-señalización-iot
iot Hub IOT

Estudio de IA

3

Activos generados, los proyectos que los contienen y el historial de trabajos.

activos de IAproyectos-iaai-jobs
ai_studio Estudio de IA

Comercio

3

Miembros de la red, solicitudes de presupuesto y cobros.

miembros-de-redsolicitudes-de-presupuestocolecciones
comercio Comercio

Firma electrónica

2

Solicitudes de firma y las firmas recogidas.

solicitudes de firmafirmas
firma Firma electrónica

Aprobaciones

2

Solicitudes de aprobación y las reglas que las dirigen.

solicitudes-de-aprobaciónreglas de aprobación
aprobaciones Aprobaciones

Archivos

2

Archivos subidos y documentos escaneados.

archivosdocumentos escaneados
archivos Archivos

Actividad

3

El feed de actividad, el registro de auditoría y las notificaciones.

actividadesregistros de auditoríanotificaciones
Por teléfono

Cada módulo que la API lee, su equipo puede abrirlo en su mano

Esta es la parte que normalmente no es cierta. Muchas plataformas exponen una API amplia y luego lanzan una aplicación móvil que hace tres cosas: aprobar, ver, notificar. La aplicación de Kardopal es el producto, no un complemento: los 29 módulos anteriores tienen pantallas reales, y el teléfono es donde la mayor parte del trabajo realmente ocurre.

  • Léelo y luego actúa. Tu integración obtiene un nivel de stock; la persona que debe corregirlo abre el mismo registro, lo ajusta y queda firmado a su nombre.
  • Escanee, capture, firme. El escaneo de códigos de barras, la captura de documentos y la firma electrónica son nativos del teléfono — no tienen un equivalente de escritorio que valga la pena usar.
  • Tolerancia sin conexión en el mostrador. La caja, la pantalla de cocina y el visor de colas siguen funcionando cuando la conexión falla.
  • Mismo inicio de sesión, mismos datos, 20 idiomas. Incluyendo de derecha a izquierda, para que un equipo de habla árabe no lea un diseño invertido.
Ver la plataforma
La aplicación Kardopal ejecutándose en un teléfono

Obtener una clave

Abra la aplicación, vaya a Plataforma → Claves API.Las claves son creadas por un propietario o administrador en tu propio inquilino. Nadie en Kardopal las emite por ti.
Marca solo los módulos que la integración necesita.Un widget de escaparate necesita artículos. No necesita hr. Las claves estrechas fallan de forma segura.
Envíelo como una cabecera, nunca en la URL.X-API-Key: kp_live_… — las cadenas de consulta terminan en registros, proxies e historial del navegador.
Rote creando primero la nueva clave.Ambos funcionan a la vez, para que pueda mover el tráfico y revocar el antiguo sin tiempo de inactividad.

Construye algo sobre ello

La API se autocumenta: crea una clave en la aplicación, apunta curl en la URL base, y devuelve cada módulo, recurso y campo de búsqueda a los que esa clave puede acceder.

Crear una clave API