La API de Dcycle permite a las empresas integrar las capacidades de medición de huella de carbono directamente en sus sistemas existentes. Este documento describe la arquitectura de una integración general entre cliente y Dcycle y cómo funciona el flujo de trabajo completo.
¿Por qué integrar a través de API?
Muchas empresas ya disponen de sistemas de gestión (ERP, CRM, plataformas de contabilidad) que generan datos relevantes para el cálculo de la huella de carbono: facturas de energía, registros de transporte, datos de compras, información de proveedores. La integración por API permite automatizar el flujo de estos datos hacia la plataforma de Dcycle sin necesidad de procesos manuales de carga.
Las principales ventajas de la integración por API incluyen:
- Automatización: Los datos fluyen directamente desde los sistemas del cliente a Dcycle sin intervención manual, eliminando errores de transcripción y ahorrando tiempo al equipo de sostenibilidad.
- Datos en tiempo real: En lugar de esperar a recopilar datos al final de cada periodo de reporte, la integración permite mantener los cálculos de emisiones actualizados de forma continua.
- Escalabilidad: Para empresas con múltiples sedes, filiales o un gran volumen de facturas, la API permite procesar grandes cantidades de documentos de forma eficiente.
- Trazabilidad: Cada dato procesado queda registrado con su origen, fecha y estado, facilitando las auditorías y la verificación de la información.
Arquitectura y flujo de autenticación
Como la solución en la nube requiere tiempo para procesar toda la información, el proceso es completamente asíncrono, basado en el uso de webhooks. Esto significa que el sistema del cliente envía los datos, recibe una confirmación de recepción y posteriormente es notificado cuando el procesamiento ha finalizado.
El flujo de autenticación funciona de la siguiente manera:
- El cliente solicita un token de acceso utilizando sus credenciales de API (proporcionadas por Dcycle durante la configuración).
- El servidor de Dcycle valida las credenciales y devuelve un token de autenticación con un tiempo de expiración definido.
- Todas las solicitudes posteriores incluyen este token en las cabeceras HTTP para verificar la identidad del cliente.
Este modelo de autenticación basado en tokens sigue las mejores prácticas de seguridad y es compatible con la mayoría de lenguajes de programación y frameworks de desarrollo.
Carga de fichero
Una vez que el cliente ha recibido la URL temporal, podrá cargar el documento para ser procesado. El proceso de carga soporta varios formatos de archivo, incluyendo facturas en PDF, archivos CSV con datos estructurados y otros formatos documentales.
El flujo de carga es el siguiente:
- El sistema del cliente solicita una URL temporal de carga a la API de Dcycle.
- Dcycle genera y devuelve una URL firmada con un tiempo de validez limitado.
- El cliente sube el archivo directamente a la URL proporcionada.
- Dcycle confirma la recepción del archivo y comienza el procesamiento.
Procesamiento de documentos
Dcycle requiere de algunos minutos para procesar el documento, y el proceso es completamente asíncrono. El tiempo varía según la cantidad de datos procesados y la complejidad del documento.
Durante el procesamiento, la plataforma de Dcycle:
- Extrae los datos relevantes del documento (cantidades, fechas, conceptos, proveedores).
- Clasifica los datos según las categorías de emisión correspondientes (alcance 1, 2 o 3).
- Aplica los factores de emisión apropiados según la actividad, el país y el periodo temporal.
- Calcula las emisiones de CO2 equivalente asociadas.
- Notifica al cliente a través del webhook configurado cuando el procesamiento ha finalizado.
Si algún dato requiere validación o no puede ser procesado automáticamente, el sistema genera una notificación indicando qué información necesita revisión manual.
Realizar consultas
Después de que el archivo haya sido cargado y procesado completamente, el cliente tiene un ID que identifica el documento cargado previamente, y podrá realizar consultas para recibir el contenido procesado del archivo.
Las consultas disponibles incluyen:
- Estado del documento: Verificar si un archivo ha sido procesado correctamente o si requiere atención.
- Datos extraídos: Obtener los datos estructurados extraídos del documento original.
- Emisiones calculadas: Consultar las emisiones de CO2 asociadas a los datos procesados, desglosadas por alcance y categoría.
- Histórico: Acceder al registro completo de documentos procesados y sus resultados.
Primeros pasos con la integración
Para comenzar a utilizar la API de Dcycle, el equipo técnico necesita las credenciales de acceso y la documentación técnica completa. La plataforma de Dcycle también ofrece opciones de integración sin código para empresas que prefieran conectar sus datos sin desarrollo personalizado.
Si tu empresa necesita automatizar la recopilación de datos ambientales o integrar el cálculo de huella de carbono en sus sistemas existentes, solicita una demo para que nuestro equipo técnico pueda evaluar la mejor opción de integración para tu caso.
