Dela via

API-referensöversikt för tjänsten Miljökrediter

  • Artikel

Microsoft Cloud for Sustainability-ikon. Microsoft Cloud for Sustainability - Kostnadsfri utvärderingsversion

Microsoft Cloud for Sustainability Technical Summit maj 2024

Viktigt

Några eller alla dessa funktioner ingår som en del av en förhandsversion. Innehållet och funktionerna kan komma att ändras. Du kan få åtkomst till Begränsat läge för tjänsten Miljökrediter (förhandsversion) i en 30-dagars utvärderingsversion. Om du vill använda tjänsten Miljökrediter (förhandsversion) i en produktionsmiljö slutför du registreringsformuläret för tjänsten Miljökrediter (förhandsversion).

I den här artikeln får du hjälp att utföra uppgifter med REST-API:er för tjänsten Miljökrediter. Se den fullständiga API-referensen genom att gå till API-referensen för tjänsten Miljökrediter. Swagger-filen finns på REST-API :er för tjänsten Miljökrediter.

Registrera projekt

I det här avsnittet visas hur du skapar, skickar in och granskar ekologiska projekt via API:er. Instruktioner om hur du använder användargränssnittet finns i Registrera projekt i tjänsten Miljökrediter.

Skapa ett projekt

Så här överför och bifogar du filer när projekt skapas:

  1. Överför filer med POST/filer. Ange följande information i API:

    • Fil eller fil-URL
    • En beskrivande tagg på filen

  2. Skapa det ekologiska projektet och motsvarande projekt för modulär förmån och ange fil-ID som returneras i svaret på POST/files API-anropet som ett attribut i begäran om projektskapande API: POST/ecoprojects.

Spara och skicka ett projekt

Redigera information om projektet:

   GET/ecoProjects/{ecoProjectId}

Visa listan över filer (och deras tillhörande metadata) som är kopplade till det projektet för modulär förmån:

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

Hämta en fil med hjälp av fil-ID:t som är tillgängligt som en del av filmetadata:

   GET/files/{fileId}

Lägg till filer i det projektet för modulär förmån:

   POST/files

Ange resurs-URI för projekt för modulär förmån för klusterfördelen i begärandetext.

Skicka in modulärt förmånsprojekt för registrering genom att skicka in MBPRegister-förslag:

   POST/proposals

Visa projekt

Hämta alla förslag:

   GET/proposals

Hämta detaljer för ett specifikt förslag:

   GET/proposals/{proposalId}

Hämta detaljer för ett specifikt ekologiskt projekt:

   GET/ecoProjects/{ecoProjectId}

Hämta information om det specifika MBP att granska:

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

Få en lista med filer (och tillhörande metadata) bifogad till projekt för modulära fördelsprojekt:

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

Hämta filen med hjälp av fileId som är tillgängligt som en del av det tidigare API-svaret:

   GET/files/{fileId}

Bifoga en fil i det projektet för modulär förmån:

   POST/files

Godkänna eller avvisa ett förslag

Överföra filer (om några):

POST/filer och ange Fil (eller FileUrl) och tagginformation

Avvisa registreringsbegäran:

POST/proposals/{proposalId}/action och ange följande information i begärandetexten

  • Åtgärd: Avvisa

  • Meddelande: Ange en kommentar (om det finns någon) som du vill ange för att avvisa registreringen.

  • FileIDs: Ange fil-ID för filerna som överfördes.

Ta bort en fil

Visa listan över filer som är kopplade till det projektet för modulär förmån:

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

Identifiera filen som du har överfört eftersom en användare endast kan ta bort de filer som de har överfört.

Ta bort filen:

   DELETE/files/{fileId}

Returnera ett förslag för redigeringar

Om det finns inkorrekta eller felaktiga uppgifter i projektattributen eller filerna som du vill att leverantören ska korrigera eller lägga till kan du be om ändringar i projektet.

  1. Överför eventuella överföringsfiler som måste delas med leverantören:

    POST/filer

  2. Flytta MBPRegister förslaget till status submitterActionNeeded genom att vidta åtgärden returnForEdits med POST/proposals/{proposalId}/action API och ange följande information i begärandetext:

    • Åtgärd: returnForEdits

    • Meddelande: Ange en kommentar (om det krävs) för leverantörens referens medan du returnerar begäran om ändringar.

    • Fil-ID: Ange fil-ID för den överförda filen här för att bifoga filen till det aktuella projektet för modulär förmån.

    När detta är klart flyttas förmånsprojektet till tillståndet returnedForEdits .

Leverantörer kan nu visa det förslag som skickats tillbaka för redigeringar. De kan nu redigera de projekt för modulär förmånens attribut och ladda upp fler filer till det projektet för modulär förmån.

  • Visa förslag: GET/proposals/{proposalId}

  • Överför och bifoga filer till förmånsprojektet: POST/filer och ange följande information i begärandetext:

    • Fil eller fil-URL
    • Tagg: Beskrivande filtagg
    • ResourceURI: Ange resurs-URI för respektive modulärt förmånsprojekt.

  • Uppdatera attribut för modulärt förmånsprojektet

    • Hämta den uppdaterade informationen om modulärt förmånsprojektet med hjälp av GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} och kopiera värdet Etag från svarshuvudet.
    • Uppdatera de projektet för modulär förmåns attribut med hjälp av PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} API och ange Etag-värdet i If-Match-nyckeln i rubriken.

När ändringarna är slutförda kan leverantören nu skicka tillbaka förslaget till registret med hjälp av POST/proposals/{proposalId}/action API och ange följande information i begäran:

  • Åtgärd: Skicka

  • Meddelande: Ange en kommentar (om det finns någon) för registerreferensen.

Registrera ytterligare projekt för modulär förmån

Skicka in ekologiska förmånen för registrering till det utfärdande registret genom att skapa och skicka in ett MBPRegister-förslag:

   POST/proposal

Granska ett modulärt förmånsprojekt

Visa detaljer för förslaget:

   GET/proposals/{proposalId}

Visa hela projektinformationen:

   GET/ecoProjects/{ecoProjectId}

Visa informationen om det enskilda förmånsprojektet i projektet:

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

Godkänn eller avvisa ett registreringsförslag eller returnera det för redigeringar:

   POST/proposals/{proposalId}/action

Bearbeta anspråk

Det här avsnittet visar hur du bearbetar anspråk via API:er. Instruktioner om hur du använder användargränssnittet finns i Bearbeta anspråk i tjänsten Miljökrediter.

Skapa anspråk

Skapa anspråk:

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

Överför och bifoga filer till kontrollpunkter för anspråk:

   POST/files

Ange följande detaljer i begäran:

  • Fil eller fil-URL
  • Tagg
  • Resurs-URI för anspråket

Skicka fordring

Skapa och skicka in det modulära projectClaimVerify-förslag:

   POST/proposals

Se detaljer om det inlämnade förslaget:

   GET/proposal/{proposalId}

Visa detaljer om anspråket:

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

Kontrollera anspråk

Visa förslag:

   GET/proposals

Hämta detaljer för ett specifikt förslag:

   GET/proposals/{proposalId}

Hämta informationen om ett specifikt krav som verifieringsförslag har skickats in för:

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

Godkänn uppgiften att verifiera anspråket:

   POST/proposals/{proposalId}/action

Visa filerna som är associerade med ett förmånsprojekt:

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

Visa filerna som är associerade med kontrollpunkter för anspråk:

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

Visa en fil som är bifogad till en viss tillgång:

   GET/files/{fileId}

När kravet har godkänts skapas motsvarande "Bearbetat anspråk". Registrera verifieringskontrollen för det bearbetade anspråket. Detta omfattar uppdatering av Kvantitet, fördelar med anspråket. Innan du skickar en kreditutfärdarbegäran måste du uppdatera kreditrekommendationerna även på det bearbetade anspråket:

  • Hämta information för det bearbetade anspråket med hjälp av GET/processedKn/{processed_claim_id} och kopiera Etag-värdet från svarshuvudet.
  • Uppdatera det bearbetade anspråkets attribut med hjälp av PATCH/processedClaims/{processed_claim_id} API och ange Etag-värdet i If-Match-nyckeln i rubriken.

För varje kontrollpunkt som du kontrollerar kan du uppdatera verifieringskontrollen på motsvarande kontrollpunkt för det bearbetade anspråket:

  • Överför och bifoga verifieringssökningsrapporterna till kontrollpunktens resultat av det bearbetade anspråket med POST/filer-API och ange fil eller fil-URL, tagg och ResourceUri (detta är kontrollpunktsresultatets resurs-uri) i begärandetexten.
  • Uppdatera miljöpåverkan före och efter attribut för kontrollpunktsresultatet (om det krävs):
    • Hämta information om kontrollpunktens resultat med hjälp av GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} och kopiera Etag-värdet från svarshuvudet.
    • Uppdatera kontrollpunktens resultatets attribut med hjälp av PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} API och ange Etag-värdet i If-Match-nyckeln i rubriken.
    • Du kan också uppdatera kontrollpunktens resultat med hjälp av programuppdaterings-API för bearbetade anspråk.

När verifieringen är klar godkänner eller avvisar du MBPClaimVerify-förslaget:

   POST/proposals/{proposalId}/action

Ange följande information:

  • Åtgärd: Godkänna eller avvisa

  • Meddelande: Ange en kommentar (om det finns någon) för leverantörreferensen.

När förslaget MBPClaimVerify har godkänts skapar du och skickar förslaget CreditMint för att skicka en begäran om kreditutfärdande:

   POST/proposals/

Begäran om returbegäran för ändringar

Om det finns några luckor eller felaktiga detaljer i reklamationsbegäran som validerings- och verifieringsorganet vill att leverantören ska korrigera kan du be om ändringar i reklamationsbegäran istället för att godkänna eller avslå begäran. Den här funktionen finns endast via API.

  1. Överför och bifoga filer (som du vill dela med leverantören) till det bearbetade anspråket eller till kontrollpunkten för det processade kravet: POST/filer och ange följande information i begärandetexten

    • Fil eller fil-URL
    • Tagg
    • Resurs-URI för det bearbetade anspråket eller kontrollpunkten för det bearbetade anspråket som filen måste läggas till i

  2. Flytta MBPClaimVerify förslaget till status submitterActionNeeded genom att vidta åtgärden returnForEdits med POST/proposals/{proposalId}/action API och ange följande information i begärandetext:

    • Åtgärd: returnForEdits
    • Meddelande: Ange en kommentar (om det krävs) för leverantörens referens medan du returnerar begäran om ändringar.

Redigera det returnerade förslaget

Leverantörer kan nu visa det förslag som skickats tillbaka för redigeringar. De kan nu redigera anspråks- och kontrollpunktsattributen och överföra fler filer till anspråkskontrollen:

  1. Visa förslag: GET/proposals/{proposalId}

    • Om det behövs kan leverantören också visa motsvarande bearbetad anspråksinformation med hjälp av GET/processedClaims/{processed_claim_Id} API.

  2. Ladda upp och bifoga filer (om några) till anspråkskontrollpunkterna: POST/files och ange följande information i begärandetext

    • Fil eller fil-URL
    • Tagg
    • Resurs-URI för den kontrollpunkt där filen måste läggas till

  3. Uppdatera anspråksattribut med hjälp av en PATCH-åtgärd:

    • Få de senaste anspråksuppgifterna och notera ETag-värdet i svarshuvudet: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Uppdatera anspråksattributen och ange Etag-värdet i "If-Match"-nyckeln i förfrågningshuvudet: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Uppdatera anspråk attribut med hjälp av en PATCH-åtgärd:

    • Få de senaste kontrollpunkterna och notera ETag-värdet i svarshuvudet: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

    • Uppdatera anspråksattributen och ange Etag-värdet i "If-Match"-nyckeln i förfrågningshuvudet: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

      Kommentar

      När du anger uppdateringsattributen bör du se till att JSON-begärans brödtext följer samma struktur som i motsvarande API-anrop.

  5. Efter att ändringarna är gjorda kan leverantören skicka tillbaka förslaget till validerings- och verifieringsorganet med hjälp av POST/proposals/{proposalId}/action API och ange följande detaljer i begärandetexten:

    • Åtgärd: Skicka igen
    • Meddelande: Ange eventuella kommentarer (om det krävs) för referensen till validerings- och verifieringsorgan.

När förslaget har skickats in igen kan validerings- och verifieringsorganet granska förslaget och godkänna, avvisa eller återigen be om ändringar.

Återkalla begäran om kreditutfärdande

Möjlighet att ta bort den skickade begäran om kreditutfärdande (CreditMint):

Efter att förslaget om kreditgivning har lämnats in till registret, vid eventuella problem på grund av att du vill dra tillbaka det inlämnade förslaget, kan du dra tillbaka det inlämnade förslaget om registret inte har agerat på förslaget. Denna funktion är för närvarande endast tillgänglig av API:er.

  • Flytta CreditMint-förslaget som är i inlämnat tillstånd till återkallat tillstånd med hjälp av POST/proposals/{proposalId}/action API och ange följande detaljer i förfrågningstexten:

    • Åtgärd: Ta bort
    • Meddelande: Ange (om det finns någon) orsak till att dra tillbaka förslaget till registerreferens.

Status för förslaget är nu ansökan.

När kreditutfärdarbegäran har återkallats kan validerings- och verifieringsorganet ändra det "bearbetade anspråket" och resultaten av den tillhörande kontrollpunkten och sedan skicka begäran om kreditutfärdande på nytt.

  • Överför och bifoga filer till bearbetade anspråkets kontrollpunktresultat: POST/filer och ange följande information:

    • Fil eller FileURL
    • Tagg
    • ResourceURI för det associerade kontrollpunktsresultatet.

  • Uppdatera attributen för det bearbetade anspråket: PATCH/processedClaims/{processedClaim_Id}

  • Skicka utgivningsbegäran till registret igen och ange följande information i brödtexten för API-begäran: POST/proposals/{ proposal_id}/action

    • Åtgärd: Ange som skicka igen
    • Meddelande: Ange meddelande/kommentar (om det finns någon) för registerreferensen

Utfärda krediter

Det här avsnittet visar hur du visar och ger ut krediter via API:er. Instruktioner om hur du använder användargränssnittet finns i Utfärda krediter i tjänsten Miljökrediter.

Granska förslag till kreditutfärdande

Visa förslaget om token mint och hämta ett URI för resursen för bearbetat anspråk som har skickats för granskning:

GET/proposal/{proposalId}

Granska verifieringsresultaten från validerings- och verifieringsorganet genom att visa det bearbetade anspråket och de tillhörande kontrollpunktsresultaten (tillsammans med tillhörande filer):

GET/processedClaims/{processedClaims_Id}

Visa anspråks- och motsvarande kontrollpunktsinformation (tillsammans med en lista över filer som har bifogats av leverantören för kontrollpunkter):

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

Se detaljerna om det projektet för modulär förmån, tillsammans med listan över bifogade filer:

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

Hämta en fil med hjälp av fil-ID:

   GET/files/{fileId}

Godkänna krediter

Överför filer du vill bifoga till krediten för utfärdande: POST/files och ange följande information i begärandetext:

  • Fil eller fil-URL
  • Tagg

Godkänn förslaget:

   POST/proposals/{proposalId}/action

Ange följande detaljer i begärandetext:

  • Åtgärd: Ange som Mint
  • Meddelande: Ange meddelandet (om något) för referensen till validerings- och verifieringsorgan
  • Fil-ID: Ange fil-ID:en för de överladdade filerna så att filerna är bifogade till den utfärdade krediten
  • Kvantitet
  • Vintage
  • Tillgångs-ID
  • Bestämt värde

Kommentar

När förslaget har godkänts skapas en motsvarande kredit.

Avvisa förslag

Överför filer (om några) till det bearbetade anspråket: POST/filer och ange följande information:

  • Fil eller fil-URL
  • Tagg

Avvisa förslag:

   POST/proposals/{proposalId}/action

Ange följande detaljer i begärandetext:

  • Åtgärd: Avvisa
  • Meddelande: Ange meddelandet (om något) för referensen till validerings- och verifieringsorgan
  • Fil-ID: Ange fil-ID:n för den uppladdade filen så att dessa bifogas tillhörande bearbetade anspråk.

Returnera begäran om kreditutfärdande för redigeringar

Om det finns luckor eller felaktiga detaljer i begäran om utfärdande som du vill att validerings- och verifieringsorganet ska rätta till, kan du be om ändringar i begäran om utfärdande. Den här funktionen finns endast via API.

  1. Överför filer (om några) som du vill dela med validerings- och verifieringsorganet som en del av att skicka begäran om utfärdande för redigeringar.

  2. Flytta begäran om utfärdande (CreditMint-förslag) till submitterActionNeeded tillstånd med hjälp av POST/proposals/{proposalId}/action API och ange följande detaljer i förfrågningstexten:

    • Åtgärd: ReturnForEdits
    • Meddelande: Ange ett meddelande (om det finns något) för referensen till validerings- och verifieringstexten så att de förstår orsaken till redigeringsbegäran.
    • Fil-ID: Ange fil-ID:n för den uppladdade filen (om någon) så att filerna bifogas tillhörande bearbetat anspråk.

Nu kan validerings- och verifieringsorganet se det förslag som har skickats tillbaka för redigeringar. Nu kan de också redigera motsvarande resultat för bearbetning av anspråk och kontrollpunkter. De kan uppdatera attribut och överföra uppdaterade filer till kontrollpunktens resultat.

Om det behövs kan validerings- och verifieringsorganet begära förtydliganden om det verifierade kravet genom att returnera begäran om ändringar till leverantören. När leverantören har skickat anspråket på nytt kan validerings- och verifieringsorganet granska och verifiera kravet, uppdatera motsvarande bearbetat anspråk och sedan skicka begäran om utfärdande till registret igen.

  1. Överför och bifoga filer till kontrollpunktresultat: POST/filer och ange följande information:

    • Fil eller fil-URL
    • Tagg
    • ResourceURI för det associerade kontrollpunktsresultatet

  2. Uppdatera attributen för det processade kravet, inklusive kreditrekommendationen: PATCH/processedClaim/{bearbetat anspråks-id}

  3. Skicka utgivningsbegäran och ange följande information nedan i brödtexten för API-begäran: POST/proposals/{ proposal_id}/action

    • Åtgärd: Skicka igen
    • Meddelande: Ange meddelande (om det finns någon) för registerreferensen

När begäran har skickats in igen kan utfärdande register granska begäran och godkänna, avvisa eller återigen be om ändringar.

Visa utfärdade krediter

   GET/credits

Sök och visa krediter

Hämta alla krediter:

   GET/credits

Kommentar

Detta API returnerar listan över alla krediter. Köparna kan sedan filtrera listan på egen hand utifrån kreditstatus för att visa endast noterade krediter.

Visa kreditinformationen (inklusive ursprung) för en viss kredit som visas i listan:

   GET/credits/{creditId}/lineage

Notera krediter

I det här avsnittet visas hur du listar krediter på en marknadsplats för affärer via API:er. Instruktioner om hur du använder användargränssnittet finns i Notera krediter i tjänsten Miljökrediter.

Registrera dig som köpare eller en marknadsplats

Skicka MarketplaceTraderRegister förslag som kreditägare eller köpare:

   POST/proposals

Hämta och granska alla MarketplaceTraderRegister-förslag som en marknadsplats:

   GET/proposals

Godkänna eller avvisa förslag som marknadsplats:

   POST/proposals/{proposalId}/action

Hämta och visa alla handlarna som är registrerade på deras plattform som marknadsplats:

   GET/marketplaces/{marketplaceId}/traders

Skicka förslag om att notera en kredit

Skapa och skicka MarketplaceTraderRegister-förslag:

   POST/proposals

Granska förslag om att skapa en kredit

   GET/proposals

   POST /proposals/{proposalId}/action

Hantera krediter

Det här avsnittet visar hur du hanterar krediter via API:er. Instruktioner om hur du använder användargränssnittet finns i Hantera krediter i tjänsten Miljökrediter.

Avnotera en kredit

Att dela upp en kredit är en oberoende åtgärd inom tjänsten Miljökrediter. Information om hur du delar en kredit via API finns i Dela upp en kredit. När krediten är delad kan du fortsätta med nästa steg.

Skapa och skicka MarketplaceListingDeregister-förslag:

   POST/proposals

Visa alla MarketplaceListingDeregister-förslag som skickats in för granskning:

   GET/proposals

För att godkänna eller avslå förslaget:

   POST/proposals/{proposalId}/action

Överför projektägarskap

   POST/credits/{creditId}/transfer/

Visa kreditursprung

Organisationer med leverantörs- och registerroller kan visa kreditursprunget för de krediter de äger eller har utfärdade:

   GET/credits/{creditId}/lineage

Dela upp en kredit

Du kan dela upp en kredit i underordnade krediter. Den här funktionen finns för närvarande endast via API.

Dela upp krediten genom att ange kvantiteterna (i mtCO2e) för minst två underordnade krediter som kreditägare (för de krediter de äger) eller som en marknadsplats (för krediter noterade på deras plattform):

   POST/credits/{creditId}/split

Överför kreditnotering

En marknadsplats kan överföra en kreditnotering från sin plattform till en annan marknadsplats. Överföringen kallas även för överföring av inteckning. I det traditionella flödet listar en leverantör krediter på en marknadsplats som kan underlätta begära, rensa och avräkna. Det kan hända att en marknadsplats inte kan utföra betalningsavräkning och betalning på egen hand och att den kan vara beroende av en annan plattform för att utföra den. I det här fallet måste tillgången överföras till den nya marknadsplatsen för att slutföra transaktionen. Den här funktionen finns för närvarande endast via API:er.

Som marketplace skapar och skickar du MarketplaceListingDeregister-förslag för en kreditering som listas på din plattform:

   POST/proposals

Som en godkännarmarknad kan du se alla MarketplaceListingTransfer-förslag som skickats till dem för granskning:

   GET/proposals

Godkänn eller avvisa förslaget som marknadsplats för godkännare. Om förslaget godkänns överförs krediterna från den ursprungliga marknadsplatsen till marknadsplatsen för godkännande:

   POST/proposals/{proposalId}/action

Delvis överföring av inteckning: En marknadsplats kan överföra inteckning för delkredit genom att först dela upp krediten som en oberoende åtgärd. Information om hur du delar en kredit finns i Dela upp en kredit. När krediten är delad fortsätter du med ovanstående steg för överföring av inteckning för underordnad kredit.

Ange mål för emissioner

Det här avsnittet visar hur du ställer in utsläppsminskningsmål och mål via API:er.

Skapa mål för emission

   POST/esgs

Visa mål för emissioner

   GET/esgs

Spåra emissioner

I det här avsnittet visas hur du spårar resultatet från styrkortet för emissioner du anger via API:er. Instruktioner om hur du använder användargränssnittet finns i Spåra mål för emissioner i tjänsten Miljökrediter.

Skapa milstolpar för en specifik rapportperiod

   POST/esgs/{esgScorecardId}/milestones

Hämta alla milstolpar:

   GET/esgs/{esgScorecardId}/milestones

Hämta en specifik milstolpe:

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

Spåra faktiska emissioner mot milstolpen

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

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

Dra tillbaka krediter

I det här avsnittet får du lära dig hur du kompenserar för överutsläpp genom att dra tillbaka ägda koldioxidkrediter via API:er. Instruktioner om hur du använder användargränssnittet finns i Dra tillbaka krediter i tjänsten Miljökrediter.

Skicka förslaget om tillbakadragande av kredit

Skapa och skicka förslaget ESGEmissionOffset:

   POST/proposals

Köpare kan också dra in koldioxidkrediten direkt utan att ange de emissioner som ska kompenseras. Den här funktionen är bara tillgänglig via API.

Skapa och skicka förslaget CreditRetire:

   POST/proposals

Granska förslaget om tillbakadragande av kredit

   GET/proposals

   GET/proposals/{proposalId}

Bifoga fil till den kredit som granskas för att vara försedd med:

   POST/files

   POST/proposals/{proposalId}/action

Delvis tillbakadragning av kredit

Information om hur du delar en kredit via API finns i Dela upp en kredit.

När krediten har delats använder du API:erna i föregående steg för att kompenseringar och tillbakadragningar.

Hantera filer

I det här avsnittet visas hur du bifogar, visar och tar bort filer för tillgångar som projekt, anspråk och krediter via API:er. Instruktioner om hur du använder användargränssnittet finns i Hantera filer i tjänsten Miljökrediter.

Bifoga filer

Använd POST/files API för att bifoga en fil till en tillgång. Du måste ange följande information:

  • Fil eller fil-URI
  • Tillgångens resurs-URI
  • En beskrivande tagg på filen

Visa filer

Visa fillistan tillsammans med filegenskaper för en tillgång med hjälp av API för tillgångsinformation:

Modulärt förmånsprojekt:

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

Anspråk:

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

Kontrollera kontrollpunkter:

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

Kredit:

   GET/credits/{creditId}

Använd fil-ID:t som finns i filegenskaperna för filen när du hämtar filen:

   GET/files/{fileId}

Ta bort filer

Använd filens ID för filen och anropa API:et för borttagning:

   DELETE/files/{fileId}

Se även

Översikt över tjänsten Miljökrediter
Konfigurera tjänsten Miljökrediter
Ordlista för tjänsten Miljökrediter

Microsoft Cloud for Sustainability-ikon.ProduktsidaRegistreringsikon.Kostnadsfri utvärderingsversionCommunity-ikon.Community