Oversigt over API-referencen til Tjeneste til miljøkredit
Vigtige oplysninger
Nogle eller alle af disse funktioner, der er angivet i dette emne, er tilgængelige som del af en forhåndsversion. Indholdet og funktionerne kan ændres. Du kan få adgang til Tjeneste til miljøkredit (forhåndsversion)-sandkassemiljø til en 30 dages prøveversion. Hvis du vil bruge Tjeneste til miljøkredit (forhåndsversion) i et produktionsmiljø, skal du udfylde tilmeldingsformularen for Tjeneste til miljøkredit (forhåndsversion).
I denne artikel kan du få hjælp til at udføre opgaver med REST API'er til Tjeneste til miljøkredit. Hvis du vil se hele API-referencen, skal du gå til API-reference til Tjeneste til miljøkredit. Du kan finde Swagger-filen på REST API'er til Tjeneste til miljøkredit.
- Registrer projekter
- Behandle krav
- Udstedelse af kreditter
- Liste kreditering
- Administrer kreditter
- Sæt emissionsmål
- Spor emissioner
- Tilbagetrækning af kreditter
- Administrer filer
Registrere projekter
I dette afsnit vises, hvordan du opretter, sender og gennemser økologiske projekter via API'er. Du kan finde en vejledning til brug af brugergrænsefladen ved at gå til Registrere projekter i Tjeneste til miljøkredit.
- Opret et projekt
- Gemme og indsende et projekt
- Få vist et projekt
- Godkende eller afvise et forslag
- Slet en fil
- Returner et forslag til redigeringer
- Registrer yderligere modulopbyggede fordelsprojekter
- Gennemgå et modulært fordelsprojekt
Opret et projekt
Sådan overføres og vedhæftes filer, når projektet oprettes:
Overfør filer ved hjælp af POST/filer. Angiv følgende oplysninger i API'en:
- Fil eller filens webadresse
- Beskrivende mærke til filen
Opret det økologiske projekt og det tilhørende modulopbyggede fordelsprojekt, og angiv det fil-id, der returneres som svar på POST/fil-API-opkaldet som en attribut i API-anmodningen om projektoprettelse: POST/økoprojekter.
Gemme og sende et projekt
Hent detaljerne til projektet:
GET/ecoProjects/{ecoProjectId}
Få vist listen over filer (og de tilknyttede metadata), der er knyttet til det modulopbyggede fordelsprojekt:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Hent en fil ved hjælp af fil-id'et, der er tilgængeligt som en del af filmetadataene:
GET/files/{fileId}
Føj filer til det modulopbyggede fordelsprojekt:
POST/files
Angiv ressource-URI'en for det modulopbyggede fordelsprojekt i forespørgselsteksten.
Indsend det modulopbyggede fordelsprojekt til registrering ved at sende MBPRegister-forslag:
POST/proposals
Få vist et projekt
Hent alle forslagene:
GET/proposals
Hent detaljer for et bestemt forslag:
GET/proposals/{proposalId}
Hent detaljer for et bestemt økologisk projekt:
GET/ecoProjects/{ecoProjectId}
Fetch detaljer for den specifikke MBP, der skal gennemses:
GET/ecoProjects/{ecoProjectId}/mbps/{mbpId}
Få vist en liste over filer (og de tilknyttede metadata), der er knyttet til det modulære fordelsprojektet.
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Hent filerne ved hjælp af fil-id'et, der er tilgængeligt som en del af det tidligere API-svar:
GET/files/{fileId}
Knyt en fil til det modulopbyggede fordelsprojekt:
POST/files
Godkende eller afvise et forslag
Overfør eventuelle filer:
POST/filer og angiv fil (eller FileUrl) og mærkedetaljer
Afvis registreringsanmodningen:
POST/forslag/{proposalId}/handling, og angiv følgende oplysninger i brødteksten til anmodningen
Handling: Afvis
Meddelelse: Angiv eventuelt en kommentar, du vil tilføje, når du afviser registreringen.
Fil-id'er: Angiv fil-id'erne for de filer, der blev overført.
Slette en fil
Få vist listen over filer, der er knyttet til det modulopbyggede fordelsprojekt:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Identificer den fil, du har overført, da en bruger kun kan slette de filer, de har overført.
Slet filen:
DELETE/files/{fileId}
Returnere et forslag til redigering
Hvis der er huller eller forkerte oplysninger i projektattributterne eller filerne, som skal rettes eller tilføjes af leverandøren, kan du bede om at få projektet redigeret.
Overfør eventuelle filer, der skal deles med leverandøren:
POST/filer
Flyt forslaget MBPRegister til tilstanden submitterActionNeeded ved at anvende handlingen returnForEdits ved hjælp af POST/proposals/{proposalId}/action-API'en og angive følgende detaljer i brødteksten i anmodningen:
Handling: returnForEdits
Meddelelse: Angiv eventuelt en kommentar til leverandørreferencen, mens du returnerer anmodningen om redigering.
Fil-id'er: Angiv fil-id'et for den overførte fil her for at vedhæfte filen til det pågældende modulopbyggede fordelsprojekt.
Når du har gjort det, flyttes det modulopbyggede fordelsprojekt til tilstanden returnedForEdits.
Leverandører kan nu se det forslag, der er sendt tilbage til redigering. De kan nu redigere attributter for det modulopbyggede fordelsprojekt og overføre flere filer til det modulopbyggede fordelsprojekt.
Vis forslag: GET/proposals/{proposalId}
Overfør og vedhæft filer til det modulopbyggede fordelsprojekt: POST/filer, og angiv følgende oplysninger i brødteksten i anmodningen:
- Fil eller filens webadresse
- Mærke: Beskrivende filmærke
- ResourceURI: Angiv ressource-URI'en for det pågældende modulopbyggede fordelsprojekt.
Opdatere attributter for det modulopbyggede fordelsprojekt
- Få de opdaterede oplysninger om det modulopbyggede fordelsprojekt ved hjælp af GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}, og kopiér Etag-værdien fra svarheaderen.
- Opdater attributterne for det modulopbyggede fordelsprojekt ved hjælp af PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} API, og angiv Etag-værdien i If-Match-nøglen i headeren.
Når ændringerne er fuldført, kan leverandøren nu sende forslaget tilbage til registeret ved hjælp af POST/proposals/{proposalId}/action-API'en og angive følgende oplysninger i anmodningen:
Handling: Send
Meddelelse: Angiv eventuelt en kommentar til registerreferencen.
Registrere yderligere modulopbyggede fordelsprojekter
Indsend økofordelen til registrering til det udstedende organ ved at oprette og sende et MBPRegister-forslag:
POST/proposal
Gennemse et modulopbygget fordelsprojekt
Se detaljerne om forslaget:
GET/proposals/{proposalId}
Se detaljerne om hele projektet:
GET/ecoProjects/{ecoProjectId}
Se detaljerne om de enkelte modulopbyggede fordelsprojekter i projektet:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Godkend eller afvis registreringsforslaget, eller returner det til redigering:
POST/proposals/{proposalId}/action
Behandle krav
I dette afsnit vises, hvordan du kan behandle krav via API'er. Du kan finde en vejledning til brug af brugergrænsefladen ved at gå til Behandle krav i Tjeneste til miljøkredit.
- Opret krav
- Indsend krav
- Bekræft krav
- Anmodning om returnering af krav til redigeringer
- Rediger det returnerede forslag
- Træk kreditudstedelsesanmodningen tilbage
Oprette krav
Oprette krav:
POST/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims
Overfør og vedhæft filer til kontrolpunkter for krav:
POST/files
Angiv følgende oplysninger i anmodningen:
- Fil eller filens webadresse
- Kode
- Kravets ressource-URI
Sende krav
Opret og indsend forslaget projectClaimVerify for det modulopbyggede fordelsprojekt:
POST/proposals
Se detaljer om det indsendte forslag:
GET/proposal/{proposalId}
Se detaljerne om kravet:
POST/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Bekræfte krav
Se forslag:
GET/proposals
Hent detaljerne om et bestemt forslag:
GET/proposals/{proposalId}
Hent detaljerne om et bestemt krav, som verificeringsforslaget er sendt for:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Acceptér opgaven til verificering af kravet:
POST/proposals/{proposalId}/action
Vis de filer, der er knyttet til et modulopbygget fordelsprojekt:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Vis de filer, der er knyttet til kontrolpunkter for krav:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpclaims/{claimId}/checkpoints
Se en fil, der er knyttet til et bestemt aktiv:
GET/files/{fileId}
Når kravet er accepteret, oprettes der et tilsvarende "Behandlet krav". Registrer resultaterne af verificeringen af det behandles krav. Dette omfatter opdatering af mængde og fordele ved kravet. Før du sender anmodningen om kreditudstedelse, skal du også opdatere kreditanbefalingerne for det behandlede krav:
- Hent de behandlede kravsdetaljer ved hjælp af GET/processedClaims/{processed_claim_id}, og kopiér Etag-værdien fra svarheaderen.
- Opdater attributterne for det behandlede krav ved hjælp af PATCH/processedClaims/{processed_claim_id}-API'en, og angiv Etag-værdien i If-Match-nøglen i headeren.
For hvert kontrolpunkt, du kontrollerer, kan du opdatere verificeringsresultaterne for det tilsvarende kontrolpunktresultat for det behandlede krav:
- Overfør og vedhæft rapporterne om resultaterne af verificering til kontrolpunktets resultater af det behandlede krav ved hjælp af POST/files-API'en, og angiv filen eller filens URL-adresse, kode og ResourceUri (dette er kontrolpunktresultatets ressource-URI) i anmodningens brødtekst.
- Opdater miljøbelastningen før og efter attributter for kontrolpunktresultatet (hvis det er nødvendigt):
- Hent detaljerne om kontrolpunktresultaterne ved hjælp af GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id}, og kopiér Etag-værdien fra svarheaderen.
- Opdater attributterne for kontrolpunktresultaterne ved hjælp af PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id}-API'en, og angiv Etag-værdien i If-Match-nøglen i headeren.
- Du kan også opdatere resultaterne af kontrolpunktet ved at bruge programrettelses-API'en til behandling af krav.
Når verificeringen er fuldført, skal du godkende eller afvise MBPClaimVerify-forslaget:
POST/proposals/{proposalId}/action
Angiv følgende oplysninger:
Handling: Godkend eller afvis
Meddelelse: Angiv eventuelt en kommentar til leverandørreferencen.
Når MBPClaimVerify-forslaget er godkendt, skal du oprette og sende CreditMint-forslaget for at sende anmodningen om kreditudstedelse:
POST/proposals/
Returnere anmodning om krav til redigering
Hvis der er huller eller forkerte oplysninger i anmodningen om krav, som validerings- og verificeringsorganet ønsker, at leverandøren skal rette, kan du bede om at få anmodningen om krav redigeret i stedet for at godkende eller afvise anmodningen. Denne funktion findes kun via API.
Overfør og vedhæft filer (som du vil dele med leverandøren) til det behandlede krav eller til kontrolpunktresultat af det behandlede krav: POST/filer, og angiv følgende oplysninger i anmodningens brødtekst
- Fil eller filens webadresse
- Kode
- Ressource-URI'er for det behandlede krav eller kontrolpunktresultatet for det behandlede krav, som filen skal føjes til
Flyt forslaget MBPClaimVerify til tilstanden submitterActionNeeded ved at anvende handlingen returnForEdits ved hjælp af POST/proposals/{proposalId}/action-API'en og angive følgende detaljer i brødteksten i anmodningen:
- Handling: returnForEdits
- Meddelelse: Angiv eventuelt en kommentar til leverandørreferencen, mens du returnerer anmodningen om redigering.
Redigere det returnerede forslag
Leverandører kan derefter se det forslag, der er sendt tilbage til redigering. De kan nu redigere attributter for krav og kontrolpunkter, og de kan overføre flere filer til kontrolpunkterne for krav:
Vis forslag: GET/proposals/{proposalId}
- Hvis det er nødvendigt, kan leverandøren også se oplysningerne om det tilknyttede behandlede krav ved hjælp af GET/processedClaims/{processed_claim_Id}-API'en.
Overfør og vedhæft eventuelle filer kontrolpunkterne for krav: POST/files, og angiv følgende oplysninger i brødteksten i anmodningen
- Fil eller filens webadresse
- Kode
- Ressource-URI'er for det kontrolpunkt, som filen skal føjes til
Opdater kravattributter ved hjælp af en PATCH-handling:
- Hent de seneste kravsdetaljer, og bemærk ETag-værdien i svarheaderen: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
- Opdater kravsattributterne, og angiv Etag-værdien i "If-Match"-nøglen i anmodningsheaderen: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
Opdater attributterne for kravets kontrolpunkt ved hjælp af en PATCH-handling:
Hent de seneste detaljer om kontrolpunktet, og bemærk ETag-værdien i svarheaderen: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}
Opdater kravsattributterne, og angiv Etag-værdien i "If-Match"-nøglen i anmodningsheaderen: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}
Bemærk
Mens du angiver opdateringsattributterne, skal du sikre, at JSON-anmodningsteksten følger den samme struktur som i det tilsvarende GET API-kald.
Når ændringerne er fuldført, kan leverandøren sende forslaget tilbage til validerings- og verificeringsorganet ved hjælp af POST/proposals//{proposalId}action-API'en og angive følgende oplysninger i anmodningsteksten:
- Handling: Send igen
- Meddelelse: Angiv eventuelt en kommentar til validerings- og verificeringsteksten.
Når forslaget er sendt igen, kan validerings- og verificeringsorganet gennemse forslaget og godkende, afvise eller bede om ændringer igen.
Trække anmodningen om kreditudstedelse tilbage
Mulighed for at trække den sendte anmodning om kreditudstedelse (CreditMint) tilbage:
Når forslaget om kreditudstedelse er sendt til registeret, kan du i tilfælde af problemer, som skyldes, at du vil trække det sendte forslag tilbage, trække det sendte forslag tilbage, hvis registeret ikke har handlet på forslaget. Denne funktion er i øjeblikket kun tilgængelig via API'er.
Flyt det CreditMint-forslag, der er i sendt tilstand, til tilstanden tilbagetrukket ved hjælp af POST/proposals/{proposalId}/action-API'en, og angiv følgende oplysninger i brødteksten i anmodningen:
- Handling: Træk tilbage
- Meddelelse: Angiv eventuelt årsagen til, at forslaget til registerreferencen trækkes tilbage.
Status for forslaget er nu trukket tilbage.
Når anmodningen om kreditudstedelse er trukket tilbage, kan validerings- og verificeringsorganet ændre det "behandlede krav" og de tilknyttede kontrolpunktresultater og derefter sende anmodningen om kreditudstedelse igen.
Overfør og vedhæft filer til det behandlede kravs kontrolpunktresultater: POST/files, og angiv følgende oplysninger:
- Fil eller FileURL
- Kode
- ResourceURI for det tilknyttede kontrolpunktresultat.
Opdater attributterne for det behandlede krav: PATCH/processedClaims/{processedClaim_Id}
Send anmodningen om udstedelse igen til registreringsdatabasen, og angiv følgende oplysninger i brødteksten til API-anmodningen: POST/proposals/{ proposal_id}/action
- Handling: Angiv som Send igen
- Meddelelse: Angiv eventuelt en meddelelse/kommentar til registerreferencen
Udstede kreditter
I dette afsnit vises, hvordan du kan få vist og udstede APIa'er. Du kan finde en vejledning til brug af brugergrænsefladen ved at gå til Udstede kreditter i Tjeneste til miljøkredit.
- Forslag til revision
- Godkend kreditter
- Afvis et forslag
- Anmodning om returnering af kreditudstedelse for redigeringer
- Se udstedte kreditter
- Søg og se kreditter
Gennemse forslag til kreditudstedelse
Se det indsendte "Token mint"-forslag, og hent ressource-URI'en for det "behandlede krav", der er sendt til gennemsyn:
GET/proposal/{proposalId}
Gennemse validerings- og verificeringsorganets resultater af verificeringen ved at se det behandlede krav og de tilknyttede kontrolpunktresultater (sammen med tilknyttede filer):
GET/processedClaims/{processedClaims_Id}
Få vist oplysningerne om krav og tilsvarende kontrolpunkter (sammen med en liste over filer, der er vedhæftet af leverandøren for kontrolpunkterne):
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Få det modulopbyggede fordelsprojekt sammen med listen over vedhæftede filer:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Hent en fil ved hjælp af fil-id'et:
GET/files/{fileId}
Godkende kreditter
Overfør filer, som du vil knytte til kreditter, der skal udstedes: POST/files, og angiv følgende oplysninger i brødteksten i anmodningen:
- Fil eller filens webadresse
- Kode
Godkend forslaget:
POST/proposals/{proposalId}/action
Angiv følgende oplysninger i anmodningens tekst:
- Handling: angiv som Mint
- Meddelelse: Angiv eventuelt en meddelelse til validerings- og verificeringsteksten
- Fil-id'er: Angiv fil-id'erne for de overførte filer, så filerne knyttes til den udstedte kredit
- Mængde
- Ældre
- Aktiv-id
- Registreret værdi
Bemærk
Når forslaget godkendes, oprettes der en tilsvarende kredit.
Afvise et forslag
Overfør eventuelle filer til det behandlede krav: POST/files, og angiv følgende oplysninger:
- Fil eller filens webadresse
- Kode
Afvise forslaget:
POST/proposals/{proposalId}/action
Angiv følgende oplysninger i anmodningens tekst:
- Handling: Afvis
- Meddelelse: Angiv eventuelt en meddelelse til validerings- og verificeringsteksten
- Fil-id'er: Angiv fil-id'erne for den overførte fil, så disse vedhæftes til det tilknyttede behandlede krav.
Anmodning om udstedelse af returkredit til redigering
Hvis der er huller eller forkerte oplysninger i anmodningen om udstedelse, som validerings- og verificeringsorganet skal rette, kan du bede om at få anmodningen om udstedelse redigeret. Denne funktion findes kun via API.
Overfør eventuelle filer, som du vil dele med validerings- og verificeringsorganet, når du sender anmodningen om udstedelse tilbage til redigering.
Flyt anmodningen om udstedelse (CreditMint-forslaget) til tilstanden submitterActionNeeded ved hjælp af POST/proposals/{proposalId}/action-API'en, og angiv følgende oplysninger:
- Handling: ReturnForEdits
- Meddelelse: Angiv eventuelt en meddelelse til validerings- og verificeringsorganreferencen, så de kan forstå årsagen til redigeringsanmodningen.
- Fil-id'er: Angiv fil-id'erne for de overførte filer (hvis der er nogen), så filerne vedhæftes til det tilknyttede behandlede krav.
Validerings- og verificeringsorganet kan nu se det forslag, der er sendt tilbage til redigering. De kan nu også redigere de tilsvarende behandlede krav og kontrolpunktresultaterne. De kan opdatere attributter og overføre opdaterede filer til kontrolpunktresultater.
Hvis det er nødvendigt, kan validerings- og verificeringsorganet på dette tidpunkt bede om en forklaring på det godkendte krav ved at returnere kravet til redigering hos leverandøren. Når leverandøren sender kravet igen, kan validerings- og verificeringsorganet gennemse og bekræfte kravet, opdatere det tilknyttede behandlede krav og derefter sende anmodningen om udstedelse igen til registreringsdatabasen.
Overfør og vedhæft filer til kontrolpunktresultaterne: POST/files, og angiv følgende oplysninger:
- Fil eller filens webadresse
- Kode
- ResourceURI for de tilknyttede kontrolpunktresultater
Opdater attributterne for det behandlede krav, herunder kreditanbefalingen: PATCH/processedClaim/{processed claim id}
Send anmodningen om udstedelse igen til registreringsdatabasen, og angiv følgende oplysninger i brødteksten til API-anmodningen: POST/proposals/{ proposal_id}/action
- Handling: Send igen
- Meddelelse: Angiv eventuelt en meddelelse til registerreferencen
Når anmodningen er sendt igen, kan det udstedende organ gennemse anmodningen og godkende, afvise eller bede om ændringer igen.
Få vist udstedte kreditter
GET/credits
Søge efter og få vist kreditter
Hente alle kreditter:
GET/credits
Bemærk
API'en returnerer listen over alle kreditterne. Køberne kan derefter selv filtrere listen på baggrund af kreditstatus, så de kun kan se tilføjede kreditter.
Få vist kreditoplysninger (herunder afstamning) for en bestemt kredit, der vises på listen:
GET/credits/{creditId}/lineage
Få vist kreditter
I dette afsnit kan du se, hvordan du kan få vist en liste over kreditter på en markedsplads for handel via API'er. Du kan finde en vejledning til brug af brugergrænsefladen ved at gå til Føje kreditter til listen i Tjeneste til miljøkredit.
- Tilmeld dig som køber på en markedsplads
- Indsend forslag til at angive en kredit
- Gennemgang forslag til at angive en kredit
Tilmelde sig som køber på en markedsplads
Indsend MarketplaceTraderRegister-forslag som kreditejer eller køber:
POST/proposals
Hentning og gennemgang af alle MarketplaceTraderRegister-forslag som en markedsplads:
GET/proposals
Godkend eller afvis forslagene som en markedsplads:
POST/proposals/{proposalId}/action
Hent og få vist alle de handlende, der er registreret på deres platform som en markedsplads:
GET/marketplaces/{marketplaceId}/traders
Sende forslag til tilføjelse af en kredit til listen
Opret og indsend forslag til MarketplaceListingRegister:
POST/proposals
Gennemse forslag til tilføjelse af en kredit til listen
GET/proposals
POST /proposals/{proposalId}/action
Administrere kreditter
I dette afsnit vises, hvordan du kan administrere kreditter via API'er. Du kan finde en vejledning til brug af brugergrænsefladen ved at gå til Administrere kreditter i Tjeneste til miljøkredit.
Fjerne en kredit fra liste
Opdeling af en kredit er en uafhængig handling i Tjeneste til miljøkredit. Du kan finde flere oplysninger om, hvordan du opdeler en kredit via API, i Opdele en kredit. Når kreditten er opdelt, kan du fortsætte med næste trin.
Opret og indsend forslag til MarketplaceListingDeregister:
POST/proposals
Se alle forslagene på MarketplaceListingDeregister, der er sendt til gennemsyn:
GET/proposals
Sådan godkender eller afviser du forslaget:
POST/proposals/{proposalId}/action
Overdrage ejerskab
POST/credits/{creditId}/transfer/
Få vist kreditafstamning
Organisationer med leverandør- og registreringsroller kan få vist kredittens afstamning for de kreditter, de ejer eller har udstedt:
GET/credits/{creditId}/lineage
Opdele en kredit
Du kan opdele en kredit i underordnede kreditter. Denne funktionalitet er i øjeblikket kun tilgængelig via API.
Opdel kreditten ved at angive antallet (i Mt CO2-ækv) for mindst to underordnede kreditter som kreditejer (for den kredit, de ejer) eller som markedsplads (for de kreditter, der er angivet på deres platform):
POST/credits/{creditId}/split
Overføre kreditliste
En markedsplads kan overføre en tilføjet kredit fra platformen til en anden markedsplads. Denne overførsel kaldes også overførsel af behæftelse. I det traditionelle flow vil en leverandør tilføje kreditterne på en markedsplads, der hjælper med behov, behandling og afstemning. Undertiden kan en markedsplads ikke selv udføre behandling og afstemning af betaling, og den kan være afhængig af, at en anden platform udfører det. I dette tilfælde skal aktivet overføres til den nye markedsplads, for at transaktionen kan fuldføres. Denne funktion er i øjeblikket kun tilgængelig via API'er.
Som markedsplads kan du oprette og sende MarketplaceListingTransfer-forslag om en kredit, der er angivet på din platform:
POST/proposals
Som markedsplads for godkender kan du se alle de MarketplaceListingTransfer-forslag, der er sendt til dem til gennemsyn:
GET/proposals
Som godkendermarkedsplads kan du godkende eller afvise forslaget. Hvis forslaget godkendes, overføres kreditbehæftelsen fra den første markedsplads til godkendermarkedspladsen:
POST/proposals/{proposalId}/action
Delvis overførsel af behæftelse: En markedsplads kan overføre behæftelse for en delvis kredit ved først at opdele kreditten som en uafhængig handling. Du kan finde flere oplysninger om, hvordan du opdeler en kredit, i Opdele en kredit. Når kreditten er opdelt, skal du fortsætte med ovenstående trin for at overføre behæftelse for underordnede kreditter.
Angive udledningsmål
I dette afsnit vises, hvordan du kan indstille mål for reduktion af udledning via API'er.
Oprette udledningsmål
POST/esgs
Få vist udledningsmål
GET/esgs
Spore udledninger
I dette afsnit kan du se, hvordan du sporer dine udledninger i forhold til det udledningsscorecard, du har angivet via API'er. Du kan finde en vejledning til brug af brugergrænsefladen ved at gå til Spore udledningsmål i Tjeneste til miljøkredit.
Oprette milepæle for en bestemt rapporteringsperiode
POST/esgs/{esgScorecardId}/milestones
Hent alle milepælene:
GET/esgs/{esgScorecardId}/milestones
Hent specifik milepæl:
GET/esgs/{esgScorecardId}/milestones/{esgMilestoneId}
Spore faktiske udledninger i forhold til milepælen
POST/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}/emissions
GET/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}
Trække kreditter tilbage
I dette afsnit kan du se, hvordan du kan forskyde overskydende udledninger ved at trække ejede CO2-kreditter tilbage via API'er. Du kan finde en vejledning til brug af brugergrænsefladen ved at gå til Trække kreditter tilbage i Tjeneste til miljøkredit.
- Indsend forslag til kredittilbagetrækning
- Gennemgå forslag til tilbagetrækning af kredit
- Delvis kredit
Sende forslag til tilbagetrækning af kreditter
Opret og send ESGEmissionOffset-forslag:
POST/proposals
Købere kan også trække CO2-kreditter tilbage direkte uden at angive, hvilke udledninger der skal forskydes. Denne funktionalitet er kun tilgængelig via API.
Opret og send CreditRetire-forslag:
POST/proposals
Gennemse forslag til tilbagetrækning af kreditter
GET/proposals
GET/proposals/{proposalId}
Vedhæft fil til den kredit, der gennemses med henblik på tilbagetrækning:
POST/files
POST/proposals/{proposalId}/action
Delvis tilbagetrækning af kredit
Du kan finde flere oplysninger om, hvordan du opdeler en kredit via API, i Opdele en kredit.
Når kreditten er opdelt, kan du bruge API'erne i tidligere trin til forskydning og tilbagetrækning.
Administrere filer
I dette afsnit vises, hvordan du vedhæfter, får vist og sletter filer for aktiver som projekt, krav og kreditter via API'er. Du kan finde en vejledning til brug af brugergrænsefladen ved at gå til Administrere filer i Tjeneste til miljøkredit.
Vedhæft filer
Brug POST/files-API'en til at vedhæfte en fil til et aktiv. Du skal angive følgende oplysninger:
- Fil eller filens webadresse
- Aktivets ressource-URI
- Beskrivende mærke til filen
Få vist filer
Få vist listen over filer sammen med filegenskaber for et aktiv ved hjælp af API'en med aktivdetaljer:
Modulopbygget fordelsprojekt:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Krav:
GET/ecoprojects/{ecoProjectId}/mbps/{modular benefit projectId}/mbpClaims/{mbpClaimId}
Kontrolpunkter for krav:
GET/ecoprojects/{ecoProjectId}/modular benefit projects/{mbpId}/mbpClaims/{mbpClaimId}/checkpoints
Kredit:
GET/credits/{creditId}
Brug det fil-id, der findes i filens filegenskaber, til at hente filen:
GET/files/{fileId}
Slette filer
Brug fil-id'et for filen til at kalde slette-API'en:
DELETE/files/{fileId}
Relaterede oplysninger
Oversigt over
tjenesten Miljøkredit Konfigurer ordliste over tjenesten Miljøkredittjeneste
...