Share via

Visão geral de referência da API para Serviço de Crédito Ambiental

  • Artigo

Microsoft Cloud for Sustainability Technical Summit – Maio de 2024

Importante

Algumas ou todas estas funcionalidades estão disponíveis como parte de uma versão preliminar. O conteúdo e a funcionalidade estão sujeitos a alterações. Você pode acessar o ambiente de área restrita do Serviço de Crédito Ambiental (versão preliminar) para fazer uma avaliação de 30 dias. Para usar o Serviço de Crédito Ambiental (versão preliminar) em um ambiente de produção, preencha o Formulário de inscrição do Serviço de Crédito Ambiental (versão preliminar).

Este artigo ajuda você a realizar tarefas com as APIs REST do Serviço de Crédito Ambiental. Para ver a referência completa da API, acesse Referência da API do Serviço de Crédito Ambiental. Você pode encontrar o arquivo Swagger emAPIs REST do Serviço de Crédito Ambiental.

Registrar projetos

Esta seção mostra como criar, enviar e revisar projetos ecológicos por meio de APIs. Para obter instruções sobre como usar a interface do usuário, acesse Registrar projetos no Serviço de Crédito Ambiental.

Criar um projeto

Para carregar e anexar arquivos no momento da criação do projeto:

  1. Carregue arquivos usando POST/files. Especifique os detalhes a seguir na API:

    • Arquivo ou URL do arquivo
    • Marca descritiva para o arquivo

  2. Crie o projeto ecológico e o projeto de benefício modular correspondente e especifique o fileID que é retornado na resposta da chamada de API POST/files como um atributo no corpo da solicitação de API de criação do projeto: POST/ecoprojects.

Salvar e enviar um projeto

Pesquise os detalhes do projeto:

   GET/ecoProjects/{ecoProjectId}

Veja a lista de arquivos (e seus metadados associados) anexados ao projeto de benefício modular:

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

Baixe um arquivo usando o fileID que está disponível como parte dos metadados do arquivo:

   GET/files/{fileId}

Adicione os arquivos ao projeto de benefício modular:

   POST/files

Especifique o URI do recurso do projeto de benefício modular no corpo da solicitação.

Envie o projeto de benefício modular para registro enviando a proposta MBPRegister:

   POST/proposals

Exibir um projeto

Pesquise todas as propostas:

   GET/proposals

Pesquise detalhes de uma proposta específica:

   GET/proposals/{proposalId}

Pesquise detalhes de um projeto ecológico:

   GET/ecoProjects/{ecoProjectId}

Pesquise detalhes do MBP específico para revisar:

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

Obtenha a lista de arquivos (e os metadados associados) anexados ao projeto de benefício modular:

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

Baixe os arquivos usando o fileID que está disponível como parte da resposta de API anterior:

   GET/files/{fileId}

Anexe um arquivo ao projeto de benefício modular:

   POST/files

Aprovar ou rejeitar uma proposta

Carregue arquivos (se houver):

POST/arquivos e especifique File (ou FileUrl) e os detalhes da marca

Rejeite a solicitação de registro:

POST/proposals/{proposalId}/action e especifique os seguintes detalhes no corpo da solicitação

  • Ação: Rejeitar

  • Mensagem: Especifique um comentário (se houver) que você deseja inserir para rejeitar o registro.

  • FileIDs: Especifique os IDs dos arquivos que foram carregados.

Excluir um arquivo

Veja a lista de arquivos anexados ao projeto de benefício modular:

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

Identifique o arquivo que você carregou, porque um usuário pode excluir apenas os arquivos que carregou.

Exclua o arquivo:

   DELETE/files/{fileId}

Retornar uma proposta para edições

Se houver falhas ou detalhes incorretos nos atributos ou arquivos do projeto que você deseja que o fornecedor corrija ou adicione, você pode solicitar edições no projeto.

  1. Carregue arquivos, se houver, que devem ser compartilhados com o fornecedor:

    POST/files

  2. Mova a proposta MBPRegister para a fase submitterActionNeeded realizando a ação returnForEdits com a API POST/proposals/{proposalId}/action e especifique os seguintes detalhes no corpo da solicitação:

    • Ação: returnForEdits

    • Mensagem: Especifique um comentário (se necessário) para referência do fornecedor ao retornar a solicitação para edições.

    • IDs de arquivo: Especifique a ID do arquivo carregado aqui para anexar o arquivo ao projeto de benefício modular em questão.

    Depois disso, o projeto de benefício modular passa para o estado returnedForEdits.

Os fornecedores agora podem visualizar a proposta que foi devolvida para edição. Eles agora podem editar os atributos do projeto de benefício modular e fazer upload de mais arquivos.

  • Exiba a proposta: GET/proposals/{proposalId}

  • Carregue e anexe arquivos ao projeto de benefício modular: POST/files e especifique os seguintes detalhes no corpo da solicitação:

    • Arquivo ou URL do arquivo
    • Marca: marca de arquivo descritiva
    • ResourceURI: Especifique o URI do recurso do respectivo projeto de benefício modular.

  • Atualizar atributos do projeto de benefício modular

    • Obtenha os detalhes atualizados do projeto de benefício modular usando GET/ecoprojects/{ecoproject_id}/mbps{mbp_id}/ e copie o valor Etag do cabeçalho de resposta.
    • Atualize os atributos do projeto de benefício modular usando a API PATCH/ecoprojects/{ecoproject_id}/mbps{mbp_id}/ e especifique o valor de Etag na chave If-Match no cabeçalho.

Após a conclusão das alterações, o fornecedor pode enviar a proposta de volta ao registro usando a API POST/proposals/{proposalId}/action e especificar os seguintes detalhes na solicitação:

  • Ação: Enviar

  • Mensagem: Especifique um comentário (se houver) para referência de registro.

Registrar projetos adicionais de benefícios modulares

Envie o benefício ecológico para o registro emissor criando e enviando uma proposta MBPRegister:

   POST/proposal

Revisar um projeto de benefício modular

Exiba os detalhes da proposta:

   GET/proposals/{proposalId}

Veja todos os detalhes do projeto:

   GET/ecoProjects/{ecoProjectId}

Veja os detalhes do projeto de benefício modular individual do projeto:

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

Aprove ou rejeite a proposta de registro, ou devolva-a para edições:

   POST/proposals/{proposalId}/action

Processar reclamações

Esta seção mostra como processar reclamações por meio de APIs. Para obter instruções sobre como usar a interface do usuário, acesse Processar reclamações no Serviço de Crédito Ambiental.

Criar reclamações

Crie uma reclamação:

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

Carregue e anexe arquivos aos pontos de verificação da reclamação:

   POST/files

Especifique os detalhes a seguir na solicitação:

  • Arquivo ou URL do arquivo
  • Marca
  • URI de recurso da reclamação

Enviar reclamações

Crie e envie a proposta do projeto de benefício modularClaimVerify:

   POST/proposals

Exiba detalhes da proposta enviada:

   GET/proposal/{proposalId}

Exiba os detalhes da reclamação:

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

Verificar reclamação

Veja propostas:

   GET/proposals

Pesquise os detalhes de uma proposta específica:

   GET/proposals/{proposalId}

Pesquise os detalhes de uma reclamação específica para a qual a proposta de verificação foi enviada:

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

Aceite a tarefa de verificar a reclamação:

   POST/proposals/{proposalId}/action

Liste os arquivos associados a um projeto de benefício modular:

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

Liste os arquivos associados aos pontos de verificação da reclamação:

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

Visualize um arquivo anexado a um ativo específico:

   GET/files/{fileId}

Depois que a reclamação for aceita, uma 'Reclamação processada' correspondente será criada. Registre suas descobertas de verificação na reclamação processada. Isso inclui a atualização de Quantidade, benefícios conjuntos da reclamação. Antes de enviar a solicitação de emissão de crédito, você deve atualizar as recomendações de crédito também na declaração processada:

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

Para cada ponto de verificação verificado, você pode atualizar suas descobertas de verificação no resultado do ponto de verificação correspondente da declaração processada:

  • Carregue e anexe seus relatórios de descoberta de verificação aos resultados do ponto de verificação da declaração processada usando a API POST/files e especifique o Arquivo ou URL do Arquivo, Tag e ResourceUri (este será o uri do recurso do resultado do ponto de verificação) no corpo da solicitação.
  • 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 usando GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} e copie o valor de Etag do cabeçalho de resposta.
    • Atualize os atributos do resultado do ponto de verificação usando a API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} e especifique o valor de Etag na chave If-Match no cabeçalho.
    • Você também pode atualizar os resultados do ponto de verificação usando a API de patch para reclamações processadas.

Após a conclusão da verificação, aprove ou rejeite a proposta MBPClaimVerify:

   POST/proposals/{proposalId}/action

Especifique os detalhes a seguir:

  • Ação: Aprovar ou rejeitar

  • Mensagem: Especifique um comentário (se houver) para referência do fornecedor.

Uma vez aprovada a proposta MBPClaimVerify, crie e envie a proposta CreditMint para enviar a solicitação de emissão de crédito:

   POST/proposals/

Retornar solicitação de reclamação para edições

Se houver falhas ou detalhes incorretos na solicitação de declaração que o Órgão de Validação e Verificação quer que o fornecedor corrija, você pode solicitar edições nela em vez de aprovar ou rejeitar a solicitação. Esse recurso está disponível apenas por API.

  1. Carregue e anexe arquivos (que você deseja compartilhar com o fornecedor) à declaração processada ou ao resultado do ponto de verificação da declaração processada: POST/files e especifique os seguintes detalhes no corpo da solicitação

    • Arquivo ou URL do arquivo
    • Marca
    • URI do recurso da declaração processada ou resultado do ponto de verificação da declaração processada à qual o arquivo deve ser adicionado

  2. Mova a proposta MBPClaimVerify para a fase submitterActionNeeded realizando a ação returnForEdits com a API POST/proposals/{proposalId}/action e especifique os seguintes detalhes no corpo da solicitação:

    • Ação: returnForEdits
    • Mensagem: Especifique um comentário (se necessário) para referência do fornecedor ao retornar a solicitação para edições.

Editar a proposta retornada

Os fornecedores então podem visualizar a proposta que foi devolvida para edição. Eles agora podem editar os atributos da reclamação e do ponto de verificação e carregar mais arquivos para os pontos de verificação da reclamação:

  1. Exiba a proposta: GET/proposals/{proposalId}

    • Se necessário, o fornecedor também pode visualizar os detalhes da declaração processada correspondente usando a API GET/processedClaims/{processed_claim_Id}.

  2. Carregue e anexe arquivos (se houver) aos pontos de verificação da reclamação: POST/files e especifique os seguintes detalhes no corpo da solicitação

    • Arquivo ou URL do arquivo
    • Marca
    • URI do recurso do ponto de verificação ao qual o arquivo deve ser adicionado

  3. Atualize os atributos da reclamação usando uma operação PATCH:

    • Obtenha os detalhes da reclamação mais recente e anote o valor de ETag no cabeçalho da resposta: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Atualize os atributos da reclamação e especifique o valor de ETag na chave "If-Match" do cabeçalho da solicitação: PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Atualize os atributos do ponto de verificação da reclamação usando uma operação PATCH:

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

    • Atualize os atributos da reclamação e especifique o valor de ETag na chave "If-Match" do cabeçalho da solicitação: 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 da solicitação JSON siga a mesma estrutura da chamada à API get correspondente.

  5. Após a conclusão das modificações, o fornecedor pode enviar a proposta de volta ao corpo de validação e verificação usando a API POST/proposals/{proposalId}/action e especificar os seguintes detalhes no corpo da solicitação:

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

Depois que a proposta for reenviada, o órgão de Validação e Verificação poderá revisar a proposta e aprová-la, rejeitá-la ou solicitar edições novamente.

Retirar a solicitação de emissão de crédito

Opção de retirada da proposta de solicitação de emissão de crédito enviada (CreditMint):

Após o envio da proposta de emissão de crédito ao registro, caso haja algum problema pelo qual você queira retirar a proposta enviada, poderá fazê-lo se o registro não tiver dado seguimento a ela. No momento, esta capacidade está disponível somente por APIs.

  • Mova a proposta CreditMint que está no estado enviado para o estado retirado usando a API POST/proposals/{proposalId}/action e especifique os seguintes detalhes no corpo da solicitação:

    • Ação: Retirar
    • Mensagem: Especifique o motivo (se houver) para retirar a proposta de referência do registro.

O status da proposta agora é Retirado.

Após o cancelamento da solicitação de emissão de crédito, o órgão de validação e verificação pode modificar a 'declaração processada' e os resultados do ponto de verificação associado e, em seguida, reenviar a solicitação de emissão de crédito.

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

    • Arquivo ou URL do arquivo
    • Marca
    • ResourceURI do resultado do ponto de verificação associado.

  • Atualize os atributos da declaração processada: PATCH/processedClaims/{processedClaim_Id}

  • Reenvie a solicitação de emissão ao registro e especifique os seguintes detalhes no corpo da solicitação da API: POST/proposals/{ proposal_id}/action

    • Ação: Especifique como Reenviar
    • Mensagem: Especifique message/comment (se houver) para referência de registro

Emitir créditos

Esta seção mostra como visualizar e emitir créditos via APIs. Para obter instruções sobre como usar a interface do usuário, acesse Emitir créditos no Serviço de Crédito Ambiental.

Analisar propostas de emissão de crédito

Visualize a proposta 'Token mint' enviada e obtenha o URI do recurso 'declaração processada' que foi enviado para revisão:

GET/proposal/{proposalId}

Revise os resultados da verificação do órgão de validação e verificação visualizando a declaração processada e os resultados do ponto de verificação associado (junto com os arquivos associados):

GET/processedClaims/{processedClaims_Id}

Veja a reclamação e os detalhes do ponto de verificação correspondente (junto com a lista de arquivos anexados pelo fornecedor para os pontos de verificação):

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

Veja os detalhes do projeto de benefício modular com a lista de arquivos anexados:

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

Baixe um arquivo usando o ID do arquivo:

   GET/files/{fileId}

Aprovar créditos

Carregue arquivos para anexar ao crédito para fins de emissão: POST/files e especifique os seguintes detalhes no corpo da solicitação:

  • Arquivo ou URL do arquivo
  • Marca

Aprove a proposta:

   POST/proposals/{proposalId}/action

Especifique os detalhes a seguir no corpo da solicitação:

  • Ação: especifique como Mint
  • Mensagem: Especifique a mensagem (se houver) para validação e referência do corpo de verificação
  • IDs de arquivo: Especifique os IDs dos arquivos carregados para que os arquivos sejam anexados ao crédito emitido
  • Quantidade
  • Vintage
  • ID do Ativo
  • Valor determinado

Observação

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

Rejeitar uma proposta

Carregue arquivos (se houver) à declaração processada: POST/files e especifique os seguintes detalhes:

  • Arquivo ou URL do arquivo
  • Marca

Rejeite a proposta:

   POST/proposals/{proposalId}/action

Especifique os detalhes a seguir no corpo da solicitação:

  • Ação: Rejeitar
  • Mensagem: Especifique uma mensagem (se houver) para validação e referência do corpo de verificação
  • IDs de arquivo: Especifique os IDs de arquivos carregados para anexá-los à declaração processada associada.

Retornar uma solicitação de emissão de crédito para edições

Se houver falhas ou detalhes incorretos na solicitação de emissão que você deseja que o corpo de validação e verificação corrija, você pode solicitar edições nela. Esse recurso está disponível apenas por API.

  1. Carregue os arquivos (se houver) que deseja compartilhar com o corpo de validação e verificação como parte do envio da solicitação de emissão de volta para edições.

  2. Mova a solicitação de emissão (proposta CreditMint) para o estado submitterActionNeeded usando a API POST/proposals/{proposalId}/action e especifique os seguintes detalhes:

    • Ação: ReturnForEdits
    • Mensagem: Especifique uma mensagem (se houver) para referência do corpo de validação e verificação para que ele possa entender o motivo da solicitação de edição.
    • IDs de arquivo: Especifique os IDs de arquivos carregados (se houver) para anexá-los à declaração processada associada.

O corpo de validação e verificação agora pode visualizar a proposta que foi enviada de volta para edições. Agora eles também podem editar a declaração processada correspondente e os resultados do ponto de verificação. Eles podem atualizar atributos, bem como fazer upload de arquivos atualizados para os resultados do ponto de verificação.

Se necessário, o órgão de validação e verificação neste ponto pode solicitar esclarecimentos sobre a declaração verificada, devolvendo a declaração para edições ao fornecedor. Uma vez que o fornecedor reenvie a declaração, o órgão de validação e verificação pode revisar e verificar a declaração, atualizar a declaração processada correspondente e, em seguida, reenviar a solicitação de emissão ao registro.

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

    • Arquivo ou URL do arquivo
    • Marca
    • ResourceURI dos resultados do ponto de verificação associado

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

  3. Reenvie a solicitação de emissão e especifique os detalhes abaixo no corpo da solicitação da API: POST/proposals/{ proposal_id}/action

    • Ação: Reenviar
    • Mensagem: Especifique uma mensagem (se houver) para referência de registro

Depois que a solicitação for reenviada, o registro de emissão pode revisar a solicitação e aprová-la, rejeitá-la ou solicitar edições novamente.

Ver créditos emitidos

   GET/credits

Pesquisar e visualizar créditos

Obtenha todos os créditos:

   GET/credits

Observação

Esta API retornará a lista de todos os créditos. Os compradores podem filtrar a lista por conta própria com base no status de crédito para visualizar apenas os créditos listados.

Visualize os detalhes de crédito (incluindo linhagem) para um crédito específico exibido na lista:

   GET/credits/{creditId}/lineage

Listar créditos

Esta seção mostra como listar créditos em um marketplace para negociação por meio de APIs. Para obter instruções sobre como usar a interface do usuário, acesse Listar créditos no Serviço de Crédito Ambiental.

Registrar-se como comprador ou marketplace

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

   POST/proposals

Busque e revise todas as propostas do MarketplaceTraderRegister como um marketplace:

   GET/proposals

Aprove ou rejeite as propostas como marketplace:

   POST/proposals/{proposalId}/action

Busque e visualize todos os traders cadastrados em sua plataforma como marketplace:

   GET/marketplaces/{marketplaceId}/traders

Enviar proposta para listar um crédito

Crie e envie a proposta do MarketplaceListingRegister:

   POST/proposals

Analisar a proposta para listar um crédito

   GET/proposals

   POST /proposals/{proposalId}/action

Gerenciar créditos

Esta seção mostra como gerenciar créditos por meio de APIs. Para obter instruções sobre como usar a interface do usuário, acesse Gerenciar créditos no Serviço de Crédito Ambiental.

Excluir um crédito

Dividir crédito é uma operação independente no Serviço de Crédito Ambiental. Para obter informações sobre como dividir um crédito via API, acesse Dividir um crédito. Após as divisões de crédito, você pode continuar para a próxima etapa.

Crie e envie a proposta do MarketplaceListingDeregister:

   POST/proposals

Veja todas as propostas de MarketplaceListingDeregister enviadas para revisão:

   GET/proposals

Para aprovar ou rejeitar a proposta:

   POST/proposals/{proposalId}/action

Transferir propriedade

   POST/credits/{creditId}/transfer/

Exibir linhagem de crédito

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

   GET/credits/{creditId}/lineage

Dividir um crédito

Você pode dividir um crédito em créditos secundários. Atualmente, esta funcionalidade está disponível somente por API.

Divida o crédito especificando as quantidades (em mtCO2e) para pelo menos dois créditos secundários como proprietário do crédito (para os créditos que ele possui) ou como marketplace (para os créditos listados em sua plataforma):

   POST/credits/{creditId}/split

Transferir listagem de crédito

Um marketplace pode transferir uma listagem de crédito de sua plataforma para outro marketplace. Essa transferência também é conhecida como transferência de ônus. No fluxo tradicional, um fornecedor lista os créditos em um marketplace que ajudará na demanda, compensação e liquidação. Às vezes, um marketplace pode não ser capaz de realizar a compensação e liquidação do pagamento por conta própria e pode depender de uma plataforma diferente para realizá-lo. Nesse caso, o ativo deve ser transferido para o novo marketplace para concluir a transação. Atualmente, este recurso está disponível somente via APIs.

Como marketplace, crie e envie a proposta MarketplaceListingTransfer para um crédito listado em sua plataforma:

   POST/proposals

Como um mercado aprovador, exiba todas as propostas do MarketplaceListingTransfer enviadas para a revisão:

   GET/proposals

Como marketplace aprovador, aprove ou rejeite a proposta. Se a proposta for aprovada, o ônus dos créditos será transferido do marketplace inicial para o marketplace aprovador:

   POST/proposals/{proposalId}/action

Transferência parcial de ônus: um marketplace pode transferir ônus para crédito parcial dividindo primeiro o crédito como uma ação independente. Para obter informações sobre como dividir um crédito, acesse Dividir um crédito. Após a divisão do crédito, continue com as etapas acima para transferência de ônus para créditos secundários.

Definir metas de emissão

Esta seção mostra como configurar metas e objetivos de redução de emissões por meio de APIs.

Criar metas de emissão

   POST/esgs

Exibir metas de emissão

   GET/esgs

Rastrear emissões

Esta seção mostra como rastrear suas emissões em relação ao scorecard de emissão definido por meio de APIs. Para obter instruções sobre como usar a interface do usuário, acesse Rastrear emissões no Serviço de Crédito Ambiental.

Criar marcos para um período de relatório específico

   POST/esgs/{esgScorecardId}/milestones

Pesquise todos os marcos:

   GET/esgs/{esgScorecardId}/milestones

Pesquise um marco específico:

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

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

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

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

Suspender créditos

Esta seção mostra como compensar as emissões em excesso cancelando os créditos de carbono próprios por meio de APIs. Para obter instruções sobre como usar a interface do usuário, acesse Suspender créditos no Serviço de Crédito Ambiental.

Enviar proposta de retirada de crédito

Crie e envie a proposta ESGEmissionOffset:

   POST/proposals

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

Crie e envie a proposta CreditRetire:

   POST/proposals

Revisar proposta de retirada de crédito

   GET/proposals

   GET/proposals/{proposalId}

Anexar arquivo ao crédito que está sendo analisado 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, acesse Dividir um crédito.

Após a divisão do crédito, use as APIs nas etapas anteriores para compensação e retirada.

Gerenciar arquivos

Esta seção mostra como anexar, visualizar e excluir arquivos de recursos como projeto, reivindicação e créditos por meio de APIs. Para obter instruções sobre como usar a interface do usuário, acesse Gerenciar arquivos no Serviço de Crédito Ambiental.

Anexar arquivos

Use a API POST/files para anexar um arquivo a um ativo. Você precisa especificar os seguintes detalhes:

  • Arquivo ou URI do arquivo
  • URI de recurso do ativo
  • Marca descritiva para o arquivo

Exibir arquivos

Visualize a lista de arquivos junto com as propriedades do arquivo para um ativo usando a API de detalhes do ativo:

Projeto de benefício modular:

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

Reclamações:

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

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

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

Crédito:

   GET/credits/{creditId}

Use o ID do arquivo presente nas propriedades do arquivo para baixar o arquivo:

   GET/files/{fileId}

Excluir arquivos

Use o ID do arquivo para chamar a API de exclusão:

   DELETE/files/{fileId}

Confira também

Visão geral do Serviço de Crédito Ambiental
Configurar o Serviço de Crédito Ambiental
Glossário do Serviço de Crédito Ambiental