Cálculo de la Huella de Carbono

Endpoint

Ruta: https://us-central1-totemfunctions.cloudfunctions.net/calculateCarbonFootprint
Método: POST

Descripción

Este endpoint calcula la huella de carbono de una organización o proyecto basado en los datos de emisiones proporcionados. La función evalúa las emisiones directas e indirectas y proporciona recomendaciones para reducir la huella de carbono. Utiliza OpenAI para generar recomendaciones detalladas y estrategias sostenibles.

Solicitud (Request)

Ejemplo de Cuerpo de Solicitud (JSON)

{
    "uid": "user123",
    "data": {
        "scope1": [
            {"type": "fuel", "quantity": 100}
        ],
        "scope2": [
            {"type": "electricity", "quantity": 500}
        ],
        "scope3": [
            {"type": "travel", "quantity": 200}
        ]
    }
}

Descripción de Parámetros

uid (string): Identificador del usuario que realiza la solicitud. Se utiliza para verificar la autorización del usuario.
data (object): Datos de emisiones que incluyen:
- scope1 (array of objects): Emisiones directas, donde cada objeto contiene:
  - type (string): Tipo de emisión (por ejemplo, "fuel", "naturalGas").
  - quantity (number): Cantidad del recurso consumido.
- scope2 (array of objects): Emisiones indirectas de electricidad, con la misma estructura que scope1.
- scope3 (array of objects): Otras emisiones indirectas, con la misma estructura que scope1.

Errores Comunes

400 Bad Request: Si faltan los parámetros uid o data.
403 Forbidden: Si el uid no está autorizado.
500 Internal Server Error: En caso de errores internos durante el procesamiento de la solicitud.

Respuesta (Response)

Ejemplo de Cuerpo de Respuesta (JSON)

{
    "message": "Resultado del cálculo de la huella de carbono.",
    "inputData": {
        "scope1": [
            {"type": "fuel", "quantity": 100, "emissionFactor": 2.31}
        ],
        "scope2": [
            {"type": "electricity", "quantity": 500, "emissionFactor": 0.233}
        ],
        "scope3": [
            {"type": "travel", "quantity": 200, "emissionFactor": 0.158}
        ]
    },
    "totalEmissions": 296.1,
    "recommendations": "Recomendaciones en lenguaje natural para reducir la huella de carbono y estrategias sostenibles."
}

Descripción de Campos

message (string): Mensaje que indica el resultado del cálculo de la huella de carbono.
inputData (object): Datos de emisiones proporcionados, con factores de emisión añadidos.
totalEmissions (number): Total de emisiones de carbono calculadas en kg CO2e.
recommendations (string): Recomendaciones detalladas generadas por OpenAI, que incluyen:
1. Acciones para reducir las emisiones en cada uno de los alcances (Scope 1, Scope 2, Scope 3).
2. Estrategias sostenibles a largo plazo.
3. Recomendaciones sobre compensaciones de carbono y energías renovables.
4. Oportunidades de mejora en los procesos operativos para minimizar la huella de carbono.

Notas Adicionales

La respuesta incluye un desglose de los datos de entrada con los factores de emisión aplicados, el total calculado de emisiones y recomendaciones detalladas para mitigar la huella de carbono.
La sección de recomendaciones proporciona estrategias prácticas y sugerencias basadas en el análisis de la huella de carbono, y está diseñada para ayudar a los profesionales en sostenibilidad a mejorar sus prácticas y reducir el impacto ambiental.

Last modified: 26 agosto 2024