Cómo usar la API de Dolibarr para automatizar sus procesos.

Sincroniza tus clientes, crea facturas automáticamente, conecta tu sitio web con tu ERP… La API REST de Dolibarr te abre las puertas a la automatización. Aquí tienes una guía completa para empezar y liberar tiempo en tareas repetitivas.

Automatización · API REST · Dolibarr · Nivel intermedio

1. ¿Qué es la API REST de Dolibarr?

2. ¿Por qué automatizar sus procesos con la API?

3. Paso 1: Activar el módulo de la API REST

4. Paso 2: Genera y protege tu clave API.

5. Paso 3: Descubra la API de Explorer

6. Comprender los puntos finales y su estructura.

7. Paso 4: Tus primeras peticiones en la práctica

8. Escenarios concretos de automatización

9. Gestión de errores, respuestas y operaciones entre múltiples empresas

10. Mejores prácticas para la automatización sostenible

11. Preguntas frecuentes

12. Conclusión: Deje que Dolibarr trabaje para usted.

¿Cuántas horas dedicas cada semana a copiar información de un programa a otro? ¿A crear manualmente registros de clientes, generar facturas una por una, exportar y luego reimportar datos entre tu sitio web y tu herramienta de gestión? Estas tareas repetitivas, además de consumir mucho tiempo, son fuente de errores y frustración.

La solución tiene un nombre: automatización . Y para los usuarios de Dolibarr, se basa en una herramienta potente y a menudo subestimada: la API REST . Integrada en el núcleo del software, esta interfaz de programación permite que otras aplicaciones se comuniquen directamente con su Dolibarr, leyendo y escribiendo datos sin intervención manual.

En esta guía completa, desmitificaremos la API de Dolibarr. Descubrirás qué es una API REST, cómo activarla y protegerla, cómo realizar tus primeras solicitudes y, lo más importante, cómo usarla eficazmente para automatizar tus procesos de negocio. Solo necesitas unos pocos conceptos técnicos básicos: te explicamos cada paso. Al finalizar, podrás transformar horas de trabajo manual en unas pocas líneas de código que se ejecutan automáticamente.

¿Qué es la API REST de Dolibarr?

Comencemos por lo básico. Una API (Interfaz de Programación de Aplicaciones) es un conjunto de reglas que permite que dos programas informáticos se comuniquen entre sí. En lugar de navegar por una interfaz, un programa envía solicitudes estructuradas y recibe respuestas, todo de forma automática.

La API de Dolibarr se basa en REST , un estándar web que utiliza solicitudes HTTP, las mismas que usa tu navegador. El intercambio de datos se realiza en formato JSON , un formato de texto ligero y legible compatible con prácticamente todos los lenguajes de programación. En la práctica, esto significa que puedes controlar Dolibarr desde un script de PHP, Python o JavaScript, o incluso desde una sencilla herramienta de línea de comandos.

Esta API, integrada de forma nativa en Dolibarr desde hace varias versiones, proporciona acceso a la mayoría de las funcionalidades del software: terceros, productos, pedidos, facturas, usuarios y mucho más. Es la piedra angular de cualquier integración y automatización de su ERP.

Las cuatro operaciones fundamentales

La API se basa en cuatro acciones básicas, que corresponden a métodos HTTP. A menudo se las denomina operaciones CRUD (Crear, Leer, Actualizar, Eliminar):

•     GET — leer datos (consultar la lista de clientes, recuperar una factura).

•     POST : crea un nuevo elemento de datos (agrega un producto, crea un tercero).

•     PUT — actualiza los datos existentes (modifica una factura).

•     ELIMINAR — elimina un dato.

¿Por qué automatizar sus procesos con la API?

Antes de adentrarnos en los detalles técnicos, analicemos los beneficios concretos. La automatización mediante API no es un lujo para los desarrolladores: es una herramienta de productividad con resultados muy reales.

Ahorra tiempo valioso

Cada tarea repetitiva automatizada libera tiempo para tu negocio. Sincronizar cientos de clientes, generar docenas de facturas, actualizar un catálogo de productos: lo que antes llevaba horas ahora lleva segundos, sin necesidad de supervisión.

Eliminar errores de entrada

La reintroducción manual de datos es la principal causa de errores: un dígito intercambiado, una línea olvidada, un duplicado. Al permitir que un programa transfiera la información, se garantiza la coherencia y fiabilidad de los datos en todas las herramientas utilizadas.

Conecta tu ecosistema

La API permite que Dolibarr se comunique con el resto de su software: su sitio de comercio electrónico , su herramienta de contabilidad, su CRM, una aplicación móvil personalizada o plataformas de automatización. Su ERP deja de ser un sistema aislado y se convierte en el centro neurálgico de un sistema conectado.

Trabajando en tiempo real

Un pedido realizado en tu sitio web crea instantáneamente el cliente y el pedido en Dolibarr. Un pago recibido actualiza la factura. Esta sincronización en tiempo real te proporciona una visión siempre actualizada de tu negocio y optimiza todas tus operaciones.

Paso 1: Activar el módulo de la API REST

Primero, debes activar la API en Dolibarr. Ve a Inicio → Configuración → Módulos/Aplicaciones , luego busca y activa el módulo de Servicios Web de la API REST . Esta operación requiere privilegios de administrador.

Una vez activado el módulo, verifique que la API responda. Se encuentra disponible en la dirección /api/index.php de su instalación. Si Dolibarr se ejecuta en Apache, la API generalmente está disponible sin configuración adicional. Con Nginx, puede ser necesario ajustar la configuración del servidor para permitir el acceso a las solicitudes de la API.

Paso 2: Genera y protege tu clave API.

autenticación mediante clave API (un token). Cada usuario puede tener una o más claves. Para generar una, inicia sesión, abre el perfil del usuario en Usuarios y Grupos , ve a la pestaña Clave API y genérala. Copia esta clave y guárdala en un lugar seguro.

Esta clave debe acompañar a cada una de sus solicitudes. Se transmite en una cabecera HTTP específica:

Fundamentalmente, la autenticación está vinculada a los derechos del usuario. La clave hereda los permisos del usuario que la generó. Por lo tanto, una solicitud solo puede realizar las acciones que dicho usuario está autorizado a llevar a cabo en Dolibarr. Este es un mecanismo de seguridad fundamental que debe utilizarse con criterio.

Buenas prácticas de seguridad

Una clave API es tan sensible como una contraseña. Se deben seguir algunas reglas para evitar que tu punto de acceso se convierta en una vulnerabilidad de seguridad:

•     Cree un usuario de API dedicado con solo los permisos estrictamente necesarios para la automatización prevista. Nunca utilice una cuenta de administrador.

•     Utilice una clave por aplicación . En caso de vulneración de seguridad, puede revocar la clave en cuestión sin que ello afecte a otras integraciones.

•     Nunca exponga la clave en el código del lado del cliente (JavaScript del navegador, aplicación pública) donde pueda ser visible.

•     Implemente HTTPS para cifrar la transmisión de la clave y los datos.

•     Reemplace las llaves periódicamente para limitar los riesgos en caso de fugas.

Paso 3: Descubra la API de Explorer

Dolibarr incluye una herramienta fantástica para explorar y probar la API sin escribir una sola línea de código: el Explorador de API , basado en la interfaz Swagger. Puedes acceder a él en /api/index.php/explorer/ en tu instalación.

Este explorador muestra todos los puntos de acceso disponibles en tu instalación, junto con su documentación generada automáticamente a partir del código. Además, ofrece formularios interactivos de prueba que te permiten ejecutar una solicitud real directamente desde tu navegador y ver la respuesta. Es el lugar ideal para comprender la estructura de datos y probar tus llamadas antes de programarlas.

Comprender los puntos finales y su estructura

Un endpoint (o punto de acceso) es una URL que corresponde a un tipo de dato. En Dolibarr, siguen una estructura consistente, organizada por módulo. La URL base siempre es /api/index.php/ , seguida del nombre del recurso. Estas son las más comunes:

Cada punto final acepta diferentes métodos HTTP según la acción deseada. Para acceder a un elemento específico, se añade su identificador a la URL: una solicitud para la factura número 42 se dirigirá, por lo tanto, a la ruta que contiene la factura, seguida de dicho identificador.

Paso 4: Tus primeras peticiones en la práctica

Pasemos ahora a la aplicación práctica con la herramienta más universal: cURL, disponible mediante la línea de comandos en la mayoría de los sistemas. Los siguientes ejemplos pueden adaptarse a cualquier lenguaje de programación.

Leer datos (GET)

Para obtener la lista de sus terceros, basta con una simple solicitud GET con su clave:

Dolibarr devuelve un array JSON con los terceros participantes y todos sus campos. Puedes refinar la consulta con parámetros de ordenación, limitación o filtrado para obtener solo la información que te interesa.

Crear un dato (POST)

Para crear un nuevo producto, se envía una solicitud POST junto con un cuerpo JSON que describe el objeto:

Actualizar (PUT) y eliminar (DELETE)

El proceso de actualización sigue la misma lógica utilizando el método PUT, apuntando al ID del elemento y enviando solo los campos que se van a modificar. La eliminación, por otro lado, utiliza el método DELETE en la URL del elemento en cuestión. En todos los casos, la clave API debe acompañar la solicitud, y los permisos del usuario determinan el éxito de la operación.

Escenarios de automatización concretos

Ahora que ya hemos cubierto los conceptos básicos, veamos cómo todo esto se traduce en beneficios reales. Estas son algunas de las automatizaciones más útiles.

Sincroniza tu tienda online

Por cada pedido realizado en tu sitio de comercio electrónico, un script llama a la API para crear automáticamente un cliente si aún no existe y, a continuación, guarda el pedido en Dolibarr. Tu sistema ERP refleja tus ventas en tiempo real, sin necesidad de introducir datos manualmente. Además, puedes sincronizar tu catálogo de productos desde Dolibarr a tu tienda online para mantener la información de los productos siempre actualizada.

Generar y enviar facturas automáticamente

Para suscripciones o servicios recurrentes, un script programado puede generar las facturas correspondientes cada mes a través de la API y, posteriormente, activar su validación. El tiempo dedicado a la facturación recurrente se reduce prácticamente a cero.

Rellenar un panel externo

¿Desea realizar un seguimiento de sus indicadores clave de rendimiento (KPI) en una herramienta de visualización o en una hoja de cálculo compartida? Un script consulta periódicamente la API para extraer ingresos, facturas impagadas o nuevos pedidos, y actualiza su panel de control. Sus datos de rendimiento siempre estarán al día.

Conectando Dolibarr con plataformas de automatización

Las plataformas de automatización sin código permiten conectar Dolibarr con cientos de otros servicios a través de su API. Esto te permite activar una notificación cuando se paga una factura, crear una tarea en tu herramienta de gestión de proyectos para cada nuevo pedido o notificar a tu equipo por correo electrónico. Las posibilidades son prácticamente ilimitadas.

Gestión de errores, respuestas y gestión de múltiples empresas

Si utiliza Dolibarr en modo multicompañía, la API gestiona este escenario mediante un encabezado específico, DOLAPIENTITY , que le permite seleccionar la entidad relevante para la solicitud. Esto le permite administrar varias empresas desde un único marco de automatización.

En la respuesta, la API siempre devuelve JSON, acompañado de un código de estado HTTP que indica el resultado: un código de éxito si la operación se realizó correctamente o un código de error si se produjo algún problema (clave no válida, permisos insuficientes, datos no encontrados, solicitud mal formada). Su código debe comprobar siempre este estado antes de utilizar la respuesta.

Una gestión eficaz de errores es fundamental para una automatización fiable. Planifique siempre cómo abordar los fallos: registre el error, vuelva a intentarlo si procede y genere una alerta si el problema persiste. Una automatización que falla silenciosamente es más peligrosa que la ausencia total de automatización.

Mejores prácticas para la automatización sostenible

Para garantizar que sus automatizaciones sigan siendo fiables y fáciles de mantener a lo largo del tiempo, tenga en cuenta estos principios:

1.    Realice siempre las pruebas primero en el Explorador de Windows. Valide cada solicitud en la API del Explorador antes de integrarla en un script.

2.    Trabaja en un entorno de prueba. Nunca desarrolles tus scripts directamente en tu entorno de producción de Dolibarr.

3.    Limite los derechos del usuario de la API. El principio del mínimo privilegio reduce el impacto de una posible vulneración de seguridad.

4.    Registra tus llamadas. Mantener un registro de las solicitudes facilita enormemente la depuración.

5.    Gestiona los volúmenes de forma responsable. Para tareas de procesamiento de gran volumen, pagina tus consultas y evita sobrecargar el servidor.

6.    Documenta tus integraciones. Anota qué hace cada script y qué clave utiliza: te lo agradecerás en el futuro.

Preguntas frecuentes

¿Necesitas saber programar para usar la API de Dolibarr?

Para explorar y realizar pruebas, no: la API Explorer permite realizar solicitudes desde el navegador sin necesidad de código. Para una automatización completa, se requieren conocimientos de programación o el uso de una plataforma de automatización sin código. Los conceptos básicos son suficientes para empezar: la API REST es un estándar sencillo y bien documentado.

¿Está disponible la API en todas las versiones de Dolibarr?

La API REST se ha integrado en el núcleo de Dolibarr desde hace varias versiones y ahora es un módulo estándar. Simplemente actívela en la configuración. Asegúrese de mantener su instalación actualizada para beneficiarse de las últimas correcciones y la compatibilidad con todos los endpoints.

¿Qué debo hacer si una solicitud devuelve un error de permisos?

Un error de permisos significa que el usuario asociado a la clave API no tiene autorización para realizar la acción solicitada. Verifique los permisos de este usuario en Dolibarr y otórguele los derechos necesarios, pero no más de los estrictamente requeridos.

¿Puedo conectar Dolibarr a mi sitio web sin tener que desarrollarlo yo mismo?

Sí. Existen conectores para muchas plataformas de comercio electrónico, y las herramientas de automatización sin código permiten conectar Dolibarr con otros servicios a través de su API, sin necesidad de escribir código. Sin embargo, para necesidades muy específicas, el desarrollo a medida sigue siendo la opción más flexible.

Conclusión: Deja que Dolibarr trabaje para ti.

La API REST de Dolibarr es una herramienta invaluable para quienes buscan automatizar sus procesos y ahorrar tiempo. En tan solo unos pasos —activar el módulo, generar una clave, explorar los puntos de acceso y escribir las primeras consultas— podrá automatizar procesos que eliminen la entrada manual de datos, garanticen la fiabilidad de los mismos y conecten su ERP con el resto de su ecosistema.

La fortaleza de este enfoque reside en su carácter gradual. No es necesario revolucionarlo todo de golpe: comience con una sola automatización, valídela en el Explorador de API y luego impleméntela con confianza. Cada tarea automatizada le permite recuperar tiempo para lo que realmente importa en su negocio.

¿El mejor consejo? Abre hoy mismo el Explorador de API en tu Dolibarr, envía tu primera solicitud GET a tus proveedores externos y observa la respuesta. Este pequeño paso te dará una idea del potencial que tienes a tu alcance y te motivará a ir más allá. Tu ERP está listo para trabajar para ti, solo tienes que darle las instrucciones.