API atsauces pārskats par vides kredītu pakalpojumu

  • Raksts

Microsoft Cloud for Sustainability Tehniskais samits 2024. gada maijs

Svarīgi

Daļa vai visa šī funkcionalitāte ir pieejama kā daļa no priekšskatījuma laidiena. Saturs un funkcionalitāte var mainīties. Varat piekļūt Vides kredītu pakalpojuma (priekšskatījuma) smilškastes videi 30 dienu izmēģinājumam. Lai izmantotu vides kredītu pakalpojumu (priekšskatījumu) ražošanas vidē, aizpildiet vides kredītu pakalpojuma (priekšskatījuma) reģistrācijas veidlapu.

Šis raksts palīdz jums veikt uzdevumus, izmantojot Environmental Credit Service REST API. Lai skatītu pilnu API atsauci, dodieties uz vides kredītu pakalpojumu API atsauci. Swagger failu varat atrast vietnē Environmental Credit Service REST API.

Projektu reģistrēšana

Šajā sadaļā ir parādīts, kā izveidot, iesniegt un pārskatīt ekoloģiskos projektus, izmantojot API. Norādījumus par lietotāja saskarnes izmantošanu skatiet rakstā Projektu reģistrēšana vides kredītu pakalpojumā.

Projekta izveide

Lai augšupielādētu un pievienotu failus projekta izveides laikā:

  1. Augšupielādējiet failus, izmantojot funkciju POST/faili. API norādiet šādu informāciju:

    • Faila vai faila URL
    • Aprakstošais tags failam

  2. Izveidojiet ekoloģisko projektu un atbilstošo modulāro labumu projektu un norādiet faila ID, kas tiek atgriezts POST/files API izsaukuma atbildē kā atribūts projekta izveides API pieprasījuma pamattekstā: POST/ekoprojekti.

Projekta saglabāšana un iesniegšana

Iegūstiet informāciju par projektu:

   GET/ecoProjects/{ecoProjectId}

Skatiet modulārajam pabalstu projektam pievienoto failu sarakstu (un ar tiem saistītos metadatus):

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

Lejupielādējiet failu, izmantojot faila ID, kas ir pieejams kā daļa no faila metadatiem:

   GET/files/{fileId}

Pievienojiet failus modulārajam pabalstu projektam:

   POST/files

Pieprasījuma pamattekstā norādiet modulārās priekšrocības projekta resursa URI.

Iesniegt moduļu pabalstu projektu reģistrācijai, iesniedzot MBPRegister priekšlikumu:

   POST/proposals

Skatīt projektu

Atnesiet visus priekšlikumus:

   GET/proposals

Iegūstiet sīkāku informāciju par konkrētu priekšlikumu:

   GET/proposals/{proposalId}

Iegūstiet informāciju par konkrētu ekoloģisko projektu:

   GET/ecoProjects/{ecoProjectId}

Iegūstiet detalizētu informāciju par konkrēto MBP, lai to pārskatītu:

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

Iegūstiet modulārajam priekšrocību projektam pievienoto failu sarakstu (un saistītos metadatus):

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

Lejupielādējiet failus, izmantojot faila ID, kas ir pieejams kā daļa no iepriekšējās API atbildes:

   GET/files/{fileId}

Pievienojiet failu modulārajam pabalstu projektam:

   POST/files

Priekšlikuma apstiprināšana vai noraidīšana

Failu augšupielāde (ja tādi ir):

POST/failus un norādiet File (vai FileUrl) un tagu informāciju

Noraidīt reģistrācijas pieprasījumu:

POST/priekšlikumi/{proposalId}/rīcība un pieprasījuma pamattekstā norādiet šādu informāciju

  • Darbība: Noraidīt

  • Ziņojums: norādiet komentāru (ja tāds ir), kuru vēlaties sniegt reģistrācijas noraidīšanai.

  • FileID: norādiet augšupielādēto failu ID.

Faila dzēšana

Skatiet modulārajam pabalstu projektam pievienoto failu sarakstu:

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

Identificējiet augšupielādēto failu, jo lietotājs var izdzēst tikai tos failus, kurus viņš ir augšupielādējis.

Dzēsiet failu:

   DELETE/files/{fileId}

Rediģēšanas priekšlikuma atgriešana

Ja projekta atribūtos vai failos ir dažas nepilnības vai nepareiza informācija, kuru vēlaties, lai piegādātājs labotu vai pievienotu, varat lūgt veikt labojumus projektā.

  1. Augšupielādējiet failus, ja tādi ir, kas ir jākopīgo ar piegādātāju:

    ZIŅA/faili

  2. Pārvietojiet MBPRegister priekšlikumu uz submitterActionNeeded state, veicot returnForEdits darbību, izmantojot POST/proposals/{proposalId}/action API, un pieprasījuma pamattekstā norādiet šādu informāciju:

    • Darbība: returnForEdits

    • Ziņojums: norādiet komentāru (ja nepieciešams) piegādātāja atsaucei, atgriežot rediģēšanas pieprasījumu.

    • Faila ID: šeit norādiet augšupielādētā faila ID, lai pievienotu failu attiecīgajam modulārajam pabalstu projektam.

    Pēc tam, kad tas ir izdarīts, modulārais pabalstu projekts pārceļas uz returnedForEdits stāvokli.

Tagad piegādātāji var skatīt priekšlikumu, kas tika nosūtīts atpakaļ rediģēšanai. Tagad viņi var rediģēt modulāro priekšrocību projekta atribūtus un augšupielādēt vairāk failu modulārajā priekšrocību projektā.

  • Skatīt priekšlikumu: GET/priekšlikumi/{proposalId}

  • Augšupielādējiet un pievienojiet failus modulārajam pabalstu projektam: POST/faili un pieprasījuma tekstā norādiet šādu informāciju:

    • Faila vai faila URL
    • Tag: aprakstošs faila tags
    • ResourceURI: norādiet attiecīgā modulārā pabalstu projekta resursu URI.

  • Moduļu pabalstu projekta atribūtu atjaunināšana

    • Iegūstiet atjaunināto modulāro ieguvumu projekta informāciju, izmantojot GET/ekoprojekti/{ecoproject_id}/mbps/{mbp_id} un nokopējiet Etag vērtību no atbildes galvenes.
    • Atjauniniet modulāro priekšrocību projekta atribūtus, izmantojot PATCH/ekoprojektus/{ecoproject_id}/mbps/API,{mbp_id} un galvenē norādiet Etag vērtību atslēgā If-Match.

Kad izmaiņas ir pabeigtas, piegādātājs tagad var iesniegt priekšlikumu atpakaļ reģistrā, izmantojot POST/proposals/{proposalId}/action API, un pieprasījumā norādīt šādu informāciju:

  • Darbība: Iesniegt

  • Ziņojums: norādiet komentāru (ja tāds ir) reģistra atsaucei.

Reģistrējiet papildu moduļu pabalstu projektus

Iesniedziet ekoloģisko labumu reģistrācijai izdevēju reģistrā, izveidojot un iesniedzot MBPRegister priekšlikumu:

   POST/proposal

Moduļu pabalstu projekta pārskatīšana

Skatīt detalizētu informāciju par priekšlikumu:

   GET/proposals/{proposalId}

Skatīt visu projekta informāciju:

   GET/ecoProjects/{ecoProjectId}

Apskati informāciju par projekta individuālo modulāro ieguvumu projektu:

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

Apstipriniet vai noraidiet reģistrācijas priekšlikumu vai atgrieziet to rediģēšanai:

   POST/proposals/{proposalId}/action

Prasību apstrāde

Šajā sadaļā ir parādīts, kā apstrādāt pretenzijas, izmantojot API. Lai iegūtu norādījumus par lietotāja saskarnes izmantošanu, dodieties uz sadaļu Pretenziju apstrāde vides kredītu pakalpojumā.

Pretenziju izveide

Izveidot pretenziju:

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

Augšupielādējiet un pievienojiet failus kontrolpunktu pieprasīšanai:

   POST/files

Pieprasījumā norādiet šādu informāciju:

  • Faila vai faila URL
  • Atzīmju
  • Prasības resursa URI

Iesniegt pretenzijas

Izveidojiet un iesniedziet modulāro priekšrocību projektuClaimVerify priekšlikums:

   POST/proposals

Skatīt sīkāku informāciju par iesniegto priekšlikumu:

   GET/proposal/{proposalId}

Skatīt detalizētu informāciju par prasību:

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

Pārbaudīt pretenziju

Skatīt priekšlikumus:

   GET/proposals

Iegūstiet informāciju par konkrētu priekšlikumu:

   GET/proposals/{proposalId}

Iegūstiet informāciju par konkrētu pieprasījumu, par kuru ir iesniegts pārbaudes priekšlikums:

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

Pieņemiet uzdevumu pārbaudīt prasību:

   POST/proposals/{proposalId}/action

Uzskaitiet failus, kas saistīti ar modulāru priekšrocību projektu:

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

Uzskaitiet failus, kas saistīti ar pieprasījumu kontrolpunktiem:

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

Konkrētam līdzeklim pievienota faila skatīšana:

   GET/files/{fileId}

Kad prasība ir pieņemta, tiek izveidots atbilstošs "Apstrādāts pieprasījums". Reģistrējiet savus verifikācijas konstatējumus par apstrādāto prasību. Tas ietver pieprasījuma daudzuma un līdzieguvumu atjaunināšanu. Pirms kredīta izsniegšanas pieprasījuma iesniegšanas jums ir jāatjaunina kredīta ieteikumi arī par apstrādāto prasījumu:

  • Iegūstiet apstrādāto pieprasījuma informāciju, izmantojot GET/processedClaims/{processed_claim_id} un nokopējiet Etag vērtību no atbildes galvenes.
  • Atjauniniet apstrādātos pieprasījuma atribūtus, izmantojot PATCH/processedClaims/API,{processed_claim_id} un galvenē norādiet Etag vērtību atslēgā If-Match.

Katram kontrolpunktam, kuru pārbaudāt, varat atjaunināt savus verifikācijas konstatējumus par atbilstošo apstrādātā pieprasījuma kontrolpunkta rezultātu:

  • Augšupielādējiet un pievienojiet verifikācijas atrašanas atskaites apstrādātā pieprasījuma kontrolpunktu rezultātiem, izmantojot POST/files API, un pieprasījuma pamattekstā norādiet faila vai faila URL, tagu un ResourceUri (tas būs kontrolpunkta rezultāta resursa uri).
  • Atjauniniet ietekmi uz vidi pirms un pēc kontrolpunkta rezultāta atribūtiem (ja nepieciešams):
    • Iegūstiet detalizētu informāciju par kontrolpunkta rezultātu, izmantojot GET/processClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} un nokopējiet Etag vērtību no atbildes galvenes.
    • Atjauniniet kontrolpunkta rezultāta atribūtus, izmantojot PATCH/processedClaims/{processed_claim_Id}/checkpointResults/API,{checkpoint_result_Id} un galvenē norādiet Etag vērtību atslēgā If-Match.
    • Varat arī atjaunināt kontrolpunktu rezultātus, izmantojot ielāpa API apstrādātām pretenzijām.

Kad verifikācija ir pabeigta, apstipriniet vai noraidiet MBPClaimVerify priekšlikumu:

   POST/proposals/{proposalId}/action

Norādiet šādu informāciju:

  • Darbība: apstiprināt vai noraidīt

  • Ziņojums: norādiet komentāru (ja tāds ir) piegādātāja atsaucei.

Kad MBPClaimVerify priekšlikums ir apstiprināts, izveidojiet un iesniedziet CreditMint priekšlikumu kredīta izsniegšanas pieprasījuma iesniegšanai:

   POST/proposals/

Atgriešanas pieprasījuma pieprasījums labojumiem

Ja pieprasījuma pieprasījumā ir dažas nepilnības vai nepareiza informācija, ko validācijas un verifikācijas iestāde vēlas, lai piegādātājs izlabo, varat pieprasīt pieprasījuma labojumus, nevis apstiprināt vai noraidīt pieprasījumu. Šī iespēja ir pieejama tikai, izmantojot API.

  1. Augšupielādējiet un pievienojiet failus (kurus vēlaties kopīgot ar piegādātāju) apstrādātajam pieprasījumam vai apstrādātā pieprasījuma kontrolpunkta rezultātam: POST/faili un pieprasījuma pamattekstā norādiet šādu informāciju

    • Faila vai faila URL
    • Atzīmju
    • Apstrādātās prasības vai apstrādātās pretenzijas kontrolpunkta resursa URI, kurai jāpievieno fails

  2. Pārvietojiet MBPClaimVerify priekšlikumu uz submitterActionNeeded stāvokli, veicot darbību returnForEdits , izmantojot POST/proposals/{proposalId}/action API, un pieprasījuma pamattekstā norādiet šādu informāciju:

    • Darbība: returnForEdits
    • Ziņojums: norādiet komentāru (ja nepieciešams) piegādātāja atsaucei, atgriežot rediģēšanas pieprasījumu.

Atgrieztā priekšlikuma rediģēšana

Pēc tam piegādātāji var skatīt priekšlikumu, kas tika nosūtīts atpakaļ rediģēšanai. Tagad viņi var rediģēt pieprasījuma un kontrolpunkta atribūtus, kā arī augšupielādēt vairāk failu pieprasījuma kontrolpunktos:

  1. Skatīt priekšlikumu: GET/priekšlikumi/{proposalId}

    • Ja nepieciešams, piegādātājs var arī skatīt atbilstošo apstrādāto pieprasījuma informāciju, izmantojot GET/processedClaims/{processed_claim_Id} API.

  2. Augšupielādējiet un pievienojiet failus (ja tādi ir) pieprasījuma kontrolpunktiem: POST/files un pieprasījuma pamattekstā norādiet šādu informāciju

    • Faila vai faila URL
    • Atzīmju
    • Tā kontrolpunkta resursa URI, kuram jāpievieno fails

  3. Atjauniniet pieprasījuma atribūtus, izmantojot PATCH operāciju:

    • Iegūstiet jaunāko informāciju par prasību un atzīmējiet ETag vērtību atbildes galvenē: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Atjauniniet pieprasījuma atribūtus un norādiet Etag vērtību pieprasījuma galvenes atslēgā "Ja-Match": PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Atjauniniet pieprasījuma kontrolpunkta atribūtus, izmantojot PATCH operāciju:

    • Iegūstiet jaunāko informāciju par kontrolpunktu un atzīmējiet ETag vērtību atbildes galvenē: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

    • Atjauniniet pieprasījuma atribūtus un norādiet Etag vērtību pieprasījuma galvenes atslēgā If-Match: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

      Piezīmes

      Norādot atjaunināšanas atribūtus, pārliecinieties, vai JSON pieprasījuma struktūra ievēro tādu pašu struktūru kā atbilstošajā get API izsaukumā.

  5. Pēc tam, kad izmaiņas ir veiktas, piegādātājs var iesniegt priekšlikumu atpakaļ validācijas un verifikācijas iestādei, izmantojot POST/proposals/{proposalId}/action API, un pieprasījuma pamattekstā norādīt šādu informāciju:

    • Darbība: Atkārtota iesniegšana
    • Ziņojums: norādiet visus komentārus (ja nepieciešams) validācijas un verifikācijas iestādes atsaucei.

Pēc priekšlikuma atkārtotas iesniegšanas validācijas un verifikācijas iestāde var pārskatīt priekšlikumu un apstiprināt, noraidīt vai vēlreiz pieprasīt labojumus.

Kredīta izsniegšanas pieprasījuma atsaukšana

Iespēja atsaukt iesniegto kredīta izsniegšanas pieprasījumu (CreditMint)priekšlikums:

Pēc kredīta izsniegšanas priekšlikuma iesniegšanas reģistrā, ja rodas kādas problēmas, kuru dēļ vēlaties atsaukt iesniegto priekšlikumu, varat atsaukt iesniegto priekšlikumu, ja reģistrs nav rīkojies saskaņā ar priekšlikumu. Šī iespēja pašlaik ir pieejama tikai API.

  • Pārvietojiet iesniegtajā stāvoklī esošo CreditMint priekšlikumu uz atsaukto stāvokli, izmantojot POST/proposals/{proposalId}/action API, un pieprasījuma pamattekstā norādiet šādu informāciju:

    • Darbība: Atsaukt
    • Ziņojums: norādiet iemeslu (ja tāds ir) reģistra atsauces priekšlikuma atsaukšanai.

Priekšlikuma statuss tagad ir atsaukts.

Pēc kredīta izsniegšanas pieprasījuma atsaukšanas validācijas un pārbaudes iestāde var mainīt "apstrādāto pieprasījumu" un saistītos kontrolpunktu rezultātus un pēc tam atkārtoti iesniegt kredīta izsniegšanas pieprasījumu.

  • Augšupielādējiet un pievienojiet failus apstrādātā pieprasījuma kontrolpunktu rezultātiem: POST/faili un norādiet šādu informāciju:

    • Fails vai failsURL
    • Atzīmju
    • Saistītā kontrolpunkta rezultāta ResourceURI.

  • Atjauniniet apstrādātās pretenzijas atribūtus: PATCH/processedClaims/{processedClaim_Id}

  • Atkārtoti iesniedziet izdošanas pieprasījumu reģistram un API pieprasījuma pamattekstā norādiet šādu informāciju: POST/proposals/{ proposal_id}/action

    • Darbība: norādiet kā atkārtotu iesniegšanu
    • Ziņojums: norādiet ziņojumu/komentāru (ja tāds ir) reģistra atsaucei

Kredītu izsniegšana

Šajā sadaļā ir parādīts, kā skatīt un izsniegt kredītus, izmantojot API. Lai iegūtu norādījumus par lietotāja saskarnes izmantošanu, dodieties uz sadaļu Kredītu izsniegšana vides kredītu pakalpojumā.

Pārskatīt kredītu izsniegšanas priekšlikumus

Apskatiet iesniegto "Žetonu kaltuves" priekšlikumu un iegūstiet "apstrādātā pieprasījuma" resursa URI, kas ir iesniegts pārskatīšanai:

GET/proposal/{proposalId}

Pārskatiet validācijas un pārbaudes iestādes verifikācijas konstatējumus, apskatot apstrādāto pieprasījumu un saistītos kontrolpunktu rezultātus (kopā ar saistītajiem failiem):

GET/processedClaims/{processedClaims_Id}

Skatiet prasību un atbilstošo kontrolpunkta informāciju (kopā ar failu sarakstu, ko piegādātājs pievienojis kontrolpunktiem):

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

Skatiet detalizētu informāciju par modulāro priekšrocību projektu kopā ar pievienoto failu sarakstu:

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

Lejupielādējiet failu, izmantojot faila ID:

   GET/files/{fileId}

Apstiprināt kredītus

Augšupielādējiet failus, kurus vēlaties pievienot kredītam izsniegšanai: POST/faili un pieprasījuma pamattekstā norādiet šādu informāciju:

  • Faila vai faila URL
  • Atzīmju

Apstiprināt priekšlikumu:

   POST/proposals/{proposalId}/action

Pieprasījuma pamattekstā norādiet šādu informāciju:

  • Darbība: norādiet kā monētu kaltuvi
  • Ziņojums: norādiet ziņojumu (ja tāds ir) validācijas un verificēšanas iestādes atsaucei
  • Failu ID: norādiet augšupielādēto failu ID, lai faili tiktu pievienoti izsniegtajam kredītam
  • Daudzums
  • Senlaicīgs
  • Līdzekļa ID
  • Noteiktā vērtība

Piezīmes

Kad priekšlikums tiks apstiprināts, tiks izveidots atbilstošs kredīts.

Noraidīt priekšlikumu

Augšupielādējiet failus (ja tādi ir) apstrādātajā pretenzijā: POST/faili un norādiet šādu informāciju:

  • Faila vai faila URL
  • Atzīmju

Noraidīt priekšlikumu:

   POST/proposals/{proposalId}/action

Pieprasījuma pamattekstā norādiet šādu informāciju:

  • Darbība: Noraidīt
  • Ziņojums: norādiet ziņojumu (ja tāds ir) validācijas un verifikācijas iestādes atsaucei
  • Failu ID: norādiet augšupielādētā faila ID, lai tie tiktu pievienoti saistītajai apstrādātajai pretenzijai.

Atgriezt kredīta izsniegšanas pieprasījumu labojumiem

Ja izdošanas pieprasījumā ir nepilnības vai nepareiza informācija, kuru vēlaties, lai validācijas un verifikācijas iestāde labotu, varat lūgt izdošanas pieprasījumā veikt labojumus. Šī iespēja ir pieejama tikai, izmantojot API.

  1. Augšupielādējiet failus (ja tādi ir), kurus vēlaties kopīgot ar validācijas un verifikācijas iestādi, nosūtot izdošanas pieprasījumu atpakaļ rediģēšanai.

  2. Pārvietojiet izsniegšanas pieprasījumu (CreditMint priekšlikumu) uz submitterActionNeeded norādiet, izmantojot POST/proposals/{proposalId}/action API, un norādiet šādu informāciju:

    • Darbība: ReturnForEdits
    • Ziņojums: norādiet ziņojumu (ja tāds ir) validācijas un verifikācijas iestādes atsaucei, lai tā varētu saprast rediģēšanas pieprasījuma iemeslu.
    • Failu ID: norādiet augšupielādēto failu ID (ja tādi ir), lai faili tiktu pievienoti saistītajai apstrādātajai prasībai.

Validācijas un verifikācijas iestāde tagad var skatīt priekšlikumu, kas ir nosūtīts atpakaļ rediģēšanai. Tagad viņi var arī rediģēt atbilstošos apstrādātos pieprasījumu un kontrolpunktu rezultātus. Viņi var atjaunināt atribūtus, kā arī augšupielādēt atjauninātus failus kontrolpunktu rezultātos.

Ja nepieciešams, validācijas un verifikācijas iestāde šajā brīdī var pieprasīt paskaidrojumus par pārbaudīto apgalvojumu, atgriežot piegādātājam prasību par labojumiem. Kad piegādātājs atkārtoti iesniedz pieprasījumu, validācijas un pārbaudes iestāde var pārskatīt un verificēt pieprasījumu, atjaunināt atbilstošo apstrādāto pieprasījumu un pēc tam atkārtoti iesniegt izdošanas pieprasījumu reģistram.

  1. Augšupielādējiet un pievienojiet failus kontrolpunktu rezultātiem: POST/files un norādiet šādu informāciju:

    • Faila vai faila URL
    • Atzīmju
    • Saistīto kontrolpunktu rezultātu ResourceURI

  2. Atjauniniet apstrādātā pieprasījuma atribūtus, tostarp kredīta ieteikumu: PATCH/processedClaim/{apstrādāts pieprasījuma ID}

  3. Atkārtoti iesniedziet izdošanas pieprasījumu un API pieprasījuma pamattekstā norādiet tālāk norādīto informāciju: POST/proposals/{ proposal_id}/action

    • Darbība: Atkārtota iesniegšana
    • Ziņojums: ziņojuma (ja tāds ir) norādīšana reģistra atsaucei

Pēc pieprasījuma atkārtotas iesniegšanas izdevēju reģistrs var pārskatīt pieprasījumu un apstiprināt, noraidīt vai vēlreiz pieprasīt labojumus.

Skatīt izsniegtos kredītus

   GET/credits

Kredītu meklēšana un skatīšana

Iegūstiet visus kredītus:

   GET/credits

Piezīmes

Šis API atgriezīs visu kredītu sarakstu. Pēc tam pircēji var paši filtrēt sarakstu, pamatojoties uz kredīta statusu, lai skatītu tikai uzskaitītos kredītus.

Skatiet kredītinformāciju (tostarp par izcelsmi) konkrētam kredītam, kas parādīts sarakstā:

   GET/credits/{creditId}/lineage

Kredītu uzskaite

Šajā sadaļā ir parādīts, kā uzskaitīt kredītus tirdzniecības vietā, izmantojot API. Lai iegūtu norādījumus par lietotāja saskarnes izmantošanu, dodieties uz Saraksta kredīti vides kredītu pakalpojumā.

Reģistrējieties kā pircējs vai tirdzniecības vieta

Iesniedziet MarketplaceTraderRegister priekšlikumu kā kredīta īpašnieks vai pircējs:

   POST/proposals

Iegūstiet un pārskatiet visus MarketplaceTraderRegister priekšlikumus kā tirgu:

   GET/proposals

Apstiprināt vai noraidīt priekšlikumus kā tirdzniecības vietu:

   POST/proposals/{proposalId}/action

Iegūstiet un apskatiet visus tirgotājus, kas reģistrēti viņu platformā kā tirdzniecības vieta:

   GET/marketplaces/{marketplaceId}/traders

Iesniegt priekšlikumu par kredīta iekļaušanu sarakstā

Izveidojiet un iesniedziet MarketplaceListingRegister priekšlikumu:

   POST/proposals

Pārskatiet priekšlikumu par kredīta iekļaušanu sarakstā

   GET/proposals

   POST /proposals/{proposalId}/action

Kredītu pārvaldība

Šajā sadaļā ir parādīts, kā pārvaldīt kredītus, izmantojot API. Norādījumus par lietotāja saskarnes izmantošanu skatiet rakstā Kredītu pārvaldība vides kredītu pakalpojumā.

Kredīta noņemšana no saraksta

Kredīta sadalīšana ir neatkarīga darbība Vides kredītu dienestā. Informāciju par kredīta sadalīšanu, izmantojot API, skatiet rakstā Kredīta sadalīšana. Pēc kredīta sadalīšanas jūs varat turpināt nākamo soli.

Izveidojiet un iesniedziet MarketplaceListingDeregister priekšlikumu:

   POST/proposals

Skatīt visus MarketplaceListingDeregister priekšlikumus, kas iesniegti pārskatīšanai:

   GET/proposals

Lai apstiprinātu vai noraidītu priekšlikumu:

   POST/proposals/{proposalId}/action

Īpašumtiesību nodošana

   POST/credits/{creditId}/transfer/

Skatīt kredītlīniju

Organizācijas ar piegādātāju un reģistra lomām var skatīt kredītlīniju kredītiem, kas tām pieder vai ko tās ir izsniegušas:

   GET/credits/{creditId}/lineage

Kredīta sadalīšana

Jūs varat sadalīt kredītu bērnu kredītos. Šī funkcionalitāte pašlaik ir pieejama tikai, izmantojot API.

Sadaliet kredītu, norādot daudzumus (mtCO2e) vismaz diviem bērnu kredītiem kā kredīta īpašniekam (kredītiem, kas viņiem pieder) vai kā aizdevumu tirgum (kredītiem, kas uzskaitīti viņu platformā):

   POST/credits/{creditId}/split

Pārskaitījumu kredītu saraksts

Tirdzniecības vieta var pārsūtīt kredītu sarakstu no savas platformas uz citu tirgu. Šo nodošanu sauc arī par apgrūtinājumu nodošanu. Tradicionālajā plūsmā piegādātājs uzskaitītu kredītus aizdevumu tirgū, kas palīdzēs ar pieprasījumu, klīringu un norēķiniem. Dažreiz tirdzniecības vieta var nespēt veikt maksājumu klīringu un norēķinus viena pati, un tās veikšana var būt atkarīga no citas platformas. Šajā gadījumā aktīvs ir jāpārvieto uz jauno tirdzniecības vietu, lai pabeigtu darījumu. Šis līdzeklis pašlaik ir pieejams tikai, izmantojot API.

Kā tirdzniecības vietu izveidojiet un iesniedziet MarketplaceListingTransfer priekšlikumu par jūsu platformā norādīto kredītu:

   POST/proposals

Kā apstiprinātāja tirdzniecības vieta skatiet visus MarketplaceListingTransfer priekšlikumus, kas tiem iesniegti pārskatīšanai:

   GET/proposals

Kā apstiprinātājs apstiprina vai noraida priekšlikumu. Ja priekšlikums tiek apstiprināts, tad kredītu apgrūtinājumi tiek pārnesti no sākotnējās tirdzniecības vietas uz apstiprinātāja tirgu:

   POST/proposals/{proposalId}/action

Daļēja apgrūtinājumu nodošana: aizdevumu tirgus var nodot apgrūtinājumus daļējam kredītam, vispirms sadalot kredītu kā neatkarīgu darbību. Lai iegūtu informāciju par to, kā sadalīt kredītu, dodieties uz sadaļu Kredīta sadalīšana. Pēc tam, kad kredīts ir sadalīts, turpiniet ar iepriekš minētajām darbībām, lai nodotu apgrūtinājumus bērnu kredītiem.

Iestatiet emisiju mērķus

Šajā sadaļā ir parādīts, kā iestatīt emisiju samazināšanas mērķus un uzdevumus, izmantojot API.

Emisiju mērķu izveide

   POST/esgs

Skatīt emisiju mērķus

   GET/esgs

Emisiju trase

Šajā sadaļā ir parādīts, kā izsekot emisijām, izmantojot emisiju rādītāju karti, ko iestatījāt, izmantojot API. Norādījumus par lietotāja saskarnes lietošanu skatiet rakstā Emisiju mērķu izsekošana vides kredītu pakalpojumā.

Atskaites punktu izveide konkrētam pārskata periodam

   POST/esgs/{esgScorecardId}/milestones

Iegūstiet visus atskaites punktus:

   GET/esgs/{esgScorecardId}/milestones

Ienest konkrētu atskaites punktu:

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

Faktisko emisiju izsekošana attiecībā pret atskaites punktu

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

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

Kredītu slēgšana

Šajā sadaļā ir parādīts, kā kompensēt liekās emisijas, atsakoties no īpašumā esošiem oglekļa kredītiem, izmantojot API. Lai iegūtu norādījumus par lietotāja saskarnes izmantošanu, dodieties uz sadaļu Pensionēšanās kredīti vides kredītu pakalpojumā.

Iesniedziet kredīta pensijas priekšlikumu

Izveidojiet un iesniedziet ESGEmissionOffset priekšlikumu:

   POST/proposals

Pircēji var arī tieši atteikties no oglekļa kredīta, nenorādot kompensējamās emisijas. Šī funkcionalitāte ir pieejama tikai, izmantojot API.

Izveidojiet un iesniedziet CreditRetire priekšlikumu:

   POST/proposals

Pārskatiet kredīta pensionēšanās priekšlikumu

   GET/proposals

   GET/proposals/{proposalId}

Pievienojiet failu kredītam, kas tiek pārskatīts pensijai:

   POST/files

   POST/proposals/{proposalId}/action

Daļēja kredīta pensionēšanās

Informāciju par kredīta sadalīšanu, izmantojot API, skatiet rakstā Kredīta sadalīšana.

Kad kredīts ir sadalīts, izmantojiet iepriekšējos soļu API, lai veiktu ieskaitu un norakstīšanu.

Failu pārvaldība

Šajā sadaļā ir parādīts, kā pievienot, skatīt un dzēst failus tādiem aktīviem kā projekts, pieprasījums un kredīti, izmantojot API. Norādījumus par lietotāja interfeisa izmantošanu skatiet rakstā Failu pārvaldība vides kredītu pakalpojumā.

Pievienot failus

Izmantojiet POST/files API, lai pievienotu failu līdzeklim. Jums jānorāda šāda informācija:

  • Faila vai faila URI
  • Aktīva resursa URI
  • Aprakstošais tags failam

Skatīt failus

Skatiet līdzekļa failu sarakstu kopā ar faila rekvizītiem, izmantojot līdzekļa detalizētās informācijas API:

Modulārais ieguvumu projekts:

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

Prasības:

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

Pieprasīt kontrolpunktus:

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

Kredīta:

   GET/credits/{creditId}

Lai lejupielādētu failu, izmantojiet faila rekvizītos esošo faila ID:

   GET/files/{fileId}

Dzēst failus

Izmantojiet faila ID, lai izsauktu dzēšanas API:

   DELETE/files/{fileId}

Skatiet arī:

Vides kredītu pakalpojuma pārskats
Vides kredītu pakalpojuma
konfigurēšana Vides kredītu pakalpojuma glosārijs