Panoramica dei riferimenti API per Servizio di credito ambientale
Importante
Alcune o tutte queste funzionalità sono disponibili come parte di una versione di anteprima. Il contenuto e la funzionalità sono soggetti a modifiche. Puoi accedere all'ambiente sandbox di Servizio di credito ambientale (anteprima) per una versione di valutazione di 30 giorni. Per usare Servizio di credito ambientale (anteprima) in un ambiente di produzione, riempi un modulo di iscrizione a Servizio di credito ambientale (anteprima).
Questo articolo ti aiuta a eseguire attività con le API REST di Servizio di credito ambientale. Per vedere il riferimento API completo, vai a Riferimento API di Servizio di credito ambientale. Puoi trovare il file Swagger in API REST di Servizio di credito ambientale.
- Registra progetti
- Elaborare reclami
- Emettere crediti
- Elenco crediti
- Gestisci i crediti
- Stabilire obiettivi di emissione
- Traccia le emissioni
- Ritirare i crediti
- Gestisci i file
Registra progetti
Questa sezione mostra come creare, inviare e rivedere progetti ecologici tramite API. Per le istruzioni sull'utilizzo dell'interfaccia utente, vai a Registra progetti in Servizio di credito ambientale.
- Crea un progetto
- Salva e invia un progetto
- Visualizza un progetto
- Approvare o rifiutare una proposta
- Eliminare un file
- Restituisci una proposta per le modifiche
- Registra progetti aggiuntivi di benefici modulari
- Esaminare un progetto di benefit modulare
Crea un progetto
Per caricare e allegare file al momento della creazione del progetto:
Caricare i file usando POST/file. Specificare i dettagli seguenti nell'API:
- File o URL file
- Tag descrittivo per il file
Creare il progetto ecologico e il progetto di vantaggio modulare corrispondente e specificare l'ID del file restituito nella risposta della chiamata API POST/file come attributo nel corpo della richiesta API di creazione del progetto: POST/ecoprojects.
Salva e invia un progetto
Recupera i dettagli del progetto:
GET/ecoProjects/{ecoProjectId}
Visualizza l'elenco dei file (e dei relativi metadati associati) allegati al progetto di vantaggio modulare:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Scarica un file utilizzando l'ID file disponibile come parte dei metadati del file:
GET/files/{fileId}
Aggiungere i file al progetto dei vantaggi modulare:
POST/files
Specifica l'URI della risorsa del progetto di vantaggi modulare nel corpo della richiesta.
Invia il progetto di vantaggi modulare per la registrazione inviando la proposta MBPRegister:
POST/proposals
Visualizza un progetto
Recupera tutte le proposte:
GET/proposals
Recupera i dettagli di una proposta specifica
GET/proposals/{proposalId}
Recupera i dettagli di un progetto ecologico:
GET/ecoProjects/{ecoProjectId}
Recupera i dettagli dell'MBP specifico da esaminare:
GET/ecoProjects/{ecoProjectId}/mbps/{mbpId}
Ottieni l'elenco dei file (e i metadati associati) allegati al progetto di vantaggio modulare:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Scarica i file utilizzando fileId disponibile come parte della risposta API precedente:
GET/files/{fileId}
Allega un file al progetto dei vantaggi modulare:
POST/files
Approvare o rifiutare una proposta
Caricare file (se presenti):
POST/file e specifica File (o FileUrl) e i dettagli del tag
Rifiutare la richiesta di registrazione:
POST/proposals/{proposalId}/action e specifica i seguenti dettagli nel corpo della richiesta
Azione: Rifiuta
Messaggio: specifica un commento (se presente) che desideri fornire per rifiutare la registrazione.
FileID: specifica gli ID file dei file che sono stati caricati.
Eliminare un file
Visualizza l'elenco dei file allegati al progetto di vantaggi modulare:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Identifica il file che hai caricato, perché un utente può eliminare solo i file che ha caricato.
Elimina il file:
DELETE/files/{fileId}
Restituire una proposta per le modifiche
Se sono presenti lacune o dettagli errati negli attributi o nei file del progetto che si desidera che il fornitore corregga o aggiunga, è possibile richiedere modifiche al progetto.
Carica i file, se presenti, che devono essere condivisi con il fornitore:
POST/file
Sposta la proposta MBPRegister nello stato submitterActionNeeded prendendo l'azione returnForEdits utilizzando l'API POST/proposals/{proposalId}/action e specifica i seguenti dettagli nel corpo della richiesta:
Azione: returnForEdits
Messaggio: specifica un commento (se necessario) per il riferimento del fornitore durante la restituzione della richiesta di modifiche.
ID file: specificare qui l'ID del file caricato per allegare il file al progetto di vantaggi modulare interessato.
Al termine, il progetto di vantaggi modulare passa allo stato returnedForEdits.
I fornitori possono ora visualizzare la proposta che è stata restituita per le modifiche. Ora possono modificare gli attributi del progetto di vantaggio modulare e caricare più file nel progetto di vantaggio modulare.
Visualizza proposta: GET/proposals/{proposalId}
Carica e allega file al progetto di vantaggio modulare: POST/file e specifica i seguenti dettagli nel corpo della richiesta:
- File o URL file
- Tag: tag per il file descrittivo
- ResourceURI: specifica l'URI della risorsa del rispettivo progetto di vantaggio modulare.
Aggiorna gli attributi del progetto di vantaggi modulare
- Ottieni i dettagli aggiornati del progetto di vantaggi modulare utilizzando GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} e copia il valore Etag dall'intestazione della risposta.
- Aggiorna gli attributi del progetto di vantaggi modulare utilizzando l'API PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} e specifica il valore Etag nella chiave If-Match nell'intestazione.
Una volta completate le modifiche, il fornitore può ora inviare nuovamente la proposta al registro utilizzando l'API POST/proposals/{proposalId}/action e specificare i seguenti dettagli nella richiesta:
Azione: Invia
Messaggio: specificare un commento (se presente) per il riferimento al registro.
Registrare ulteriori progetti di vantaggi modulari
Inviare il vantaggio ecologico per la registrazione al registro di emissione creando e inviando una proposta MBPRegister:
POST/proposal
Esaminare un progetto di vantaggi modulare
Visualizza i dettagli della proposta:
GET/proposals/{proposalId}
Visualizza i dettagli dell'intero progetto:
GET/ecoProjects/{ecoProjectId}
Visualizza i dettagli del singolo progetto di vantaggi modulare del progetto:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Approva o rifiuta la proposta di registrazione o restituiscila per le modifiche:
POST/proposals/{proposalId}/action
Elabora attestazioni
Questa sezione mostra come elaborare attestazioni tramite API. Per le istruzioni sull'utilizzo dell'interfaccia utente, vai a Elabora attestazioni in Servizio di credito ambientale.
- Crea reclami
- Invia reclami
- Verifica il reclamo
- Richiesta di restituzione per modifiche
- Modifica la proposta restituita
- Ritirare la richiesta di emissione del credito
Crea attestazioni
Crea attestazione:
POST/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims
Carica e allega file per attestare i punti di controllo:
POST/files
Specifica i seguenti dettagli nella richiesta:
- File o URL file
- Tag
- URI della risorsa dell'attestazione
Inoltra attestazioni
Crea e invia la proposta modulare di vantaggi projectClaimVerify:
POST/proposals
Visualizzare i dettagli della proposta inoltrata:
GET/proposal/{proposalId}
Visualizza dettagli della proposta:
POST/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Verifica attestazione
Visualizza proposte:
GET/proposals
Recupera i dettagli di una proposta specifica:
GET/proposals/{proposalId}
Recupera i dettagli di un'attestazione specifico per il quale è stata presentata la proposta di verifica:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Accetta l'attività di verificare l'attestazione:
POST/proposals/{proposalId}/action
Elenca i file associati a un progetto di vantaggi modulare:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Elenca i file associati ai punti di controllo dell'attestazione:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpclaims/{claimId}/checkpoints
Visualizza un allegato file a una risorsa specifica:
GET/files/{fileId}
Una volta che l'attestazione è stata accettata, viene creata un'"attestazione elaborata" corrispondente. Registra i risultati della verifica nell'attestazione elaborata. Questi includono l'aggiornamento della quantità e dei co-vantaggi dell'attestazione. Prima di inviare la richiesta di emissione del credito, nell'attestazione elaborata devi aggiornare le raccomandazioni relative al credito:
- Ottieni i dettagli dell'attestazione elaborata utilizzando GET/processedClaims/{processed_claim_id} e copia il valore Etag dall'intestazione della risposta.
- Aggiorna gli attributi dell'attestazione elaborata utilizzando l'API PATCH/processedClaims/{processed_claim_id} e specifica il valore Etag nella chiave If-Match nell'intestazione.
Per ogni punto di controllo che verifichi, puoi aggiornare i risultati della verifica nel risultato del punto di controllo corrispondente dell'attestazione elaborata:
- Carica e allega i report sui risultati della verifica ai risultati del punto di controllo dell'attestazione elaborata utilizzando l'API POST/files e specifica il file o l'URL del file, il tag e ResourceUri (questo sarà l'URI della risorsa del risultato del punto di controllo) nel corpo della richiesta.
- Aggiorna l'effetto ambientale prima e dopo gli attributi del risultato del punto di controllo (se necessario):
- Ottieni i dettagli del risultato del punto di controllo utilizzando GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} e copia il valore Etag dall'intestazione della risposta.
- Aggiorna gli attributi del risultato del punto di controllo utilizzando l'API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} e specifica il valore Etag nella chiave If-Match nell'intestazione.
- È inoltre possibile aggiornare i risultati del checkpoint utilizzando l'API della patch per le attestazioni elaborate.
Una volta completata la verifica, approva o rifiuta la proposta MBPClaimVerify:
POST/proposals/{proposalId}/action
Specifica i dettagli seguenti:
Azione: Approva o rifiuta
Messaggio: specificare un commento (se presente) per il riferimento fornitore.
Una volta approvata la proposta MBPClaimVerify, crea e invia la proposta CreditMint per inviare la richiesta di emissione del credito:
POST/proposals/
Restituisci la richiesta di attestazione per le modifiche
Se sono presenti lacune o dettagli errati nella richiesta di attestazione che l'ente di convalida e verifica vuole che il fornitore corregga, puoi richiedere modifiche alla richiesta di attestazione anziché approvare o rifiutare la richiesta. Questa capacità è disponibile solo tramite API.
Carica e allega i file (che desideri condividere con il fornitore) all'attestazione elaborata o al risultato del punto di controllo dell'attestazione elaborata: POST/file e specifica i seguenti dettagli nel corpo della richiesta
- File o URL file
- Tag
- URI della risorsa dell'attestazione elaborata o risultato del punto di controllo dell'attestazione elaborata a cui deve essere aggiunto il file
Sposta la proposta MBPClaimVerify nello stato submitterActionNeeded prendendo l'azione returnForEdits utilizzando l'API POST/proposals/{proposalId}/action e specifica i seguenti dettagli nel corpo della richiesta:
- Azione: returnForEdits
- Messaggio: specifica un commento (se necessario) per il riferimento del fornitore durante la restituzione della richiesta di modifiche.
Modifica la proposta restituita
I fornitori possono quindi visualizzare la proposta che è stata restituita per le modifiche. Ora possono modificare gli attributi dell'attestazione e del punto di controllo e possono caricare più file nei punti di controllo dell'attestazione:
Visualizza proposta: GET/proposals/{proposalId}
- Se necessario, il fornitore può anche visualizzare i dettagli dell'attestazione elaborata corrispondente utilizzando l'API GET/processedClaims/{processed_claim_Id}.
Carica e allega file (se presenti) ai punti di controllo dell'attestazione: POST/file e specifica i seguenti dettagli nel corpo della richiesta
- File o URL file
- Tag
- URI della risorsa del punto di controllo a cui deve essere aggiunto il file
Aggiorna gli attributi dell'attestazione utilizzando un'operazione PATCH:
- Ottieni i dettagli dell'ultimo attestazione e annota il valore ETag nell'intestazione della risposta: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
- Aggiorna gli attributi dell'attestazione e specifica il valore Etag nella chiave "If-Match" dell'intestazione della richiesta: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
Aggiorna gli attributi del punto di controllo dell'attestazione utilizzando un'operazione PATCH:
Ottieni i dettagli dell'ultimo punto di controllo e annota il valore ETag nell'intestazione della risposta: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}
Aggiorna gli attributi dell'attestazione e specifica il valore Etag nella chiave If-Match dell'intestazione della richiesta: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}
Nota
Mentre specifichi gli attributi di aggiornamento, assicurati che il corpo della richiesta JSON segua la stessa struttura della chiamata Ottieni API corrispondente.
Una volta completate le modifiche, il fornitore può quindi inviare nuovamente la proposta all'ente di convalida e di verifica usando l'API POST/proposals/{proposalId}/action e specificare i seguenti dettagli nel corpo della richiesta:
- Azione: Invia di nuovo
- Messaggio: specificare eventuali commenti (se richiesti) per il riferimento dell'ente di convalida e verifica.
Dopo che la proposta è stata inviata di nuovo, l'ente di convalida e verifica può esaminarla e approvarla, rifiutarla o chiedere di nuovo delle modifiche.
Ritira la richiesta di emissione del credito
Opzione per ritirare la proposta della richiesta di emissione del credito (CreditMint) inviata:
Dopo che la proposta di emissione del credito è stata presentata al registro, in caso di problemi per i quali si desidera ritirare la proposta presentata, è possibile ritirare la proposta presentata se il registro non ha dato seguito alla proposta. Questa funzionalità è disponibile solo tramite API.
Modifica lo stato della proposta CreditMint da Inviata a Ritirata utilizzando l'API POST/proposals/{proposalId}/action e specifica i seguenti dettagli nel corpo della richiesta:
- Azione: ritiro
- Messaggio: specificare il motivo (se presente) per il ritiro della proposta di riferimento al registro.
Lo stato della proposta è ora Ritirato.
Dopo che la richiesta di emissione del credito è stata ritirata, l'ente di convalida e verifica può modificare l'"attestazione elaborata" e i risultati del punto di controllo associato e quindi inviare nuovamente la richiesta di emissione del credito.
Carica e allega file ai risultati del punto di controllo dell'attestazione elaborata: POST/files e specifica i seguenti dettagli:
- File o FileURL
- Tag
- ResourceURI del risultato del punto di controllo associato.
Aggiornare gli attributi dell'attestazione elaborata: PATCH/processedClaims/{processedClaim_Id}
Invia nuovamente la richiesta di emissione al registro e specifica i seguenti dettagli nel corpo della richiesta API: POST/proposals/{ proposal_id}/action
- Azione: specifica come Invia di nuovo
- Messaggio: specificare un messaggio o commento (se presente) per il riferimento al registro
Emetti crediti
Questa sezione mostra come visualizzare ed emettere crediti tramite API. Per le istruzioni sull'utilizzo dell'interfaccia utente, vai a Emettere crediti in Servizio di credito ambientale.
- Rivedere le proposte
- Approvare i crediti
- Rifiutare una proposta
- Richiesta di emissione di credito di ritorno per modifiche
- Visualizza i crediti emessi
- Cerca e visualizza i crediti
Esamina le proposte di emissione di credito
Visualizza la proposta "Token mint" inviata e ottieni l'URI della risorsa dell'"attestazione elaborata" che è stata inviata per la revisione:
GET/proposal/{proposalId}
Esamina i risultati della verifica dell'ente di convalida e verifica visualizzando l'attestazione elaborata e i risultati del punto di controllo associato (insieme ai file associati):
GET/processedClaims/{processedClaims_Id}
Visualizza l'attestazione e i dettagli del punto di controllo corrispondente (insieme all'elenco dei file allegati dal fornitore per i punti di controllo):
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Visualizza i dettagli del progetto di vantaggi modulari, insieme all'elenco dei file allegati:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Scarica un file utilizzando l'ID file:
GET/files/{fileId}
Approva crediti
Carica i file che desideri allegare affinché il credito venga emesso: POST/file e specifica i seguenti dettagli nel corpo della richiesta:
- File o URL file
- Tag
Approvare la proposta:
POST/proposals/{proposalId}/action
Specifica i seguenti dettagli nel corpo della richiesta:
- Azione: specifica Mint
- Messaggio: specificare il messaggio (se presente) per il riferimento dell'ente di convalida e verifica
- ID file: specificare gli ID dei file caricati in modo che i file siano allegati al credito emesso
- Quantità
- Vintage
- ID asset
- Valore determinato
Nota
Quando la proposta viene approvata, verrà creato un credito corrispondente.
Rifiuta una proposta
Carica i file (se presenti) dell'attestazione elaborata: POST/file e specifica i seguenti dettagli:
- File o URL file
- Tag
Rifiuta la proposta:
POST/proposals/{proposalId}/action
Specifica i seguenti dettagli nel corpo della richiesta:
- Azione: Rifiuta
- Messaggio: specificare un messaggio (se presente) per il riferimento dell'ente di convalida e verifica
- ID file: specifica gli ID file del file caricato di modo che vengano allegati all'attestazione elaborata associata.
Richiesta di restituzione del credito per le modifiche
Se sono presenti lacune o dettagli errati nella richiesta di emissione per cui si desidera la correzione da parte dell'ente di convalida e verifica, puoi chiedere le modifiche sulla richiesta di emissione. Questa capacità è disponibile solo tramite API.
Carica i file (se presenti) che desideri condividere con l'ente di convalida e verifica come parte dell'invio della richiesta di emissione per le modifiche.
Sposta la richiesta di emissione (proposta CreditMint) allo stato submitterActionNeeded utilizzando l'API POST/proposals/{proposalId}/action e specifica i seguenti dettagli:
- Azione: ReturnForEdits
- Messaggio: specificare un messaggio (se presente) per la convalida e il riferimento dell'ente di verifica in modo che possano comprendere il motivo della richiesta di modifica.
- ID file: specifica l'ID file dei file caricati (se presenti) in modo che vengano allegati all'attestazione elaborata associata.
L'ente di convalida e verifica può ora visualizzare la proposta che è stata stornata per le modifiche. L'ente può anche modificare l'attestazione elaborata corrispondente e i risultati del punto di controllo. Può aggiornare gli attributi nonché caricare i file aggiornati nei risultati del punto di controllo.
Se richiesto, l'ente di convalida e verifica a questo punto può chiedere chiarimenti sull'attestazione verificata restituendo l'attestazione per le modifiche al fornitore. Una volta che il fornitore invia di nuovo l'attestazione, l'ente di convalida e verifica può esaminare e verificare l'attestazione, aggiornare l'attestazione elaborata corrispondente e quindi inviare di nuovo la richiesta di emissione al registro.
Carica e allega file ai risultati del punto di controllo: POST/files e specifica i seguenti dettagli:
- File o URL file
- Tag
- ResourceURI dei risultati del punto di controllo associato
Aggiorna gli attributi dell'attestazione elaborata, inclusa la raccomandazione sul credito: PATCH/processedClaim/{ID attestazione elaborata}
Invia nuovamente la richiesta di emissione e specifica i seguenti dettagli nel corpo della richiesta API: POST/proposals/{ proposal_id}/action
- Azione: Invia di nuovo
- Messaggio: specificare un messaggio (se presente) per il riferimento al registro
Dopo che la richiesta è stata inviata di nuovo, il registro di emissione può esaminare la richiesta e approvarla, rifiutarla o chiedere di nuovo delle modifiche.
Visualizza i crediti emessi
GET/credits
Cerca e visualizza i crediti
Recupera tutti i crediti:
GET/credits
Nota
Questa API restituirà l'elenco di tutti i crediti. Gli acquirenti possono quindi filtrare l'elenco autonomamente in base allo stato del credito per visualizzare solo i crediti elencati.
Visualizza i dettagli del credito (inclusa la derivazione) per un credito specifico visualizzato nell'elenco:
GET/credits/{creditId}/lineage
Elenca crediti
Questa sezione mostra come elencare i crediti su un marketplace per il commercio tramite API. Per le istruzioni sull'utilizzo dell'interfaccia utente, vai a Elencare crediti in Servizio di credito ambientale.
- Registrati come acquirente su un marketplace
- Invia una proposta per elencare un credito
- Rivedere la proposta per elencare un credito
Registrati come acquirente o marketplace
Invia la proposta di MarketplaceTraderRegister come titolare del credito o acquirente:
POST/proposals
Recupera e rivedi tutte le proposte di MarketplaceTraderRegister come marketplace:
GET/proposals
Approva o rifiuta le proposte come marketplace:
POST/proposals/{proposalId}/action
Recupera e visualizza tutti i trader registrati sulla loro piattaforma come marketplace:
GET/marketplaces/{marketplaceId}/traders
Invia la proposta per elencare un credito
Crea e invia la proposta MarketplaceListingRegister:
POST/proposals
Esamina la proposta per elencare un credito
GET/proposals
POST /proposals/{proposalId}/action
Gestisci i crediti
Questa sezione mostra come gestire i crediti tramite API. Per le istruzioni sull'utilizzo dell'interfaccia utente, vai a Gestire crediti in Servizio di credito ambientale.
- Cancellare un credito
- Trasferire la proprietà
- Visualizza la linea di credito
- Dividi un credito
- Trasferisci l'elenco dei crediti
Elimina un credito dall'elenco
La divisione di un credito è un'operazione autonoma in Servizio di credito ambientale. Per informazioni sulla suddivisione di un credito tramite API, vai a Dividi un credito. Dopo le divisioni del credito, puoi continuare con il passaggio successivo.
Crea e invia la proposta MarketplaceListingDeregister:
POST/proposals
Visualizza tutte le proposte MarketplaceListingDeregister inviate per la revisione:
GET/proposals
Per approvare o rifiutare la proposta:
POST/proposals/{proposalId}/action
Trasferisci proprietà
POST/credits/{creditId}/transfer/
Visualizza derivazione del credito
Le organizzazioni con ruoli di fornitore e registro possono visualizzare la linea di credito per i crediti che possiedono o che hanno emesso:
GET/credits/{creditId}/lineage
Dividi un credito
Puoi dividere un credito in crediti figlio. Questa funzionalità è al momento disponibile solo tramite API.
Dividi il credito specificando le quantità (in mtCO2e) per almeno due crediti figlio come proprietario del credito (per i crediti che possiede) o come marketplace (per i crediti elencati sulla loro piattaforma):
POST/credits/{creditId}/split
Elenco dei crediti di trasferimento
Un marketplace può trasferire un elenco di crediti dalla propria piattaforma a un altro marketplace. Questo trasferimento è noto anche come trasferimento di impegno di spesa. Nel flusso tradizionale, un fornitore elencherebbe i crediti su un mercato che aiuterà con la domanda, la compensazione e il regolamento. A volte un marketplace potrebbe non essere in grado di eseguire autonomamente la compensazione e il regolamento dei pagamenti e potrebbe dipendere da una piattaforma diversa per eseguirli. In questo caso, l'asset deve essere trasferito nel nuovo marketplace per completare la transazione. Questa funzionalità è al momento disponibile tramite API.
Come marketplace, crea e invia la proposta MarketplaceListingTransfer per un credito elencato sulla tua piattaforma:
POST/proposals
In qualità di marketplace responsabile dell'approvazione, visualizza tutte le proposte MarketplaceListingTransfer a loro inviate per la revisione:
GET/proposals
In qualità di marketplace di approvazione, approva o rifiuta la proposta. Se la proposta viene approvata, l'impegno di spesa di credito viene trasferito dal marketplace iniziale al marketplace di approvazione:
POST/proposals/{proposalId}/action
Trasferimento parziale dell'impegno di spesa: un marketplace può trasferire l'impegno per un credito parziale suddividendo prima il credito come azione indipendente. Per informazioni su come suddividere un credito tramite API, vai a Dividi un credito. Dopo che il credito è stato suddiviso, continua con i passaggi precedenti per il trasferimento dell'impegno di spesa per i crediti figlio.
Imposta obiettivi di emissione
Questa sezione mostra come impostare obiettivi e traguardi di riduzione delle emissioni tramite API.
Crea obiettivi per le emissioni
POST/esgs
Visualizza obiettivi per le emissioni
GET/esgs
Traccia emissioni
Questa sezione mostra come tenere traccia delle tue emissioni rispetto alla scorecard delle emissioni che hai impostato tramite le API. Per le istruzioni sull'utilizzo dell'interfaccia utente, vai a Rileva obiettivi di emissione in Servizio di credito ambientale.
- Creare traguardi per un periodo di rendicontazione specifico
- Monitorare le emissioni effettive rispetto al traguardo
Crea passaggi fondamentali per il periodo di riferimento specifico
POST/esgs/{esgScorecardId}/milestones
Recupera tutti i passaggi fondamentali:
GET/esgs/{esgScorecardId}/milestones
Recupera passaggi specifici:
GET/esgs/{esgScorecardId}/milestones/{esgMilestoneId}
Tieni traccia delle emissioni effettive rispetto al traguardo
POST/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}/emissions
GET/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}
Ritira crediti
Questa sezione mostra come compensare le emissioni in eccesso ritirando i crediti di carbonio posseduti tramite API. Per le istruzioni sull'utilizzo dell'interfaccia utente, vai a Ritira crediti in Servizio di credito ambientale.
- Inviare proposta di ritiro del credito
- Rivedere la proposta di ritiro del credito
- Ritiro parziale del credito
Invia proposta di ritiro del credito
Crea e invia la proposta ESGEmissionOffset:
POST/proposals
Gli acquirenti possono anche ritirare direttamente il credito di carbonio senza specificare le emissioni da compensare. Funzionalità disponibile solo tramite API.
Crea e invia la proposta CreditRetire:
POST/proposals
Rivedi proposta di ritiro del credito
GET/proposals
GET/proposals/{proposalId}
Allega file al credito che è in fase di revisione per il ritiro:
POST/files
POST/proposals/{proposalId}/action
Pensionamento parziale del credito
Per informazioni sulla suddivisione di un credito tramite API, vai a Dividi un credito.
Dopo che il credito è stato suddiviso, utilizza le API nei passaggi precedenti per compensare e ritirare.
Gestisci file
Questa sezione mostra come allegare, visualizzare ed eliminare file per risorse come progetti, rivendicazioni e crediti tramite API. Per le istruzioni sull'utilizzo dell'interfaccia utente, vai a Gestire file in Servizio di credito ambientale.
Allega file
Utilizza l'API POST/file per allegare un file a una risorsa. È necessario specificare i seguenti dettagli:
- File o URI file
- URI della risorsa del cespite
- Tag descrittivo per il file
Visualizza file
Visualizza l'elenco dei file insieme alle proprietà dei file per una risorsa utilizzando l'API dei dettagli della risorsa:
Progetto di vantaggi modulare:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Richieste di rimborso:
GET/ecoprojects/{ecoProjectId}/mbps/{modular benefit projectId}/mbpClaims/{mbpClaimId}
Punto di controllo delle richieste di rimborso:
GET/ecoprojects/{ecoProjectId}/modular benefit projects/{mbpId}/mbpClaims/{mbpClaimId}/checkpoints
Credito:
GET/credits/{creditId}
Utilizzare l'ID file presente nelle proprietà del file per scaricare il file:
GET/files/{fileId}
Elimina file
Utilizza l'ID file del file per chiamare l'API di eliminazione:
DELETE/files/{fileId}
Informazioni correlate
Panoramica del servizio di credito ambientale
Configura il servizio di credito ambientale
Glossario del Servizio di Credito Ambientale