Product
3
mins

Integración a través de API

Updated on
July 12, 2024

Flujo de código de arquitectura

Este documento describe la arquitectura de una integración general entre cliente y Dcycle. 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. Este es el flujo de Autenticación:


El cliente recibe un par único de API_KEYS para identificarse. Antes de cargar cualquier documento, se requerirá que el usuario se autentique en la plataforma. Si la autenticación ha sido exitosa, Dcycle proporcionará una URL temporal donde el cliente puede cargar el documento para ser procesado.

Carga de fichero

Una vez que el cliente ha recibido la URL temporal, podrá cargar el documento para ser procesado, como se describe en la siguiente sección:


El cliente carga el documento en la URL temporal proporcionada, y la plataforma ejecutará un proceso de validación del contenido:

  • Si la validación resulta exitosa, la plataforma devuelve una respuesta OK + el ID del archivo a procesar.
  • Si la validación no es exitosa, la plataforma devuelve el aviso de 422 Unprocessable Content + una lista de errores para corregir en el documento.


Procesamiento de documentos

Cómo Dcycle requiere de algunos minutos para procesar el documento, el proceso es completamente asíncrono. (El tiempo varía según la cantidad de datos procesados). La siguiente imagen describe el proceso:


La plataforma procesa el documento, calculando todas las emisiones correspondientes al documento cargado por el cliente. Una vez que se haya completado el procesamiento, notificará al usuario el estado vía webhook, proporcionando el estado y el id del documento procesado.

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. El siguiente diagrama describe el flujo de trabajo:


En este punto, el cliente puede aplicar filtros y ordenamientos para recibir datos específicos del documento procesado, como:

  • Filtrado por contenido con errores
  • Filtrado por atributos específicos, como contenido dentro de un rango de fechas específico, IDs de usuario, cantidades...
  • Ordenamiento por fechas

Se proporcionará un documento al recibir las API_KEYS que describa cómo construir las consultas.

Take control of your carbon footprint today.
Integración a través de API
Request a demo
Luis Escámez
CPO & Founder

Can we help you?

Let us show you how we can reduce your time and money up to 90%.