Descrição geral da referência da API para o Serviço de Créditos Ambientais

  • Artigo

Cimeira Técnica do Microsoft Cloud for Sustainability, maio de 2024

Importante

Algumas ou todas estas funcionalidades estão disponíveis como parte de uma versão de pré-visualização. O conteúdo e a funcionalidade estão sujeitos a alterações. Pode aceder ao ambiente de sandbox do Serviço de Créditos Ambientais (pré-visualização) para obter uma versão de avaliação de 30 dias. Para usar o Serviço de Créditos Ambientais (pré-visualização) num ambiente de produção, preencha o formulário de subscrição Serviço de Créditos Ambientais (pré-visualização).

Este artigo ajuda a executar as tarefas com as API REST de Serviço de Créditos Ambientais. Para ver a referência de API completa, vá para Referência de API de Serviço de Créditos Ambientais. Poderá encontrar o ficheiro do Swagger nas APIs REST de Serviço de Créditos Ambientais.

Registar projetos

Esta secção mostra como criar, submeter e rever projetos ecológicos via APIs. Para obter instruções sobre como utilizar a interface de utilizador, vá para Registar projetos no Serviço de Créditos Ambientais.

Criar um projeto

Para carregar e anexar ficheiros no momento de criação do projeto:

  1. Carregar os ficheiros utilizando o POST/ficheiros. Especifique os seguintes detalhes na API:

    • Ficheiro ou URL do ficheiro
    • Etiqueta descritiva para o ficheiro

  2. Crie o projeto ecológico e o projeto de benefícios modulares correspondente e especifique o fileID que é devolvido como resposta à chamada à API POST/ficheiros como um atributo no corpo do pedido da API de criação: POST/ecoprojects.

Guardar e submeter um projeto

Obter os detalhes do projeto:

   GET/ecoProjects/{ecoProjectId}

Ver a lista de ficheiros (e os respectivos metadados associados) anexados ao projeto de benefícios modulares:

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

Transferir um ficheiro utilizando o fileID que está disponível como parte dos metadados do ficheiro:

   GET/files/{fileId}

Adicionar ao projeto de benefícios modulares:

   POST/files

Especifique o URI do recurso do projeto de benefícios modulares no corpo do pedido.

Submeter o projeto de benefícios modulares para registo ao submeter a proposta MBPRegister:

   POST/proposals

Ver um projeto

Obter todas as propostas:

   GET/proposals

Obter detalhes de uma proposta específica:

   GET/proposals/{proposalId}

Obter detalhes de um projeto ecológico específico:

   GET/ecoProjects/{ecoProjectId}

Obter detalhes do MBP específico a rever:

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

Obtenha a lista de ficheiros (e os metadados associados) anexados ao projeto de benefícios modulares:

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

Transferir os ficheiros utilizando o fileId que está disponível como parte da resposta da API anterior:

   GET/files/{fileId}

Anexar um ficheiro ao projeto de benefícios modulares:

   POST/files

Aprovar ou rejeitar uma proposta

Carregar ficheiros (se existirem):

POST/ficheiros e especificar File (ou FileUrl) e os detalhes da etiqueta

Rejeitar o pedido de registo:

POST/propostas/{proposalId}/ação e especificar os seguintes detalhes no corpo do pedido

  • Ação: Rejeitar

  • Mensagem: especifique um comentário (se existir) que pretende fornecer para rejeitar o registo.

  • FileIDs: especifique os IDs de ficheiro dos ficheiros que foram carregados.

Eliminar um ficheiro

Ver a lista de ficheiros que estão anexados ao projeto de benefícios modulares:

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

Identifique o ficheiro que carregou, porque um utilizador só pode eliminar os ficheiros que carregou.

Eliminar o ficheiro:

   DELETE/files/{fileId}

Devolver uma proposta para edições

Se existirem lacunas ou detalhes incorretos nos atributos ou ficheiros do projeto que pretende que o fornecedor corrija ou adicione, pode pedir edições no projeto.

  1. Carregar ficheiros, se existirem, que têm de ser partilhados com o fornecedor:

    POST/ficheiros

  2. Mover a proposta MBPRegister para o estado submitterActionNeeded ao executar a ação returnForEdits através da API POST/propostas/{proposalId}/ação e especificar os seguintes detalhes no corpo do pedido:

    • Ação: returnForEdits

    • Mensagem: especifique um comentário (se for necessário) para a referência do fornecedor enquanto devolve o pedido para edições.

    • IDs de Ficheiro: especifique o ID de ficheiro do ficheiro carregado aqui para anexar o ficheiro ao projeto de benefícios modulares em causa.

    A seguir, o projeto de benefícios modulares muda para o estado returnedForEdits.

Os fornecedores podem agora ver a proposta que foi enviada de volta para edições. Podem agora editar os atributos do projeto de benefícios modulares e carregar mais ficheiros para o projeto de benefícios modulares.

  • Ver proposta: GET/propostas/{proposalId}

  • Carregar e anexar ficheiros ao projeto de benefícios modulares: POST/ficheiros e especificar os seguintes detalhes no corpo do pedido:

    • Ficheiro ou URL do ficheiro
    • Etiqueta: etiqueta descritiva do ficheiro
    • ResourceURI: especifique o URI de recurso do respectivo projeto de benefícios modulares.

  • Atualizar atributos do projeto de benefícios modulares

    • Obtenha os detalhes do projeto de benefícios modulares atualizado através de GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} e copie o valor Etag a partir do cabeçalho de resposta.
    • Atualize os atributos do projeto de benefícios modulares através da API PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} API e especifique o valor Etag na chave If-Match no cabeçalho.

Depois de concluídas as alterações, o fornecedor pode agora submeter a proposta de volta ao registo utilizando a API POST/propostas/{proposalId}/ação e especificar os seguintes detalhes no pedido:

  • Ação: Submeter

  • Mensagem: especifique um comentário (se for o caso) para referência do registo.

Registar projetos de benefícios modulares adicionais

Submeter o benefício ecológico para registo no registo emitente ao criar e submeter uma proposta MBPRegister:

   POST/proposal

Rever um projeto de benefícios modulares

Ver os detalhes da proposta:

   GET/proposals/{proposalId}

Ver todos os detalhes do projeto:

   GET/ecoProjects/{ecoProjectId}

Ver os detalhes do projeto de benefícios modulares individuais do projeto:

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

Aprovar ou rejeitar a proposta de registo ou devolvê-la para edições:

   POST/proposals/{proposalId}/action

Processar afirmações

Esta secção mostra como processar as afirmações através de APIs. Para obter instruções sobre como utilizar a interface de utilizador, vá para Processar afirmações no Serviço de Créditos Ambientais.

Criar afirmações

Criar afirmação:

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

Carregar e anexar ficheiros aos pontos de verificação da afirmação:

   POST/files

Especificar os seguintes detalhes no pedido:

  • Ficheiro ou URL do ficheiro
  • Etiqueta
  • URI do recurso da afirmação

Submeter afirmações

Criar e submeter a proposta projectClaimVerify do benefício modular:

   POST/proposals

Ver detalhes da proposta submetida:

   GET/proposal/{proposalId}

Ver detalhes da afirmação:

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

Verificar afirmação

Ver propostas:

   GET/proposals

Obter os detalhes de uma proposta específica:

   GET/proposals/{proposalId}

Obter os detalhes de uma afirmação específica para a qual a proposta de verificação foi submetida:

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

Aceitar a tarefa de verificação da afirmação:

   POST/proposals/{proposalId}/action

Listar os ficheiros associados a um projeto de benefícios modulares:

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

Listar os ficheiros associados aos pontos de verificação da afirmação:

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

Ver um ficheiro anexado a um ativo específico:

   GET/files/{fileId}

Após a afirmação ser aceite, é criada uma "afirmação processada" correspondente. Registe as descobertas da sua verificação sobre a afirmação processada. Isto inclui a atualização da Quantidade, Benefícios partilhados da afirmação. Antes de submeter o pedido de emissão de crédito, tem de atualizar também as recomendações de crédito sobre a afirmação processada:

  • Obtenha os detalhes da afirmação processada utilizando GET/processedClaims/{processed_claim_id} e copie o valor Etag do cabeçalho de resposta.
  • Atualize os atributos da afirmação processada através da API PATCH/processedClaims/{processed_claim_id} e especifique o valor Etag na chave If-Match no cabeçalho.

Para cada ponto de verificação que verificar, pode atualizar as descobertas da verificação no resultado do ponto de verificação correspondente da afirmação processada:

  • Carregue e anexe os seus relatórios de descobertas de verificação para os resultados do ponto de verificação da afirmação processada utilizando a API POST/files e especifique o Ficheiro ou o URL do ficheiro, a Etiqueta e o ResourceUri (este será o URI de recurso do resultado do ponto de verificação) no corpo do pedido.
  • Atualize o efeito ambiental antes e depois dos atributos do resultado do ponto de verificação (se necessário):
    • Obtenha os detalhes do resultado do ponto de verificação utilizando GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} e copie o valor Etag do cabeçalho de resposta.
    • Atualize os atributos do resultado do ponto de verificação através da API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} e especifique o valor Etag na chave If-Match no cabeçalho.
    • Também pode atualizar os resultados do ponto de verificação utilizando a API de patch para afirmações processadas.

Quando a verificação terminar, aprove ou rejeite a proposta MBPClaimVerify:

   POST/proposals/{proposalId}/action

Especifique os seguintes detalhes:

  • Ação: Aprovar ou Rejeitar

  • Mensagem: especifique um comentário (se for o caso) para referência do fornecedor.

Após a proposta MBPClaimVerify ser aprovada, crie e submeta a proposta CreditMint para submeter o pedido de emissão de crédito:

   POST/proposals/

Devolver pedido de afirmação para edições

Se existirem lacunas ou detalhes incorretos no pedido de afirmação que a Validação e o Corpo da Verificação pretendam que o fornecedor corrija ou adicione, pode pedir edições no pedido de afirmação em vez de aprovar ou rejeitar o pedido. Esta capacidade está disponível apenas via API.

  1. Carregue e anexe ficheiros (que pretende partilhar com o fornecedor) para a afirmação processada ou ao resultado do ponto de verificação da afirmação processada: POST/files e especifique os seguintes detalhes no corpo do pedido

    • Ficheiro ou URL do ficheiro
    • Etiqueta
    • URI do recurso da afirmação ou resultado do ponto de verificação da afirmação processada à qual o ficheiro tem de ser adicionado

  2. Mover a proposta MBPClaimVerify para o estado submitterActionNeeded ao executar a ação returnForEdits através da API POST/propostas/{proposalId}/ação e especificar os seguintes detalhes no corpo do pedido:

    • Ação: returnForEdits
    • Mensagem: especifique um comentário (se for necessário) para a referência do fornecedor enquanto devolve o pedido para edições.

Editar a proposta devolvida

Os fornecedores podem depois ver a proposta que foi enviada de volta para edições. Podem agora editar os atributos de afirmação e ponto de verificação e podem carregar mais ficheiros para os pontos de verificação da afirmação:

  1. Ver proposta: GET/propostas/{proposalId}

    • Se necessário, o fornecedor também pode ver os detalhes da afirmação processada correspondentes utilizando a API GET/processedClaims/{processed_claim_Id}.

  2. Carregar e anexar ficheiros (se existirem) aos pontos de verificação da afirmação: POST/ficheiros e especificar os seguintes detalhes no corpo do pedido

    • Ficheiro ou URL do ficheiro
    • Etiqueta
    • URI do recurso do posto de verificação ao qual o ficheiro tem de ser adicionado

  3. Atualizar atributos da afirmação utilizando uma operação PATCH:

    • Obter os mais recentes detalhes da afirmação e anotar o valor de ETag no cabeçalho de resposta: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Atualizar os atributos da afirmação e especificar o valor Etag na chave "If-Match" do cabeçalho do pedido: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Atualizar os atributos do ponto de verificação da afirmação utilizando uma operação PATCH:

    • Obter os mais recentes detalhes do ponto de verificação e anotar o valor de ETag no cabeçalho de resposta: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

    • Atualizar os atributos da afirmação e especificar o valor Etag na chave "If-Match" do cabeçalho do pedido: : PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

      Nota

      Ao especificar os atributos de atualização, certifique-se de que o corpo do pedido JSON segue a mesma estrutura que na correspondente obter chamada à API.

  5. Depois de concluídas as modificações, o fornecedor pode submeter a proposta de volta ao corpo de validação e verificação utilizando a API POST/propostas/{proposalId}/ação e especificar os seguintes detalhes no corpo do pedido:

    • Ação: Submeter novamente
    • Mensagem: especifique qualquer comentário (se for necessário) para referência do corpo de validação e verificação.

Depois de a proposta ser novamente submetida, a Validação e o Corpo da Verificação podem rever a proposta e aprovar, rejeitar ou voltar a pedir edições.

Retirar o pedido de emissão de crédito

Opção para retirar a proposta de pedido de emissão de crédito submetido (CreditMint):

Após a proposta de emissão de crédito ser submetida para o registo, em caso de quaisquer problemas decorrentes dos quais pretende retirar a proposta submetida, poderá retirar a proposta submetida se o registo não tiver agido sobre a proposta. Esta capacidade está atualmente disponível apenas por APIs.

  • Mova a proposta CreditMint que está no estado submetida para retirada utilizando a API POST/propostas/{proposalId}/ação e especifique os seguintes detalhes no corpo do pedido:

    • Ação: Retirar
    • Mensagem: Especifique o motivo (se for o caso) para retirar a proposta para referência do registo.

O estado da proposta é agora Retirado.

Após o pedido de emissão de crédito não ser retirado, o corpo de validação e de verificação podem modificar a "afirmação processada" e os resultados do ponto de verificação associados e, em seguida, voltar a submeter o pedido de emissão de crédito.

  • Carregue e anexe ficheiros aos resultados do ponto de verificação da afirmação processada: POST/files e especifique os seguintes detalhes:

    • Ficheiro ou FileURL
    • Etiqueta
    • ResourceURI do resultado do ponto de verificação associado.

  • Atualizar os atributos da afirmação processada: PATCH/processedClaims/{processedClaim_Id}

  • Submeta novamente o pedido de emissão para o registo e especifique os seguintes detalhes no corpo do pedidos da API: POST/proposals/{ proposal_id}/action

    • Ação: Especificar como Submeter novamente
    • Mensagem: especifique uma mensagem/comentário (se for o caso) para referência do registo

Emitir créditos

Esta secção mostra como ver e emitir créditos através de APIs. Para obter instruções sobre como utilizar a interface de utilizador, vá para Emitir créditos no Serviço de Créditos Ambientais.

Rever propostas de emissão de crédito

Consulte a proposta "Token mint" submetida e obtenha o URI do recurso da "afirmação processada" que foi submetido para revisão:

GET/proposal/{proposalId}

Consulte as descobertas da verificação da validação e do corpo de verificação consultando a afirmação processada e os resultados do ponto de verificação associado (juntamente com os ficheiros associados):

GET/processedClaims/{processedClaims_Id}

Vera afirmação e os detalhes correspondentes do ponto de verificação (juntamente com a lista de ficheiros anexados pelo fornecedor para os pontos de verificação):

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

Ver os detalhes do projeto de benefícios modulares, a par da lista de ficheiros anexados:

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

Transferir um ficheiro utilizando o ID de ficheiro:

   GET/files/{fileId}

Aprovar créditos

Carregar os ficheiros que pretende anexar ao crédito para emissão: POST/ficheiros e especificar os seguintes detalhes no corpo do pedido:

  • Ficheiro ou URL do ficheiro
  • Etiqueta

Aprovar a proposta:

   POST/proposals/{proposalId}/action

Especificar os seguintes detalhes no corpo do pedido:

  • Ação: especificar como Mint
  • Mensagem: especificar a mensagem (se existir) para referência do corpo de validação e verificação
  • IDs de Ficheiro: especifique os IDs de ficheiro dos ficheiros carregados para os ficheiros serem anexados ao crédito emitido
  • Quantidade
  • Vintage
  • ID do Ativo
  • Valor determinado

Nota

Quando a proposta for aprovada, será criado um crédito correspondente.

Rejeitar uma proposta

Carregar ficheiros (se existirem) à afirmação processada: POST/files e especifique os seguintes detalhes:

  • Ficheiro ou URL do ficheiro
  • Etiqueta

Rejeitar a proposta:

   POST/proposals/{proposalId}/action

Especificar os seguintes detalhes no corpo do pedido:

  • Ação: Rejeitar
  • Mensagem: especificar uma mensagem (se existir) para referência do corpo de validação e verificação
  • IDs de Ficheiro: especifique os IDs do ficheiro carregado para estes serem anexados à afirmação processada associada.

Devolver pedido de emissão de crédito para edições

Se existirem lacunas ou detalhes incorretos no pedido de emissão que pretende que o corpo de validação e verificação corrija, pode pedir edições no pedido de emissão. Esta capacidade está disponível apenas via API.

  1. Carregue os ficheiros (se existirem) que pretende partilhar com o corpo de validação e verificação como parte ao enviar o pedido de emissão de volta para edições.

  2. Mova o pedido de emissão (proposta CreditMint) para o estado submitterActionNeeded ao utilizar a API POST/propostas/{proposalId}/ação e especifique os seguintes detalhes:

    • Ação: ReturnForEdits
    • Mensagem: especifique uma mensagem (se existir) para referência do corpo de validação e verificação para compreenderem a razão para o pedido de edição.
    • IDs de Ficheiro: especifique os IDs dos ficheiros carregados (se existirem) para os ficheiros serem anexados à afirmação processada associada.

O corpo de validação e verificação pode agora ver a proposta que foi enviada de volta para edições. Agora também pode editar a afirmação processada e os resultados do ponto de verificação correspondentes. Podem atualizar atributos, bem como carregar ficheiros atualizados para os resultados do ponto de verificação.

Se necessário, o corpo de validação e de verificação podem pedir, neste ponto, esclarecimentos sobre a afirmação verificada ao devolver ao fornecedor a afirmação para edições. Depois de o fornecedor submeter novamente a afirmação, o corpo de validação e de verificação poderão rever e verificar a afirmação, atualizar a afirmação processada correspondente e, em seguida, submeter novamente o pedido de emissão para o registo.

  1. Carregue e anexe ficheiros aos resultados do ponto de verificação: POST/files e especifique os seguintes detalhes:

    • Ficheiro ou URL do ficheiro
    • Etiqueta
    • ResourceURI dos resultados do ponto de verificação associado

  2. Atualizar os atributos da afirmação processada, incluindo a recomendação de crédito: PATCH/processedClaim/{processed claim id}

  3. Submeta novamente o pedido de emissão e especifique os detalhes abaixo no corpo do pedidos da API: POST/proposals/{ proposal_id}/action

    • Ação: Submeter novamente
    • Mensagem: especificar uma mensagem (se existir) para referência do registo

Depois de o pedido ser submetido novamente, o registo emissor pode rever o pedido e aprovar, rejeitar ou voltar a pedir edições.

Ver créditos emitidos

   GET/credits

Procurar e ver créditos

Obter todos os créditos:

   GET/credits

Nota

Esta API devolverá a lista de todos os créditos. Em seguida, os compradores podem filtrar a lista por si só, com base no estado de crédito, para verem apenas os créditos listados.

Ver os detalhes do crédito (incluindo linhagem) para um crédito específico apresentado na lista:

   GET/credits/{creditId}/lineage

Listar créditos

Esta secção mostra como listar créditos num mercado para transação através de APIs. Para obter instruções sobre como utilizar a interface de utilizador, vá para Listar créditos no Serviço de Créditos Ambientais.

Registar como um comprador ou um mercado

Submeta a proposta MarketplaceTraderRegister como um proprietário ou comprador de crédito:

   POST/proposals

Obtenha e reveja todas as propostas MarketplaceTraderRegister como um mercado:

   GET/proposals

Aprovar ou rejeitar as propostas como um mercado:

   POST/proposals/{proposalId}/action

Obter e ver todos os comerciantes registados na respetiva plataforma como um mercado:

   GET/marketplaces/{marketplaceId}/traders

Submeter proposta para listar um crédito

Crie e submeta a proposta MarketplaceListingRegister:

   POST/proposals

Rever proposta para listar um crédito

   GET/proposals

   POST /proposals/{proposalId}/action

Gerir créditos

Esta secção mostra como gerir os créditos através de APIs. Para obter instruções sobre como utilizar a interface de utilizador, vá para Gerir créditos no Serviço de Créditos Ambientais.

Remover da lista um crédito

Dividir um crédito é uma operação independente do Serviço de Créditos Ambientais. Para obter informações sobre como dividir um crédito via API, vá para Dividir um crédito. Depois da divisão do crédito, pode continuar com o passo seguinte.

Crie e submeta a proposta MarketplaceListingDeregister:

   POST/proposals

Veja todas as propostas MarketplaceListingDeregister submetidas para revisão:

   GET/proposals

Para aprovar ou rejeitar a proposta:

   POST/proposals/{proposalId}/action

Transferir propriedade

   POST/credits/{creditId}/transfer/

Ver linhagem de crédito

As organizações com funções de fornecedor e registro podem ver a linhagem do crédito para os créditos que possuem ou emitiram:

   GET/credits/{creditId}/lineage

Dividir um crédito

Pode dividir um crédito em créditos subordinados. Esta funcionalidade está atualmente disponível apenas via API.

Dividir o crédito ao especificar as quantidades (em mtCO2e) para pelo menos dois créditos subordinados como um proprietário de crédito (para os créditos que possuem) ou como um mercado (para os créditos listados na respetiva plataforma):

   POST/credits/{creditId}/split

Transferir listagem de créditos

Um mercado pode transferir uma listagem de créditos a partir da respetiva plataforma para outro mercado. Esta transferência também é conhecida como transferência de oneração. No fluxo tradicional, um fornecedor listaria os créditos num mercado que o ajudarão com a procura, compensação e liquidação. Por vezes, um mercado poderá não conseguir efetuar a compensação e liquidação do pagamento por si só e poderá depender de uma plataforma diferente para o efetuar. Neste caso, o ativo tem de ser transferido para o novo mercado para concluir a transação. Esta funcionalidade só está atualmente disponível via APIs.

Como mercado, crie e submeta a proposta MarketplaceListingTransfer para um crédito listado na sua plataforma:

   POST/proposals

Enquanto mercado aprovador, veja todas as propostas MarketplaceListingTransfer que lhes foram submetidas para revisão:

   GET/proposals

Como um mercado de aprovador, aprove ou rejeite a proposta. Se a proposta for aprovada, o ónus dos créditos é transferido do mercado inicial para o mercado aprovador:

   POST/proposals/{proposalId}/action

Transferência parcial do ónus: um mercado pode transferir o ónus para crédito parcial ao dividir primeiro o crédito como uma ação independente. Para mais informações sobre como dividir um crédito, vá para Dividir um crédito. Após a divisão do crédito, continue com os passos acima para a transferência do ónus para os créditos subordinados.

Definir objetivos de emissões

Esta secção mostra como configurar os objetivos e as metas de redução de emissões através de APIs.

Criar objetivos de emissões

   POST/esgs

Ver objetivos de emissões

   GET/esgs

Monitorizar emissões

Esta secção mostra-lhe como monitorizar as suas emissões em relação à tabela de indicadores de emissão que define via APIs. Para obter instruções sobre como utilizar a interface de utilizador, vá para Monitorizar objetivos de emissões no Serviço de Créditos Ambientais.

Criar marcos para um período de reporte específico

   POST/esgs/{esgScorecardId}/milestones

Obter todos os marcos:

   GET/esgs/{esgScorecardId}/milestones

Obter marco específico:

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

Monitorizar as emissões reais em relação ao marco

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

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

Retirar créditos

Esta secção mostra como compensar o excesso de emissões ao retirar créditos de carbono possuídos via APIs. Para obter instruções sobre como utilizar a interface de utilizador, vá para Retirar créditos no Serviço de Créditos Ambientais.

Submeter proposta para retirar crédito

Criar e submeter a proposta ESGEmissionOffset:

   POST/proposals

Os compradores também podem retirar o crédito de carbono diretamente sem especificar as emissões a compensar. Esta funcionalidade só está disponível via API.

Criar e submeter a proposta CreditRetire:

   POST/proposals

Rever a proposta de retirada de crédito

   GET/proposals

   GET/proposals/{proposalId}

Anexar o ficheiro ao crédito que está a ser revisto para retirada:

   POST/files

   POST/proposals/{proposalId}/action

Retirada de crédito parcial

Para obter informações sobre como dividir um crédito via API, vá para Dividir um crédito.

Após a divisão do crédito, utilize as APIs nos passos anteriores para compensação e retirada.

Gerir ficheiros

Esta secção mostra como anexar, ver e eliminar ficheiros para ativos como o projeto, a afirmação e os créditos através de APIs. Para obter instruções sobre como utilizar a interface de utilizador, vá para Gerir ficheiros no Serviço de Créditos Ambientais.

Anexar ficheiros

Utilize a API POST/ficheiros para anexar um ficheiro a um ativo. Terá de especificar os seguintes detalhes:

  • Ficheiro ou URI do ficheiro
  • URI do recurso do ativo
  • Etiqueta descritiva para o ficheiro

Ver ficheiros

Ver a lista de ficheiros juntamente com as propriedades do ficheiro para um ativo utilizando a API de detalhes de ativos:

Projeto de benefícios modulares:

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

Afirmações:

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

Pontos de verificação da afirmação:

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

Crédito:

   GET/credits/{creditId}

Utilizar o ID de ficheiro presente nas propriedades do ficheiro para transferir o ficheiro:

   GET/files/{fileId}

Eliminar ficheiros

Utilizar o ID de ficheiro do ficheiro para chamar a API de eliminação:

   DELETE/files/{fileId}

Consulte também

Descrição geral do Serviço de Créditos Ambientais
Configurar Serviço de Créditos Ambientais
Glossário do Serviço de Créditos Ambientais