Crol ofrece una API REST que permite a desarrolladores de software integrar sus aplicaciones con los módulos del ERP: ventas, compras, facturación, inventarios, bancos y contabilidad. A través de esta API es posible automatizar flujos de trabajo, sincronizar datos en tiempo real y conectar sistemas externos de forma segura y escalable.
Acceso a la documentación
La documentación técnica completa de la API se encuentra en el siguiente enlace: Documentación de la API de Crol. Ahí encontrarás la referencia de todos los endpoints, ejemplos de solicitudes y respuestas en JSON, esquemas de datos y códigos de estado.
Primeros pasos
Para comenzar a utilizar la API de Crol, sigue estos pasos:
- Obtén tus credenciales de acceso desde tu cuenta de Crol. Necesitarás un usuario y contraseña autorizados para consumir la API.
- Genera tu token de autenticación realizando una petición al endpoint
/api/Auth. El token obtenido deberá enviarse en las cabeceras de cada solicitud posterior. - Verifica tu conexión consultando el endpoint
/api/Health para confirmar que el servicio está disponible. - Consulta los endpoints del módulo que necesites integrar y realiza tus primeras peticiones.
Módulos disponibles en la API
La API está organizada en tres grandes áreas: Configuración (catálogos y datos maestros), Reportes (consultas de información) y Transacciones (operaciones que registran o modifican datos).
Configuración
Endpoints para consultar y administrar los catálogos base del ERP:
- Bancos: Cuentas bancarias, catálogo de bancos y formas de pago.
- Contactos: Clientes, proveedores, clasificadores de contactos y actualización de códigos.
- Ventas: Catálogo de vendedores.
- Productos y servicios: Alta, consulta e imágenes de productos, agrupadores, unidades de medida y clasificaciones.
- Lista de precios: Consulta, creación y actualización de listas de precios.
- Contabilidad: Proyectos, establecimientos (sucursales y ubicaciones), regímenes fiscales, uso de CFDI, centros de costo y conceptos de compra.
- SAT: Formas de pago CFDI y claves de producto SAT.
- Personal de servicio: Consulta y registro de personal asignado a servicios.
Reportes
Endpoints de solo lectura para consultar transacciones y datos operativos:
- Ventas: Facturas de venta, notas de venta, registros de venta, pedidos de cliente, cotizaciones a cliente, antigüedad de saldos y cuentas por cobrar.
- Bancos: Depósitos (individual, por rango), egresos y solicitudes de pago.
- Compras y gastos: Facturas de compra, notas de remisión y órdenes de compra.
- Inventarios: Consulta de existencias, costo identificado, inventario CEDIS, nivel de servicio y análisis de capas.
- Orden de servicio: Consulta de órdenes de servicio registradas.
Transacciones
Endpoints que permiten registrar, modificar y cancelar operaciones:
- Ventas: Registro y cancelación de facturas de venta, notas de venta, pedidos de cliente; facturación de agencia de viajes y escuelas privadas.
- Bancos: Registro de anticipos, depósitos de venta, cancelación de depósitos y egresos; creación y autorización de solicitudes de pago.
- Compras y gastos: Registro y cancelación de facturas de compra, autorización de órdenes de compra, y gastos sobre compra.
- Inventarios: Movimientos de inventario, entregas y recepciones de mercancía, y reempaques.
- Orden de servicio: Creación, actualización, autorización y cierre de órdenes de servicio.
- CFDI: Validación de CFDI, validación de UUID en el SAT y validación de archivos.
Nota: Cada endpoint incluye ejemplos de solicitud y respuesta en formato JSON dentro de la
documentación técnica. Si necesitas credenciales de acceso o tienes dudas sobre la integración, contacta al equipo de soporte de Crol.