Jaa

Ympäristöhyvityspalvelun ohjelmointirajapintaviittauksen yleiskatsaus

  • Artikkeli

Microsoft Cloud for Sustainability -kuvake. Microsoft Cloud for Sustainability

Maksuton kokeiluversio

Tärkeää

Tämä toiminto on osittain tai kokonaisuudessaan käytettävissä esiversion osana. Sisältö ja toiminnot voivat muuttua. Ympäristöhyvityspalvelun (esiversio) eristysympäristö on käytettävissä 30 päivän kokeiluversion ajan. Ympäristöhyvityspalvelun (esiversio) käyttäminen tuotantoympäristössä edellyttää ympäristöhyvityspalvelun (esiversio) rekisteröitymislomakkeen täyttämistä.

Tässä artikkelissa on tietoja ympäristöhyvityspalvelun REST-ohjelmointirajapintojen suorittamisesta. Täydelliset ohjelmointirajapintaviittaukset ovat kohdassa Ympäristöhyvityspalvelun ohjelmointirajapintaviittaus. Löydät Swagger-tiedoston kohdasta Ympäristöhyvityspalvelun REST API:t.

Rekisteröi projektit

Tässä osassa näytetään, miten voit luoda, lähettää ja tarkastella ekologisia projekteja ohjelmointirajapintojen kautta. Ohjeet käyttöliittymän käyttöön ovat ohjeessa Projektien rekisteröiminen ympäristöhyvityspalvelussa.

Projektin luominen

Tiedostojen lataaminen ja liittäminen projektin luonnin yhteydessä:

  1. Lataa tiedostoja POST/files-sovelluksella. Määritä seuraavat tiedot ohjelmointirajapinnassa:

    • Tiedosto tai tiedoston URL-osoite
    • Tiedoston kuvaava tunniste

  2. Luo ekologinen projekti ja sitä vastaava modulaarinen etuprojekti ja määritä fileID, joka palautetaan POST/files API -kutsun vastauksessa, määritteenä projektin luonnin ohjelmointirajapinnan pyyntörungossa: POST/ecoprojects.

Projektin tallentaminen ja lähettäminen

Hae projektin tiedot:

   GET/ecoProjects/{ecoProjectId}

Tarkastele modulaariseen etuprojektiin liitettyä tiedostoluetteloa (ja niiden metatietoja):

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

Lataa tiedosto käyttämällä fileID-tunnusta, joka on käytettävissä tiedoston metatietojen osana:

   GET/files/{fileId}

Lisää tiedostosi modulaariseen etuprojektiin:

   POST/files

Määritä modulaarisen etuprojektin resurssin URI pyynnön tekstiosaan.

Lähetä modulaarinen etuprojekti rekisteröintiä varten lähettämällä MBPRegister-ehdotus:

   POST/proposals

Näytä projekti

Hae kaikki ehdotukset:

   GET/proposals

Hae tietyn ehdotuksen tiedot:

   GET/proposals/{proposalId}

Hae tietyn ekologisen projektin tiedot:

   GET/ecoProjects/{ecoProjectId}

Hae tarkistettavan MBP:n tiedot:

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

Hanki modulaariseen etuprojektiin liitettyjen tiedostojen (ja niihin liittyvien metatietojen) luettelo:

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

Lataa tiedostot käyttämällä fileId-tunnusta, joka on käytettävissä edellisen ohjelmointirajapinnan vastauksen osana:

   GET/files/{fileId}

Liitä tiedosto modulaariseen etuprojektiin:

   POST/files

Ehdotuksen hyväksyminen tai hylkääminen

Tiedostojen lataaminen (jos on):

POST/files ja määritä tiedosto (tai FileUrl) ja tunnisteen tiedot

Hylkää rekisteröintipyyntö:

POST/proposals/{proposalId}/action ja määritä pyynnön tekstissä seuraavat tiedot

  • Toiminto: hylkää

  • Viesti: Määritä kommentti (jos on), jonka haluat antaa rekisteröinnin hylkäämistä varten.

  • FileID:t: Määritä ladattujen tiedostojen tiedostotunnukset.

Poista tiedosto

Tarkastele tiedostoluetteloita, jotka on liitetty modulaariseen etuprojektiin:

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

Määritä lataamasi tiedosto, koska käyttäjä voi poistaa vain lataamansa tiedostot.

Poista tiedosto:

   DELETE/files/{fileId}

Ehdotuksen palauttaminen muokkauksia varten

Jos projektin määritteissä tai tiedostoissa on virheellisiä tietoja, jotka haluat toimittajan korjaavan tai lisäävän, voit pyytää, että projektia muokataan.

  1. Lataa mahdolliset tiedostot, jotka on jaettava toimittajan kanssa:

    POST/files

  2. Siirrä MBPRegister-ehdotus submitterActionNeeded-tilaan ottamalla returnForEdits-toiminto käyttöön POST/proposals/{proposalId}/action-ohjelmointirajapinnassa ja määritä pyynnön tekstissä seuraavat tiedot:

    • Toiminto: returnForEdits

    • Viesti: Määritä toimittajan viittaukselle kommentti (tarvittaessa), kun palautat muokkauspyynnön.

    • Tiedostotunnukset: Määritä ladatun tiedoston tiedostotunnus tähän liittääksesi tiedoston kyseiselle modulaariselle etuprojektille.

    Tämän jälkeen modulaarinen etuprojekti siirtyy returnedForEdits-tilaan.

Toimittajat voivat nyt tarkastella muokattavaksi lähetettyä ehdotusta. He voivat nyt muokata modulaaristen etuprojektien määritteitä ja ladata lisää tiedostoja modulaariseen etuprojektiin.

  • Näytä ehdotus: GET/proposals/{proposalId}

  • Lataa ja liitä tiedostoja modulaariseen etuprojektiin: POST/files ja määritä pyynnön tekstissä seuraavat tiedot:

    • Tiedosto tai tiedoston URL-osoite
    • Tunniste: Tiedoston kuvaava tunniste
    • ResourceURI: Määritä vastaavan modulaarisen etuprojektin resurssin URI.

  • Modulaarisen etuprojektin määritteiden päivittäminen

    • Hanki modulaarisen etuprojektin päivitetyt tiedot GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} -työkalulla ja kopioi Etag-arvo vastausotsikosta.
    • Päivitä modulaariset etuprojektimääritteet PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id}-ohjelmointirajapinnan avulla ja määritä otsikon If-Match-avaimessa Etag-arvo.

Kun muutokset on tehty, toimittaja voi nyt lähettää ehdotuksen takaisin rekisteriin POST/proposals/{proposalId}/action-ohjelmointirajapinnan avulla ja määrittää pyynnössä seuraavat tiedot:

  • Toiminto: Lähetä

  • Viesti: Määritä rekisteriviittaukselle kommentti (jos on).

Tarkkojen lisäetuprojektien rekisteröinti

Lähetä ekologinen etu rekisteröintiä varten tekijän rekisteriin luomalla ja lähettämällä MBPRegister-ehdotus:

   POST/proposal

Modulaarisen etuprojektin arvostelu

Näytä ehdotuksen tiedot:

   GET/proposals/{proposalId}

Tarkastele projektin kaikkia tietoja:

   GET/ecoProjects/{ecoProjectId}

Tarkastele projektin yksilöllistä modulaarista etuprojektia:

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

Hyväksy tai hylkää rekisteröintiehdotus tai palauta se muokkauksia varten:

   POST/proposals/{proposalId}/action

Hyvitysten käsitteleminen

Tässä osassa on tietoja hyvitysten käsittelemiseen ohjelmointirajapintojen kautta. Ohjeet käyttöliittymän käyttöön ovat ohjeessa Hyvitysten käsitteleminen ympäristöhyvityspalvelussa.

Hyvitysten luominen

Hyvityksen luominen:

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

Tiedostojen lataaminen ja liittäminen hyvityksen tarkistuspisteisiin:

   POST/files

Määritä seuraavat tiedot pyyntöön:

  • Tiedosto tai tiedoston URL-osoite
  • Tunniste
  • Pyynnön resurssin URI

Hyvitysten lähettäminen

Luo ja lähetä modulaarinen etuprojekti ClaimVerify-ehdotus:

   POST/proposals

Näytä lähetetyn ehdotuksen tiedot:

   GET/proposal/{proposalId}

Näytä hyvityksen tiedot:

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

Hyvitysten vahvistaminen

Näytä ehdotukset:

   GET/proposals

Hae tietyn ehdotuksen tiedot:

   GET/proposals/{proposalId}

Hae sen hyvityksen tiedot, jota varten tarkistusehdotus on lähetetty:

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

Hyväksy hyvitystä tarkistava tehtävä:

   POST/proposals/{proposalId}/action

Luettele tiedostot, jotka liittyvät modulaariseen etuprojektiin:

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

Tarkista hyvitykseen liittyvät tiedostot:

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

Tiettyyn resurssiin liitetyn tiedoston tarkasteleminen:

   GET/files/{fileId}

Kun vaade on hyväksytty, vastaava Käsitelty vaade luodaan. Kirjaa todennustulokset käsiteltyyn vaateeseen. Tämä sisältää vaateen määrän ja sivuhyötyjen päivittämisen. Hyvityssuositus on päivitettävä ennen hyvityksen myöntöpyynnön lähettämisetä myös käsitellyssä vaateessa:

  • Hae käsitellyn vaateen tiedot GET/processedClaims/{processed_claim_id}-ohjelmointirajapinnan avulla ja kopioi Etag-arvo vastauksen otsikosta.
  • Päivitä käsitellyt vaademääritteet PATCH/processedClaims/{processed_claim_id}-ohjelmointirajapinnan avulla ja määritä otsikon If-Match-avaimessa Etag-arvo.

Todennustulokset voidaan päivittää kussakin vahvistettavassa tarkistuspisteessä käsitellyn vaateen vastaavan tarkistuspisteen tulokseen:

  • Lataa ja liitä todennustulosraportit käsitellyn vaateen tarkistuspisteen tuloksiin POST/files-ohjelmointirajapinnan avulla ja määritä tiedosto tai tiedoston URL-osoite, tunniste ja ResourceUri (mikä on tarkistuspisteen tuloksen resurssin uri) pyynnön tekstiosassa.
  • Päivitä ympäristövaikutus ennen tarkistuspisteen tulokseen määritteitä ja niiden jälkeen (tarvittaessa):
    • Hae tarkistuspisteen tuloksen tiedot GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id}-ohjelmointirajapinnan avulla ja kopioi Etag-arvo vastauksen otsikosta.
    • Päivitä tarkistuspisteen tuloksen määritteet PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id}-ohjelmointirajapinnan avulla ja määritä otsikon If-Match-avaimessa Etag-arvo.
    • Voit päivittää tarkistuspistetulokset myös käyttämällä käsiteltyjen väitteiden korjaustiedosto-ohjelmointirajapintaa.

Kun vahvistus on valmis, hyväksy tai hylkää MBPClaimVerify-ehdotus:

   POST/proposals/{proposalId}/action

Määritä seuraavat tiedot:

  • Toiminto: Hyväksyminen tai hylkääminen

  • Viesti: Määritä toimittajaviittaukselle kommentti (jos on).

Kun MBPClaimVerify-ehdotus on hyväksytty, lähetä hyvityksen myöntöpyyntö luomalla ja lähettämällä CreditMint-ehdotus:

   POST/proposals/

Hyvityspyynnön palautus muokkauksia varten

Jos hyvityspyynnössä on puutteita tai virheellisiä tietoja, jotka validointi- ja todennuselin haluaa toimittajan korjaavan, pyyntöön voidaan pyytää muutoksia sen sijaan, että pyyntö hyväksyttäisiin tai hylättäisiin. Tämä ominaisuus on saatavana vain ohjelmointirajapinnan kautta.

  1. Lataa ja liitä tiedostot (jotka halutaan jakaa toimittajan kanssa) käsiteltyyn vaateeseen tai käsitellyn vaateen tarkistuspisteen tulokseen: POST/files ja määritä seuraavat tiedot pyynnön tekstiosassa:

    • Tiedosto tai tiedoston URL-osoite
    • Tunniste
    • Sen käsitellyn vaateen tai käsitellyn vaateen tarkistuspisteen tuloksen resurssin URI, johon tiedosto on lisättävä

  2. Siirrä MBPClaimVerify-ehdotus submitterActionNeeded-tilaan ottamalla returnForEdits-toiminto käyttöön POST/proposals/{proposalId}/action-ohjelmointirajapinnassa ja määritä pyynnön tekstissä seuraavat tiedot:

    • Toiminto: returnForEdits
    • Viesti: Määritä toimittajan viittaukselle kommentti (tarvittaessa), kun palautat muokkauspyynnön.

Palautetun ehdotuksen muokkaaminen

Toimittajat voivat sitten tarkastella muokattavaksi lähetettyä ehdotusta. He voivat nyt muokata väite- ja tarkistuspistemääritteitä ja ladata lisää tiedostoja väiteiden tarkistuspisteille:

  1. Näytä ehdotus: GET/proposals/{proposalId}

    • Toimittaja voi tarvittaessa tarkastella myös vastaavan käsitellyn vaateen tietoja käyttämällä ohjelmointirajapintaa GET/processedClaims/{processed_claim_Id}.

  2. Lataa ja liitä tiedostoja (jos on) hyvityksen tarkistuspisteisiin: POST/files ja määritä pyynnön tekstissä seuraavat tiedot

    • Tiedosto tai tiedoston URL-osoite
    • Tunniste
    • Sen tarkistuspisteen resurssin URI, johon tiedosto on lisättävä

  3. Päivitä hyvitysmääritteet PATCH-ominaisuuden avulla:

    • Hanki uusimmat hyvityksen tiedot ja kirjoita ETag-arvo vastausotsikolle: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Päivitä hyvitysmääritteet ja määritä If-Match-avaimessa Etag-arvo pyynnön otsikossa: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Päivitä hyvityksen tarkistuspistemääritteet PATCH-ominaisuuden avulla:

    • Hanki uusimmat tarkistuspisteen tiedot ja kirjoita ETag-arvo vastausotsikolle: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

    • Päivitä hyvitysmääritteet ja määritä If-Match-avaimessa Etag-arvo pyynnön otsikossa: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

      Huomautus

      Kun määrität päivitysmääritteitä, varmista, että JSON-pyynnön teksti vastaa samaa rakennetta kuin vastaavassa ohjelmointirajapintakutsussa.

  5. Kun muokkaukset on tehty, toimittaja voi sitten lähettää ehdotuksen takaisin vahvistus- ja tarkistuselimeen käyttämällä POST/proposals/{proposalId}/action-ohjelmointirajapintaa ja määrittää pyynnön tekstissä seuraavat tiedot:

    • Toiminto: Lähetä uudelleen
    • Viesti: Määritä vahvistus- ja tarkistusosaviittauksen kommentti (tarvittaessa).

Kun ehdotus on lähetetty uudelleen, validointi- ja todennuselin voi tarkastella sitä ja hyväksyä tai hylätä sen taikka pyytää siihen uudelleen muokkauksia.

Hyvityspyynnön myöntämisen peruuttaminen

Vaihtoehto lähetetyn hyvityksen myöntöpyynnön (CreditMint)proposal peruuttamiseen:

Kun hyvitysehdotus on lähetetty rekisteriin, voit peruuttaa lähetetyn ehdotuksen, jos sen vuoksi on ongelmia, joiden takia haluat peruuttaa lähetetyn ehdotuksen. Toistaiseksi tämä toiminto on saatavilla vain ohjelmointirajapintojen kautta.

  • Siirrä lähetetyssä tilassa oleva CreditMint-ehdotus peruutettu-tilaan käyttämällä POST/proposals/{proposalId}/action-ohjelmointirajapintaa, ja määritä seuraavat tiedot pyynnön tekstiosassa:

    • Toiminto: Peruuttaminen
    • Viesti: Määritä rekisteriviittauksen peruuttamisen syy (jos on).

Ehdotuksen tila on nyt Peruutettu.

Kun hyvityksen myöntöpyyntö on peruutettu, validointi- ja todennuselin voi muokata käsiteltyä vaadetta ja siihen liitettyjä tarkistuspisteen tuloksia sekä lähettää sitten hyvityksen myöntöpyynnön uudelleen.

  • Lataa ja liitä tiedostot käsitellyn vaateen tarkistuspisteen tuloksiin: POST/files ja määritä seuraavat tiedot:

    • Tiedosto tai FileURL
    • Tunniste
    • Liitetyn tarkistuspisteen tuloksen ResourceURI.

  • Päivitä käsitellyn vaateen määritteet: PATCH/processedClaims/{processedClaim_Id}

  • Lähetä julkaisupyyntö uudelleen rekisteriin ja määritä ohjelmointirajapintapyynnön tekstissä seuraavat tiedot: POST/proposals/{ proposal_id}/action

    • Toiminto: Määritä uudelleenlähetetyksi
    • Viesti: Määritä rekisteriviittaukselle viesti/kommentti (jos on)

Hyvitysten myöntäminen

Tässä osassa näytetään, miten ohjelmointirajapintojen avulla voidaan tarkastella ja myöntää hyvityksiä. Ohjeet käyttöliittymän käyttöön ovat ohjeessa Hyvitysten myöntäminen ympäristöhyvityspalvelussa.

Hyvitysehdotusten tarkasteleminen

Tarkastele Token mint -ehdotusta ja hae tarkistettavaksi lähetetyn käsitellyn vaateen resurssin URI:

GET/proposal/{proposalId}

Tarkista validointi- ja todennuselimen todennustulokset tarkastelemalla käsiteltyä vaadetta ja liitettyjä tarkistuspisteen tuloksia (sekä liitettyjä tiedostoja):

GET/processedClaims/{processedClaims_Id}

Tarkastele hyvitystä ja vastaavia tarkistuspistetietoja (sekä luettelo toimittajan tarkistuspisteille liitetyistä tiedostoista):

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

Tarkastele modulaarisen etuprojektin tietoja liitettyjen tiedostoluetteloiden mukana:

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

Lataa tiedosto käyttämällä tiedostotunnusta:

   GET/files/{fileId}

Hyväksy hyvitykset

Lataa tiedostoja, jotka haluat liittää hyvityksen myöntämistä varten: POST/files ja määritä pyynnön tekstissä seuraavat tiedot:

  • Tiedosto tai tiedoston URL-osoite
  • Tunniste

Hyväksy ehdotus:

   POST/proposals/{proposalId}/action

Määritä seuraavat tiedot pyynnön tekstiin:

  • Toiminto: Määritä arvoksi Mint
  • Viesti: Määritä vahvistus- ja tarkistusosaviittauksen viesti (jos on)
  • Tiedostotunnukset: Määritä ladattujen tiedostojen tiedostotunnukset niin, että tiedostot liitetään annettuun hyvitykseen
  • Määrä
  • Vintage
  • Resurssin tunnus
  • Määritetty arvo

Huomautus

Kun ehdotus hyväksytään, vastaava hyvitys luodaan.

Hylkää ehdotus

Lataa tiedostot (jos on) käsiteltyyn vaateeseen: POST/files ja määritä seuraavat tiedot:

  • Tiedosto tai tiedoston URL-osoite
  • Tunniste

Hylkää ehdotus:

   POST/proposals/{proposalId}/action

Määritä seuraavat tiedot pyynnön tekstiin:

  • Toiminto: hylkää
  • Viesti: Määritä vahvistus- ja tarkistusosaviittauksen viesti (jos on)
  • Tiedostotunnukset: Määritä ladatun tiedoston tiedostotunnukset siten, että ne liitetään liitettyyn käsiteltyyn vaateeseen.

Palautushyvitysten myöntämispyyntö muokkauksia varten

Jos myöntämispyynnössä on aukkoja tai virheellisiä tietoja, jotka haluat tarkistus- ja vahvistuselimen korjaavan, voit pyytää muokkauksia myöntämispyyntöön. Tämä ominaisuus on saatavana vain ohjelmointirajapinnan kautta.

  1. Lataa tiedostot (jos on), jotka haluat jakaa vahvistus- ja tarkistuskappaleen kanssa, kun lähetät hyväksymispyynnön takaisin muokkauksia varten.

  2. Siirrä myöntämispyyntö (CreditMint-ehdotus) submitterActionNeeded-tilaan käyttämällä POST/proposals/{proposalId}/action-ohjelmointirajapintaa ja määritä seuraavat tiedot pyynnön tekstiosassa:

    • Toiminto: ReturnForEdits
    • Viesti: Määritä vahvistus- ja tarkistusosaviittaukselle sanoma (jos on), jotta he ymmärtävät muokkauspyynnön syyn.
    • Tiedostotunnukset: Määritä ladattujen tiedostojen tiedostotunnukset (jos on) siten, että tiedostot liitetään liitettyyn käsiteltyyn vaateeseen.

Vahvistus- ja tarkistusosa voi nyt tarkastella takaisin lähetettyä muokattavaksi lähetettyä ehdotusta. Se voi myös muokata vastaavaa käsiteltyä vaadetta ja tarkistuspisteen tuloksia. Se voi päivittää määritteet sekä ladata päivitetyt tiedostot tarkistuspisteen tuloksiin.

Validointi- ja todennuselin voi tarvittaessa pyytää tässä vaiheessa tarkennuksia vahvistettuun vaateeseen palauttamalla vaateen muutoksia varten toimittajalle. Kun toimittaja lähettää vaateen uudelleen, validointi- ja tarkistuselin voi tarkistaa ja vahvistaa vaateen, päivittää vastaavan käsitellyn vaateen ja lähettää sitten myöntöpyynnön rekisteriin.

  1. Lataa ja liitä tiedostot tarkistuspisteen tuloksiin: POST/files ja määritä seuraavat tiedot:

    • Tiedosto tai tiedoston URL-osoite
    • Tunniste
    • Liitettyjen tarkistuspisteen tulosten ResourceURI

  2. Päivitä käsitellyn vaateen määritteet, mukaan lukien hyvityssuositus: PATCH/processedClaim/{käsitellyn vaateen tunnus}

  3. Lähetä julkaisupyyntö uudelleen ja määritä ohjelmointirajapintapyynnön tekstissä alla olevat tiedot: POST/proposals/{ proposal_id}/action

    • Toiminto: Lähetä uudelleen
    • Viesti: Määritä rekisteriviittaukselle viesti (jos on)

Kun pyyntö on lähetetty uudelleen, myöntävä rekisteri voi tarkistaa pyynnön ja hyväksyä tai hylätä sen taikka pyytää siihen uudelleen muokkauksia.

Myönnettyjen hyvitysten tarkasteleminen

   GET/credits

Hyvitysten hakeminen ja tarkasteleminen

Nouda kaikki hyvitykset:

   GET/credits

Huomautus

Tämä ohjelmointirajapinta palauttaa luettelon kaikista hyvityksistä. Tämän jälkeen ostajat voivat suodattaa luetteloa itse hyvityksen tilan perusteella, kun he tarkastelevat vain lueteltuja hyvityksiä.

Tarkastele luettelossa näkyvän tietyn hyvityksen tietoja (mukaan lukien historiatietoja):

   GET/credits/{creditId}/lineage

Hyvitysten luettelo

Tässä osassa kerrotaan, miten marketplace-hyvitykset voi luetteloida ohjelmointirajapintojen kautta käytävää kauppaa varten. Ohjeet käyttöliittymän käyttöön ovat ohjeessa Hyvitysten luetteleminen ympäristöhyvityspalvelussa.

Rekisteröityminen ostajaksi tai Marketplace-sivustoon

Lähetä MarketplaceTraderRegister-ehdotus hyvityksen omistajana tai ostajana:

   POST/proposals

Hae ja tarkista kaikki MarketplaceTraderRegister-ehdotukset kauppapaikkana:

   GET/proposals

Hyväksy tai hylkää ehdotukset marketplace-markkinapaikkana:

   POST/proposals/{proposalId}/action

Hae ja tarkastele kaikkia käyttöympäristöön rekisteröityjä välittäjiä Marketplace-markkinapaikkana:

   GET/marketplaces/{marketplaceId}/traders

Hyvityksen luettelon lähettäminen ehdotuksessa

MarketplaceListingRegister-ehdotuksen luominen ja lähettäminen:

   POST/proposals

Hyvityksen luettelon tarkasteleminen ehdotuksessa

   GET/proposals

   POST /proposals/{proposalId}/action

Hyvitysten hallinta

Tässä osassa on tietoja hyvitysten hallintaan ohjelmointirajapintojen kautta. Ohjeet käyttöliittymän käyttöön ovat ohjeessa Hyvitysten hallinta ympäristöhyvityspalvelussa.

Poista hyvitys

Hyvityksen jakaminen on ympäristöhyvityspalvelun itsenäinen toiminto. Tietoja hyvityksen jakamisesta ohjelmointirajapinnan kautta on kohdassa Hyvityksen jakaminen. Kun hyvitys on jaettu, voit jatkaa seuraavaa vaihetta.

MarketplaceListingDeregister-ehdotuksen luominen ja lähettäminen:

   POST/proposals

Tarkastele kaikkia tarkistettavaksi lähetettyjä MarketplaceListingDeregister-ehdotuksia:

   GET/proposals

Ehdotuksen hyväksyminen tai hylkääminen:

   POST/proposals/{proposalId}/action

Siirrä omistus

   POST/credits/{creditId}/transfer/

Näytä hyvityksen historiatiedot

Organisaatiot, joilla on toimittaja- ja rekisterirooli, voivat tarkastella omistamiaan tai myöntämiään hyvityksiä:

   GET/credits/{creditId}/lineage

Hyvityksen jako

Voit jakaa hyvityksen alihyvitykseksi. Tämä toiminto on käytettävissä tällä hetkellä vain ohjelmointirajapinnan kautta.

Jaa hyvitys määrittämällä määrät (mtCO2e-hyvityksenä) vähintään kahdelle alihyvitykselle hyvityksen omistajana (omistamistaan hyvityksistä) tai marketplace-markkinapaikkana (käyttöympäristössä mainitut hyvitykset):

   POST/credits/{creditId}/split

Hyvityksen luettelon siirtäminen

Marketplace voi siirtää hyvitysluettelon alustastaan toiseen marketplaceen. Tätä siirtoa kutsutaan myös rasitteen siirroksi. Perinteisessä työnkulussa toimittaja luetteloi hyvitykset marketplace-sivustossa, joka auttaa kysyntään, selvitysosaan ja hyvitysten poistamiseen. Joskus marketplace ei ehkä pysty suorittamaan maksujen selvitystä ja selvitysosaa yksin, ja se voi olla riippuvainen eri ympäristöstä. Tällöin resurssi on siirrettävä uuteen markkinapaikkaan, jotta tapahtuma voidaan suorittaa. Tämä ominaisuus on käytettävissä tällä hetkellä vain ohjelmointirajapintojen kautta.

Markkinapaikkana voit luoda ja lähettää MarketplaceListingTransfer-ehdotuksen hyvitykselle, joka on lueteltu käyttöympäristössäsi:

   POST/proposals

Hyväksyjäkauppapaikkana voit tarkastella kaikkia MarketplaceListingTransfer-ehdotuksia, jotka on lähetetty tarkistettavaksi:

   GET/proposals

Hyväksy tai hylkää ehdotukset marketplace-hyväksyjänä. Jos ehdotus hyväksytään, hyvitykset siirretään alkuperäisestä marketplacesta hyväksyjän marketplaceen:

   POST/proposals/{proposalId}/action

Osamaksun siirtäminen: Marketplace voi siirtää osittaista hyvittämismaksua varten jakamalla hyvityksen ensin riippumattomana toiminnona. Tietoja siitä, miten hyvitys jaetaan kohdassa Hyvityksen jakaminen. Kun hyvitys on jaettu, jatka edellä mainituilla vaiheilla alihyvitysten rasitteeseen.

Päästötavoitteiden asettaminen

Tässä osassa näytetään, miten ohjelmointirajapintojen avulla määritetään vähennystavoitteet ja -päämäärät.

Päästötavoitteiden luominen

   POST/esgs

Päästötavoitteiden tarkasteleminen

   GET/esgs

Seuraa päästöjä

Tässä osassa on tietoja siitä, miten voit seurata päästöjäsi ohjelmointirajapintojen avulla määritettyä pisteytyskorttia vastaan. Ohjeet käyttöliittymän käyttöön ovat ohjeessa Päästötavoitteiden seuraaminen ympäristöhyvityspalvelussa.

Välitavoitteiden luominen tietylle raportointijaksolle

   POST/esgs/{esgScorecardId}/milestones

Hae kaikki välitavoitteet:

   GET/esgs/{esgScorecardId}/milestones

Hae tietty välitavoite:

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

Todellisen päästöjen seuraaminen välitavoitteita vastaan

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

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

Hyvitysten mitätöiminen

Tässä osassa kerrotaan, miten voit korvata liikapäästöt, kun siirrät omistamiasi hiilidioksidihyvityksiä ohjelmointirajapintojen kautta. Ohjeet käyttöliittymän käyttöön ovat ohjeessa Hyvitysten poistaminen ympäristöhyvityspalvelussa.

Hyvityksen poistamista koskevan ehdotuksen lähettäminen

Luo ja lähetä ESGEmissionOffset-ehdotus:

   POST/proposals

Ostajat voivat myös poistaa hiilidioksidipäästöt suoraan ilmoittamatta kompensoitavia päästöjä. Tämä toiminto on käytettävissä vain ohjelmointirajapinnan kautta.

Luo ja lähetä CreditRetire-ehdotus:

   POST/proposals

Hyvityksen poistamista koskevan ehdotuksen arvioiminen

   GET/proposals

   GET/proposals/{proposalId}

Liitä tiedosto hyvitykseen, jota tarkistetaan poistoa varten:

   POST/files

   POST/proposals/{proposalId}/action

Osittainen hyvitysten poisto

Tietoja hyvityksen jakamisesta ohjelmointirajapinnan kautta on kohdassa Hyvityksen jakaminen.

Kun hyvitys on jaettu, käytä edellisten vaiheiden ohjelmointirajapintojen offsetia ja eläkettä.

Tiedostojen hallinta

Tässä osassa kerrotaan, miten voit liittää, tarkastella ja poistaa esimerkiksi projektin, vaatimuksen ja hyvityksen tiedostoja ohjelmointirajapintojen kautta. Ohjeet käyttöliittymän käyttöön ovat ohjeessa Tiedostojen hallinta ympäristöhyvityspalvelussa.

Liitä tiedostoja

Liitä tiedosto resurssiin POST/files-ohjelmointirajapinnan avulla. Sinun tulee määrittää seuraavat tiedot:

  • Tiedosto tai tiedoston URI-osoite
  • Määrityksen resurssin URI
  • Tiedoston kuvaava tunniste

Tarkastele tiedostoja

Tarkastele tiedostoluetteloa sekä resurssin tiedosto-ominaisuuksia resurssin tietojen ohjelmointirajapinnan avulla:

Modulaarinen etuprojekti:

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

Vaatimukset:

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

Hyvityksen tarkistuspisteet:

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

Hyvitys:

   GET/credits/{creditId}

Lataa tiedosto tiedoston ominaisuuksissa olevan tiedostotunnuksen avulla:

   GET/files/{fileId}

Poista tiedostoja

Käytä tiedoston tiedostotunnusta, kun haluat kutsua poiston ohjelmointirajapintaa:

   DELETE/files/{fileId}

Katso myös

Ympäristöhyvityspalvelun yleiskatsaus
Ympäristöhyvityspalvelun määritys
Ympäristöhyvityspalvelun sanasto

Microsoft Cloud for Sustainability -kuvake.TuotesivuRekisteröitymiskuvake.Maksuton kokeiluversioYhteisökuvake.Yhteisö