Cómo Utilizar la API REST de Dolibarr para Automatizar Tareas
   03/13/2025 00:00:00     Dolibarr    0 Comentarios
Cómo Utilizar la API REST de Dolibarr para Automatizar Tareas

Dolibarr es un ERP y CRM de código abierto ampliamente utilizado por las empresas para gestionar sus procesos comerciales, financieros y administrativos. Una de sus funciones más potentes es su API REST, que permite a los desarrolladores automatizar tareas e integrar Dolibarr con otras aplicaciones.

En este artículo, explicamos cómo utilizar la API REST de Dolibarr para automatizar tareas comunes, como la gestión de clientes, la creación de facturas, la actualización de productos y la sincronización de datos con servicios externos.

1. Introducción a la API REST de Dolibarr

La API REST de Dolibarr permite interactuar con el sistema a través de solicitudes HTTP. Está diseñada para proporcionar acceso seguro a los datos y funcionalidades de Dolibarr, facilitando la integración con otras herramientas.

Principales funcionalidades de la API REST

  • Gestión de clientes y contactos (agregar, actualizar, eliminar).
  • Creación y actualización de facturas y presupuestos.
  • Gestión de productos y servicios.
  • Acceso a pedidos y pagos.
  • Lectura y escritura de datos contables.

2. Activar la API REST en Dolibarr

Antes de utilizar la API REST, es necesario activarla en Dolibarr y configurar los permisos de acceso.

Pasos para activar la API

  1. Iniciar sesión como administrador en Dolibarr.
  2. Ir a "Inicio" → "Configuración" → "Módulos/Aplicaciones".
  3. Buscar el módulo "API REST" y activarlo.
  4. En la pestaña Configuración, generar una clave API para cada usuario o aplicación que necesite acceso.
  5. Definir los permisos de la API para restringir el acceso a datos sensibles.

Una vez activada, la API estará disponible en la siguiente URL:

plaintext
https://tu-dolibarr.com/api/index.php

3. Autenticación y Seguridad

Dolibarr utiliza un sistema de autenticación basado en tokens para proteger el acceso a la API.

Obtener un token de autenticación

La autenticación se realiza enviando una solicitud POST con las credenciales API:

bash
curl -X POST https://tu-dolibarr.com/api/index.php/login \ -H "Content-Type: application/json" \ -d '{ "login": "admin", "password": "tu_contraseña" }'

La respuesta incluirá un token de autenticación, que debe incluirse en cada solicitud API como el encabezado DOLAPIKEY:

bash
curl -X GET https://tu-dolibarr.com/api/index.php/customers \ -H "DOLAPIKEY: tu_token"

Asegurar la API

  • Siempre usar HTTPS para evitar la interceptación de datos.
  • Restringir el acceso con permisos específicos para usuarios.
  • Regenerar claves API periódicamente.
  • Supervisar los registros de acceso a la API para detectar actividades sospechosas.

4. Automatizar la Gestión de Clientes

La API REST permite agregar y modificar clientes sin necesidad de acceder a la interfaz de Dolibarr.

Crear un nuevo cliente

Ejemplo de una solicitud POST para agregar un cliente:

bash
curl -X POST https://tu-dolibarr.com/api/index.php/thirdparties \ -H "DOLAPIKEY: tu_token" \ -H "Content-Type: application/json" \ -d '{ "name": "Empresa X", "email": "contacto@empresa-x.com", "client": 1, "status": 1 }'

Dolibarr devolverá un ID único para este cliente, que se podrá utilizar en futuras acciones.

Actualizar un cliente existente

Para modificar un cliente, usa una solicitud PUT con el ID del cliente:

bash
curl -X PUT https://tu-dolibarr.com/api/index.php/thirdparties/123 \ -H "DOLAPIKEY: tu_token" \ -H "Content-Type: application/json" \ -d '{ "email": "nuevo-contacto@empresa-x.com" }'

5. Automatizar la Facturación

Crear una factura mediante la API REST

Para generar una factura, utiliza el endpoint /invoices:

bash
curl -X POST https://tu-dolibarr.com/api/index.php/invoices \ -H "DOLAPIKEY: tu_token" \ -H "Content-Type: application/json" \ -d '{ "socid": 123, "date": "2024-03-15", "lines": [ { "desc": "Servicio de consultoría", "subprice": 200, "qty": 1, "total_ht": 200 } ] }'

Dolibarr devolverá el ID de la factura, que se puede utilizar para enviarla por correo electrónico o descargarla en formato PDF.

6. Sincronizar Dolibarr con Otras Herramientas

La API REST de Dolibarr permite sincronizar datos con herramientas externas como WooCommerce, Prestashop, Zapier, Google Sheets, Power BI, entre otras.

Ejemplo: Sincronización con una Tienda Online

Si deseas obtener la lista de productos para una tienda WooCommerce, puedes ejecutar la siguiente solicitud:

bash
curl -X GET https://tu-dolibarr.com/api/index.php/products \ -H "DOLAPIKEY: tu_token"

Este comando devolverá la información de los productos en Dolibarr, que se podrán importar a WooCommerce utilizando su propia API REST.

7. Automatizar Informes y Análisis

La API de Dolibarr permite extraer datos para generar informes personalizados.

Exportar las Ventas del Mes Actual

Para recuperar las ventas del mes:

bash
curl -X GET "https://tu-dolibarr.com/api/index.php/invoices?date_creation_start=2024-03-01&date_creation_end=2024-03-31" \ -H "DOLAPIKEY: tu_token"

Estos datos se pueden integrar en Google Sheets, Power BI o Excel para un análisis más avanzado.

Conclusión

La API REST de Dolibarr es una herramienta poderosa que permite automatizar múltiples tareas e integrar Dolibarr con otros sistemas. Activando y asegurando correctamente la API, puedes gestionar clientes, crear facturas, sincronizar datos con plataformas externas y generar informes personalizados.

Ya sea para la integración con un e-commerce, una aplicación móvil o un CRM externo, la API REST de Dolibarr facilita la automatización y mejora la productividad.

Si deseas profundizar más, explora la documentación oficial de Dolibarr o usa herramientas como Postman para probar y optimizar tus solicitudes API.

Comentarios

Inicia sesión o regístrate para publicar comentarios