Descripción general de la referencia a la API del servicio de crédito medioambiental

  • Artículo

Icono de Microsoft Cloud for Sustainability.

             Prueba gratuita

Importante

Algunas o todas estas funciones están disponibles como parte de una versión preliminar. El contenido y la funcionalidad están sujetos a cambios. Puede acceder al entorno de prueba del Servicio de crédito medioambiental (versión preliminar) para una prueba de 30 días. Para usar el Servicio de crédito medioambiental (Vista previa) en un entorno de producción, complete el Formulario de registro del Servicio de crédito medioambiental (Vista previa).

Este artículo lo ayuda a realizar tareas con las API REST del Servicio de crédito medioambiental. Para ver la referencia completa de la API, vaya a Referencia de la API del Servicio de crédito medioambiental. Puede encontrar el archivo Swagger en API REST del Servicio de crédito medioambiental.

Registrar proyectos

Esta sección le muestra cómo crear, enviar y revisar proyectos ecológicos a través de API. Para obtener instrucciones sobre el uso de la interfaz de usuario, vaya a Registro de proyectos en el Servicio de crédito medioambiental.

Crea un proyecto

Para cargar y adjuntar archivos en el momento de la creación del proyecto:

  1. Cargue archivos usando POST/files. Especifique los siguientes datos en la API:

    • Archivo o dirección URL de archivo
    • Etiqueta descriptiva para el archivo

  2. Cree el proyecto ecológico y el proyecto de beneficio modular correspondiente y especifique el ID de archivo que se devuelve en la respuesta de la llamada a la API POST/files como un atributo en el cuerpo de solicitud de la API de creación del proyecto: POST/ecoprojects.

Guardar y enviar un proyecto

Recuperar los detalles del proyecto:

   GET/ecoProjects/{ecoProjectId}

Vea la lista de archivos (y sus metadatos asociados) adjuntos al proyecto de beneficio modular:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}

Descargue un archivo usando el ID de archivo que está disponible como parte de los metadatos del archivo:

   GET/files/{fileId}

Agregue los archivos al proyecto de beneficios modular:

   POST/files

Especifique el URI del recurso del proyecto de beneficios modulares en el cuerpo de la solicitud.

Envíe el proyecto de beneficio modular para el registro enviando la propuesta MBPRegister:

   POST/proposals

Ver un proyecto

Obtener todas las propuestas:

   GET/proposals

Recuperar detalles de una propuesta específica:

   GET/proposals/{proposalId}

Recuperar detalles un proyecto ecológico específico:

   GET/ecoProjects/{ecoProjectId}

Obtener detalles del MBP específico para revisar:

   GET/ecoProjects/{ecoProjectId}/mbps/{mbpId}

Obtenga la lista de archivos (y los metadatos asociados) adjuntos al proyecto de beneficio modular:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}

Descargue los archivos usando el ID de archivo que está disponible como parte de la respuesta a la API anterior:

   GET/files/{fileId}

Adjunte un archivo al proyecto de beneficios modular:

   POST/files

Aprobar o rechazar una propuesta

Cargar archivos (si los hay):

POST/archivos y especifique el archivo (o FileUrl) y los detalles de la etiqueta

Rechazar la solicitud de registro:

POST/proposals/{proposalId}/action y especifique los siguientes detalles en el cuerpo de la solicitud

  • Acción: Rechazar

  • Mensaje: Especifique un comentario (si lo hay) que desea proporcionar para rechazar el registro.

  • FileIDs: especifique los ID de archivo de los archivos que se cargaron.

Eliminar un archivo

Vea la lista de archivos adjuntos al proyecto de beneficio modular:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}

Identifique el archivo que ha subido, porque un usuario puede eliminar solo los archivos que ha subido.

Eliminar el archivo:

   DELETE/files/{fileId}

Devolver una propuesta de ediciones

Si hay lagunas o detalles incorrectos en los atributos o archivos del proyecto que desea que el proveedor corrija o agregue, puede solicitar modificaciones en el proyecto.

  1. Cargar archivos, si los hay, que deben ser compartidos con el proveedor:

    POST/files

  2. Mueva la propuesta MBPRegister al estado submitterActionNeeded tomando la acción returnForEdits mediante POST/proposals/{proposalId}/action API y especifique los siguientes detalles en el cuerpo de la solicitud:

    • Acción: returnForEdits

    • Mensaje: especifique un comentario (si es necesario) para la referencia del proveedor al enviar la solicitud de edición.

    • ID de archivo: especifique aquí el ID de archivo del archivo cargado para adjuntar el archivo al proyecto de beneficio modular en cuestión.

    Una vez hecho esto, el proyecto de beneficio modular pasa al estado returnedForEdits.

Los proveedores ahora pueden ver la propuesta que se devolvió para su edición. Ahora pueden editar los atributos del proyecto de beneficios modulares y cargar más archivos al proyecto de beneficios modulares.

  • Ver propuesta: GET/proposals/{proposalId}

  • Cargue y adjunte archivos al proyecto de beneficio modular: POST/archivos y especifique los siguientes detalles en el cuerpo de la solicitud:

    • Archivo o dirección URL de archivo
    • Etiqueta: etiqueta descriptiva para el archivo
    • ResourceURI: especifique el URI del recurso del proyecto de beneficio modular respectivo.

  • Actualizar atributos del proyecto de beneficio modular

    • Obtenga los detalles actualizados del proyecto de beneficios modulares usando GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} y copie el valor de Etag del encabezado de respuesta.
    • Actualice los atributos del proyecto de beneficio modular utilizando PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} API y especifique el valor de Etag en la clave If-Match en el encabezado.

Una vez que se completan los cambios, el proveedor ahora puede enviar la propuesta nuevamente al registro utilizando POST/proposals/{proposalId}/action API y especificar los siguientes detalles en la solicitud:

  • Acción: Enviar

  • Mensaje: especifique un comentario (si lo hay) para la referencia del registro.

Registrar proyectos de beneficios modulares adicionales

Envíe el beneficio ecológico para el registro al registro emisor creando y enviando una propuesta de MBPRegister:

   POST/proposal

Revisar un proyecto de beneficios modulares

Ver los detalles de la propuesta:

   GET/proposals/{proposalId}

Ver todos los detalles del proyecto:

   GET/ecoProjects/{ecoProjectId}

Vea los detalles del proyecto de beneficio modular individual del proyecto:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}

Aprobar o rechazar la propuesta de registro, o devolverla para su edición:

   POST/proposals/{proposalId}/action

Tramitar reclamaciones

Esta sección le muestra cómo procesar reclamos a través de las API. Para obtener instrucciones sobre el uso de la interfaz de usuario, vaya a Solicitudes de proceso en el Servicio de crédito medioambiental.

Crear reclamos

Crear una solicitud:

   POST/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims

Cargue y adjunte archivos para reclamar puntos de control:

   POST/files

En la solicitud, especifique los siguientes detalles:

  • Archivo o dirección URL de archivo
  • Etiqueta
  • URI de recurso de la solicitud

Presentar reclamaciones

Cree y envíe la propuesta de proyecto de beneficio modularClaimVerify:

   POST/proposals

Ver detalles de la propuesta enviada:

   GET/proposal/{proposalId}

Ver los detalles de la solicitud:

   POST/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}

Verificar reclamo

Ver propuestas:

   GET/proposals

Recuperar los detalles de una propuesta específica:

   GET/proposals/{proposalId}

Obtenga los detalles de un reclamo específico para el cual se ha presentado la propuesta de verificación:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}

Aceptar la tarea de verificar el reclamo:

   POST/proposals/{proposalId}/action

Enumere los archivos asociados con un proyecto de beneficio modular:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}

Enumere los archivos asociados con los puntos de control de reclamos:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpclaims/{claimId}/checkpoints

Ver un archivo adjunto a un activo específico:

   GET/files/{fileId}

Una vez que se acepta el reclamo, se crea un 'Reclamo procesado' correspondiente. Registre los resultados de su verificación en el reclamo procesado. Esto incluye la actualización de Cantidad, Co beneficios del reclamo. Previo a la presentación de la solicitud de emisión de crédito, deberá actualizar las recomendaciones de crédito también en el reclamo tramitado:

  • Obtenga los detalles del reclamo procesado usando GET/processedClaims/{processed_claim_id} y copie el valor de Etag del encabezado de respuesta.
  • Actualice los atributos de la reclamación procesada utilizando la API PATCH/processedClaims/{processed_claim_id} y especifique el valor de Etag en la clave If-Match en el encabezado.

Para cada punto de control que verifique, puede actualizar los resultados de su verificación en el resultado del punto de control correspondiente del reclamo procesado:

  • Cargue y adjunte sus informes de búsqueda de verificación a los resultados del punto de control de la reclamación procesada mediante POST/API de archivos y especifique el archivo o la URL del archivo, la etiqueta y el ResourceUri (este será el URI del recurso del resultado del punto de control) en el cuerpo de la solicitud.
  • Actualice el efecto ambiental antes y después de los atributos del resultado del punto de control (si es necesario):
    • Obtenga los detalles del resultado del punto de comprobación usando GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} y copie el valor de Etag del encabezado de respuesta.
    • Actualice los atributos del resultado del punto de comprobación utilizando la API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} y especifique el valor de Etag en la clave If-Match en el encabezado.
    • También puede actualizar los resultados del punto de control utilizando la API de parches para reclamos procesados.

Una vez completada la verificación, apruebe o rechace la propuesta MBPClaimVerify:

   POST/proposals/{proposalId}/action

Especifique los siguientes datos:

  • Acción: Aprobar o rechazar

  • Mensaje: especifique un comentario (si lo hay) para la referencia del proveedor.

Una vez aprobada la propuesta MBPClaimVerify, cree y envíe la propuesta CreditMint para enviar la solicitud de emisión de crédito:

   POST/proposals/

Devolución de solicitud de reclamación por modificaciones

Si hay lagunas o detalles incorrectos en la solicitud de reclamación que el organismo de validación y verificación desea que el proveedor corrija, puede solicitar modificaciones en ella en lugar de aprobar o rechazar la solicitud. Esta capacidad está disponible solo a través de la API.

  1. Cargue y adjunte archivos (que desee compartir con el proveedor) al reclamo procesado o al resultado del punto de control del reclamo procesado: POST/archivos y especifique los siguientes detalles en el cuerpo de la solicitud

    • Archivo o dirección URL de archivo
    • Etiqueta
    • URI de recurso del reclamo procesado o resultado del punto de control del reclamo procesado al que se debe agregar el archivo

  2. Mueva la propuesta MBPClaimVerify al estado submitterActionNeeded tomando la acción returnForEdits mediante POST/proposals/{proposalId}/action API y especifique los siguientes detalles en el cuerpo de la solicitud:

    • Acción: returnForEdits
    • Mensaje: especifique un comentario (si es necesario) para la referencia del proveedor al enviar la solicitud de edición.

Edite la propuesta devuelta

Los proveedores aluego pueden ver la propuesta que se devolvió para su edición. Ahora pueden editar los atributos de reclamo y punto de control, y pueden cargar más archivos en los puntos de control de reclamo:

  1. Ver propuesta: GET/proposals/{proposalId}

    • Si es necesario, el proveedor también puede ver los detalles de la reclamación procesada correspondiente mediante la API GET/processedClaims/{processed_claim_Id}.

  2. Cargue y adjunte archivos (si los hay) a los puntos de comprobación de la reclamación: POST/archivos y especifique los siguientes detalles en el cuerpo de la solicitud

    • Archivo o dirección URL de archivo
    • Etiqueta
    • URI de recurso del punto de control al que se debe agregar el archivo

  3. Actualice los atributos de la notificación mediante una operación PATCH:

    • Obtenga los últimos detalles del reclamo y anote el valor de ETag en el encabezado de respuesta: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Actualice los atributos de la reclamación y especifique el valor de Etag en la clave 'If-Match' en el encabezado de la solicitud: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Actualice los atributos del punto de comprobación de la reclamación mediante una operación PATCH:

    • Obtenga los últimos detalles del punto de comprobación y anote el valor de ETag en el encabezado de respuesta: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

    • Actualice los atributos de la reclamación y especifique el valor de Etag en la clave If-Match en el encabezado de la solicitud: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

      Nota

      Al especificar los atributos de actualización, asegúrese de que el cuerpo de la solicitud JSON siga la misma estructura que en la llamada de API de obtención correspondiente.

  5. Una vez que se completan los cambios, el proveedor luego puede enviar la propuesta nuevamente al cuerpo de validación y verificación utilizando POST/proposals/{proposalId}/action API y especificar los siguientes detalles en el cuerpo de la solicitud:

    • Acción: Reenviar
    • Mensaje: Especifique cualquier comentario (si es necesario) para la referencia del cuerpo de validación y verificación.

Después de volver a enviar la propuesta, el organismo de validación y verificación puede revisarla y aprobarla, rechazarla o volver a solicitar modificaciones.

Retirar la solicitud de emisión de crédito

Opción para retirar la propuesta de solicitud de emisión de crédito (CreditMint) enviada:

Después de enviar la propuesta de emisión de crédito al registro, en caso de cualquier problema por el cual desee retirar la propuesta presentada, puede retirar la propuesta presentada si el registro no ha actuado sobre la propuesta. Actualmente esta capacidad solo está disponible mediante API.

  • Mueva la propuesta de CreditMint que está en estado enviado a estado retirado mediante la API POST/proposals/{proposalId}/action y especifique los siguientes detalles en el cuerpo de la solicitud :

    • Acción: Retirar
    • Mensaje: Especifique el motivo (si lo hubiere) para retirar la propuesta de referencia de registro.

El estado de la propuesta es ahora Retirada.

Después de que se retira la solicitud de emisión de crédito, el organismo de validación y verificación puede modificar el 'reclamo procesado' y los resultados del punto de control asociado y luego volver a enviar la solicitud de emisión de crédito.

  • Cargue y adjunte archivos a los resultados del punto de comprobación de la reclamación procesada: POST/archivos y especifique los siguientes detalles:

    • Archivo o FileURL
    • Etiqueta
    • ResourceURI del resultado del punto de control asociado.

  • Actualice los atributos del reclamo procesado: PATCH/processedClaims/{processedClaim_Id}

  • Vuelva a enviar la solicitud de emisión al registro y especifique los siguientes detalles en el cuerpo de la solicitud de la API: POST/proposals/{ proposal_id}/action

    • Acción: Especificar como Reenviar
    • Mensaje: especifique un mensaje o comentario (si lo hay) para la referencia del registro

Emitir créditos

Esta sección le muestra cómo ver y emitir créditos a través de las API. Para obtener instrucciones sobre el uso de la interfaz de usuario, vaya a Emitir créditos en el Servicio de crédito medioambiental.

Revisar propuestas de emisión de crédito

Vea la propuesta de 'Token mint' enviada y obtenga el URI de recurso de 'reclamación procesada' que se envió para su revisión:

GET/proposal/{proposalId}

Revise los hallazgos de verificación del organismo de validación y verificación al ver el reclamo procesado y los resultados del punto de control asociado (junto con los archivos asociados):

GET/processedClaims/{processedClaims_Id}

Vea el reclamo y los detalles correspondientes del punto de control (junto con la lista de archivos adjuntos por el proveedor para los puntos de control):

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}

Vea los detalles del proyecto de beneficio modular, junto con la lista de archivos adjuntos:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}

Descargue un archivo con el ID de archivo:

   GET/files/{fileId}

Aprobar créditos

Cargue los archivos que desea adjuntar al crédito para la emisión: POST/archivos y especifique los siguientes detalles en el cuerpo de la solicitud:

  • Archivo o dirección URL de archivo
  • Etiqueta

Aprobar la propuesta:

   POST/proposals/{proposalId}/action

En el cuerpo de la solicitud, especifique los siguientes detalles:

  • Acción: especificar como Mint
  • Mensaje: Especificar el mensaje (si lohay) para la referencia del cuerpo de validación y verificación
  • ID de archivo: especifique las ID de archivo de los archivos cargados para que los archivos se adjunten al crédito emitido
  • Cantidad
  • Antiguo
  • Id. de activo
  • Valor detrminado

Nota

Cuando la propuesta sea aprobada, se creará el crédito correspondiente.

Rechazar una propuesta

Cargue y adjunte archivos (si los hay) a la reclamación procesada: POST/archivos y especifique los siguientes detalles:

  • Archivo o dirección URL de archivo
  • Etiqueta

Rechazar la propuesta:

   POST/proposals/{proposalId}/action

En el cuerpo de la solicitud, especifique los siguientes detalles:

  • Acción: Rechazar
  • Mensaje: Especificar un mensaje (si lohay) para la referencia del cuerpo de validación y verificación
  • ID de archivo: especifique aquí los id. de archivo del archivo cargado de modo que estén adjuntos a la reclamación procesada asociada.

Devolver solicitud de emisión de crédito para ediciones

Si hay lagunas o detalles incorrectos en la solicitud de seguros que desea que el organismo de validación y verificación corrija, puede solicitar modificaciones la solicitud de emisión. Esta capacidad está disponible solo a través de la API.

  1. Cargue los archivos (si los hay) que desee compartir con el organismo de validación y verificación como parte del envío de la solicitud de emisión para su edición.

  2. Mueva la solicitud de emisión (propuesta CreditMint) al estado submitterActionNeeded mediante la API POST/proposals/{proposalId}/action y especifique los siguientes detalles:

    • Acción: ReturnForEdits
    • Mensaje: especifique un mensaje (si lo hay) para la referencia del cuerpo de validación y verificación para que puedan comprender el motivo de la solicitud de edición.
    • ID de archivo: especifique aquí los id. de los archivos cargados (si los hay) de modo que estén adjuntos a la reclamación procesada asociada.

El organismo de validación y verificación ahora puede ver la propuesta que se ha devuelto para su edición. Ahora también pueden editar el reclamo procesado correspondiente y los resultados del punto de control. Pueden actualizar atributos y cargar archivos actualizados en los resultados del punto de control.

Si es necesario, el organismo de validación y verificación en este punto puede solicitar aclaraciones sobre el reclamo verificado devolviendo el reclamo al proveedor para que lo edite. Una vez que el proveedor vuelve a presentar el reclamo, el organismo de validación y verificación puede revisar y verificar el reclamo, actualizar el reclamo procesado correspondiente y luego volver a presentar la solicitud de emisión al registro.

  1. Cargue y adjunte archivos a los resultados del punto de comprobación: POST/archivos y especifique los siguientes detalles:

    • Archivo o dirección URL de archivo
    • Etiqueta
    • ResourceURI de los resultados del punto de control asociado

  2. Actualice los atributos del reclamo procesado, incluida la recomendación de crédito: PATCH/processedClaim/{id de reclamo procesado}

  3. Vuelva a enviar la solicitud de emisión y especifique los siguientes detalles en el cuerpo de la solicitud de la API: POST/proposals/{ proposal_id}/action

    • Acción: Reenviar
    • Mensaje: especifique un mensaje (si lo hay) para la referencia del registro

Después de volver a enviar la solicitud, el registro emisor puede revisarla y aprobarla, rechazarla o volver a solicitar modificaciones.

Ver créditos emitidos

   GET/credits

Buscar y ver créditos

Obtener todos los créditos:

   GET/credits

Nota

Esta API devolverá la lista de todos los créditos. Luego, los compradores pueden filtrar la lista por su cuenta según el estado del crédito para ver solo los créditos enumerados.

Vea los detalles del crédito (incluido el linaje) de un crédito específico que se muestra en la lista:

   GET/credits/{creditId}/lineage

Enumerar créditos

Esta sección le muestra cómo enumerar créditos en un mercado para el comercio a través de API. Para obtener instrucciones sobre el uso de la interfaz de usuario, vaya a Mostrar créditos en el Servicio de crédito medioambiental.

Regístrese como comprador o en un mercado

Envíe la propuesta MarketplaceTraderRegister como propietario o comprador de crédito:

   POST/proposals

Obtenga y revise todas las propuestas de MarketplaceTraderRegister como un mercado:

   GET/proposals

Aprobar o rechazar las propuestas como marketplace:

   POST/proposals/{proposalId}/action

Obtenga y vea todos los comerciantes registrados en su plataforma como un mercado:

   GET/marketplaces/{marketplaceId}/traders

Enviar propuesta para listar un crédito

Cree y envíe una propuesta de MarketplaceListingRegister:

   POST/proposals

Revisar propuesta para listar un crédito

   GET/proposals

   POST /proposals/{proposalId}/action

Administrar créditos

Esta sección le muestra cómo gestionar créditos a través de las API. Para obtener instrucciones sobre el uso de la interfaz de usuario, vaya a Gestionar créditos en el Servicio de crédito medioambiental.

Eliminar un crédito de la lista

Fraccionar un crédito es una operación independiente en el Servicio de crédito medioambiental. Para obtener información sobre cómo dividir un crédito a través de la API, vaya a Dividir un crédito. Después de que se divide el crédito, puede continuar con el siguiente paso.

Cree y envíe una propuesta de MarketplaceListingDeregister:

   POST/proposals

Vea todas las propuestas de MarketplaceListingDeregister enviadas para su revisión:

   GET/proposals

Para aprobar o rechazar la propuesta:

   POST/proposals/{proposalId}/action

Transferir la propiedad

   POST/credits/{creditId}/transfer/

Ver linaje de crédito

Las organizaciones con roles de proveedor y registro pueden ver el linaje de crédito de los créditos que poseen o han emitido:

   GET/credits/{creditId}/lineage

Dividir un crédito

Puede dividir un crédito en créditos para niños. Actualmente, esta funcionalidad solo está disponible con la API.

Dividir el crédito especificando las cantidades (en mtCO2e) para al menos dos créditos para niños como propietario de crédito (para los créditos que poseen) o como mercado (para los créditos enumerados en su plataforma):

   POST/credits/{creditId}/split

Transferir lista de crédito

Un mercado puede transferir una lista de crédito de su plataforma a otro mercado. Esta transferencia también se conoce como transferencia de gravamen. En el flujo tradicional, un proveedor enumeraría los créditos en un mercado que ayudará con la demanda, la compensación y la liquidación. A veces, es posible que un mercado no pueda realizar la compensación y liquidación de pagos por sí solo y puede depender de una plataforma diferente para realizarlo. En este caso, el activo debe transferirse al nuevo mercado para completar la transacción. Actualmente, esta característica solo está disponible con las API.

Como mercado, cree y envíe la propuesta MarketplaceListingTransfer para un crédito que figura en su plataforma:

   POST/proposals

Como mercado aprobador, vea todas las propuestas de MarketplaceListingTransfer que se les enviaron para su revisión:

   GET/proposals

Como mercado aprobador, apruebe o rechace la propuesta. Si se aprueba la propuesta, el gravamen de créditos se transfiere del mercado inicial al mercado aprobador:

   POST/proposals/{proposalId}/action

Transferencia parcial de gravamen: un mercado puede transferir gravamen por crédito parcial dividiendo primero el crédito como una acción independiente. Para obtener información sobre cómo dividir un crédito, vaya a Dividir un crédito. Después de dividir el crédito, continúe con los pasos anteriores para la transferencia de gravamen para créditos por hijos.

Establecer objetivos de emisión

Esta sección le muestra cómo configurar metas y objetivos de reducción de emisiones a través de las API.

Crear objetivos de emisiones

   POST/esgs

Ver objetivos de emisiones

   GET/esgs

Hacer seguimiento de las emisiones

Esta sección le muestra cómo realizar un seguimiento de sus emisiones en comparación con el cuadro de mando de emisiones que estableció a través de las API. Para obtener instrucciones sobre el uso de la interfaz de usuario, vaya a Seguir los objetivos de emisión en el Servicio de crédito medioambiental.

Crear hitos para un período de informe específico

   POST/esgs/{esgScorecardId}/milestones

Obtener todos los hitos:

   GET/esgs/{esgScorecardId}/milestones

Obtener hito específico:

   GET/esgs/{esgScorecardId}/milestones/{esgMilestoneId}

Haga un seguimiento de las emisiones reales contra el hito

   POST/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}/emissions

   GET/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}

Retirar créditos

Esta sección le muestra cómo compensar el exceso de emisiones retirando los créditos de carbono propios a través de las API. Para obtener instrucciones sobre el uso de la interfaz de usuario, vaya a Retirar créditos en el Servicio de crédito medioambiental.

Enviar propuesta de retiro de crédito

Cree y envíe la propuesta de ESGEmissionOffset:

   POST/proposals

Los compradores también pueden retirar los créditos de carbono directamente sin especificar las emisiones a compensar. Esta funcionalidad solo está disponible mediante las API.

Cree y envíe la propuesta de CreditRetire:

   POST/proposals

Revisar propuesta de retirada de crédito

   GET/proposals

   GET/proposals/{proposalId}

Adjuntar archivo al crédito que se está revisando para retiro:

   POST/files

   POST/proposals/{proposalId}/action

Retirada de crédito parcial

Para obtener información sobre cómo dividir un crédito a través de la API, vaya a Dividir un crédito.

Después de dividir el crédito, utilice las API de los pasos anteriores para la compensación y el retiro.

Administrar archivos

Esta sección le muestra cómo adjuntar, ver y eliminar archivos para activos como proyectos, reclamos y créditos a través de las API. Para obtener instrucciones sobre el uso de la interfaz de usuario, vaya a Gestionar archivos en el Servicio de crédito medioambiental.

Adjuntar archivos

Utilice la API POST/archivos para adjuntar un archivo a un activo. Tendrá que especificar los siguientes detalles:

  • Archivo o dirección URI de archivo
  • URI de recurso del activo
  • Etiqueta descriptiva para el archivo

Ver archivos

Vea la lista de archivos junto con las propiedades de archivo de un activo mediante la API de detalles de activos:

Proyecto de beneficios modulares:

   GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}

Reclamaciones:

   GET/ecoprojects/{ecoProjectId}/mbps/{modular benefit projectId}/mbpClaims/{mbpClaimId}

Puntos de control de las reclamaciones:

   GET/ecoprojects/{ecoProjectId}/modular benefit projects/{mbpId}/mbpClaims/{mbpClaimId}/checkpoints

Crédito:

   GET/credits/{creditId}

Utilice el ID de archivo presente en las propiedades del archivo para descargar el archivo:

   GET/files/{fileId}

Eliminar archivos

Utilice el ID de archivo del archivo para llamar a la API de eliminación:

   DELETE/files/{fileId}

Consulte también

Descripción general del Servicio de crédito medioambiental
Configurar el Servicio de crédito medioambiental
Glosario del Servicio de crédito medioambiental

📄 Página de producto
🎓 Formación

✅ Prueba gratuita
🎥 Canal de YouTube

💻 Comunidad
Icono de LinkedIn.Grupo de LinkedIn