Přehled reference API pro Službu emisních povolenek
Důležité
Některé nebo všechny tyto funkce jsou k dispozici jako součást vydání verze Preview. Obsah a funkce se mohou změnit. K prostředí sandbox Služby emisních povolenek (Preview) máte přístup ve 30denní zkušební verzi. Chcete-li používat Službu emisních povolenek (Preview) v produkčním prostředí, vyplňte registrační formulář Služby emisních povolenek (Preview).
Tento článek vám pomůže provádět úkoly pomocí rozhraní REST API služby Služby emisních povolenek. Chcete-li zobrazit úplnou referenci rozhraní API, přejděte na Reference rozhraní API Služby emisních povolenek. Soubor Swagger najdete v článku Rozhraní REST API Služby emisních povolenek.
- Registrujte projekty
- Zpracovat reklamace
- Vydat kredity
- Seznam kreditů
- Spravovat kredity
- Stanovte si emisní cíle
- Sledujte emise
- Důchodové kredity
- Správa souborů
Registrace projektů
Tato část ukazuje, jak vytvářet, odesílat a kontrolovat ekologické projekty prostřednictvím rozhraní API. Pokyny k používání uživatelského rozhraní naleznete v části Registrace projektů ve Službě emisních povolenek.
- Vytvořte projekt
- Uložte a odešlete projekt
- Zobrazit projekt
- Schválit nebo odmítnout návrh
- Smazat soubor
- Vrátit návrh na úpravy
- Zaregistrujte další modulární benefitní projekty
- Prohlédněte si modulární projekt benefitů
Vytvořit projekt
Chcete-li nahrát a připojit soubory v době vytváření projektu:
Nahrajte soubory pomocí POST/files. V rozhraní API uveďte následující údaje:
- Soubor nebo adresa URL souboru
- Popisná značka souboru
Vytvořte ekologický projekt a odpovídající modulární projekt výhod a určete fileID, které se vrátí v odpovědi na volání rozhraní API POST/files jako atribut v těle žádosti rozhraní API pro vytvoření projektu: POST/ecoprojects.
Uložení a odeslání projektu
Načtení údajů projektu:
GET/ecoProjects/{ecoProjectId}
Prohlédněte si seznam souborů (a souvisejících metadat) připojených k projektu modulárních výhod:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Stáhněte soubor pomocí fileID, které je k dispozici jako součást metadat souboru:
GET/files/{fileId}
Přidejte soubory do projektu modulárních výhod:
POST/files
V těle požadavku zadejte URI zdroje modulárního projektu výhod.
Odešlete modulární projekt výhod k registraci odesláním návrhu MBPRegister:
POST/proposals
Zobrazení projektu
Načtení všech návrhů:
GET/proposals
Načtení údajů konkrétního návrhu:
GET/proposals/{proposalId}
Načtení údajů konkrétního ekologického projektu:
GET/ecoProjects/{ecoProjectId}
Načtení údajů o konkrétním MBP ke kontrole:
GET/ecoProjects/{ecoProjectId}/mbps/{mbpId}
Získejte seznam souborů (a souvisejících metadat) připojených k projektu modulárních výhod:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Stažení souborů pomocí fileID, které je k dispozici jako součást předchozí odpovědi rozhraní API:
GET/files/{fileId}
Připojte soubor do projektu modulárních výhod:
POST/files
Schválení nebo odmítnutí návrhu
Nahrání souborů (pokud jsou):
POST/files a určete soubor (nebo FileUrl) a údaje značky
Odmítnutí žádosti o registraci:
POST/proposals/{proposalId}/action a v těle žádosti uveďte následující údaje
Akce: Reject
Zpráva: Zadejte komentář (pokud existuje), který chcete uvést pro zamítnutí registrace.
FileIDs: Zadejte ID souborů, které byly nahrány.
Odstranění souboru
Zobrazení seznamu souborů připojených k projektu modulárních výhod:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Identifikujte soubor, který jste nahráli, protože uživatel může smazat pouze ty soubory, které nahrál.
Odstranění souboru:
DELETE/files/{fileId}
Vrácení návrhu k úpravám
Pokud jsou v atributech projektu nebo souborech nějaké mezery nebo nesprávné údaje, které chcete, aby dodavatel opravil nebo přidal, můžete požádat o úpravy projektu.
Nahrajte soubory, pokud existují, které musí být sdíleny s dodavatelem:
POST/files
Přesuňte návrh MBPRegister do stavu submitterActionNeeded provedením akce returnForEdits pomocí rozhraní API POST/proposals/{proposalId}/action API a do těla požadavku zadejte následující údaje:
Akce: returnForEdits
Zpráva: Zadejte komentář (je-li vyžadován) pro referenci dodavatele při vracení požadavku na úpravy.
ID souborů: Sem zadejte ID souboru nahraného souboru pro připojení souboru k příslušnému projektu modulárních výhod.
Poté se projekt modulárních výhod přesune do stavu returnedForEdits.
Dodavatelé nyní mohou zobrazit nabídku, která byla odeslána zpět k úpravám. Nyní mohou upravovat atributy projektu modulárních výhod a nahrávat další soubory do projektu modulárních výhod.
Zobrazení návrhu: GET/proposals/{proposalId}
Nahrání a připojení souborů k projektu modulárních výhod: POST/files a v těle žádosti zadejte následující údaje:
- Soubor nebo adresa URL souboru
- Značka: Popisná značka souboru
- ResourceURI: Zadejte URI zdroje příslušného projektu modulárních výhod.
Aktualizace atributů projektu modulárních výhod
- Získejte aktualizované údaje o projektu modulárních výhod pomocí GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} a zkopírujte hodnotu Etag z hlavičky odpovědi.
- Aktualizujte atributy projektu modulárních výhod pomocí rozhraní API PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} a zadejte hodnotu Etag v klíči If-Match v záhlaví.
Po dokončení změn může nyní dodavatel odeslat návrh zpět do registru pomocí rozhraní API POST/proposals/{proposalId}/action a uvést v požadavku následující údaje:
Akce: Submit
Zpráva: Zadejte komentář (pokud existuje) pro odkaz na registr.
Registrace dalších projektů modulárních výhod
Předložte ekologický přínos k registraci do vydávajícího registru vytvořením a odesláním návrhu na registraci MBPR:
POST/proposal
Kontrola projektu modulárních výhod
Zobrazení údajů návrhu:
GET/proposals/{proposalId}
Zobrazení všech údajů projektu:
GET/ecoProjects/{ecoProjectId}
Zobrazení údajů jednotlivého projektu modulárních výhod projektu:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Schválení nebo zamítnutí návrhu registrace nebo jeho vrácení k úpravám:
POST/proposals/{proposalId}/action
Zpracování nároků
Tato část ukazuje, jak zpracovávat nároky prostřednictvím rozhraní API. Pokyny k používání uživatelského rozhraní naleznete v části Zpracování nároků ve Službě emisních povolenek.
- Vytvářejte nároky
- Odešlete nároky
- Ověřte nárok
- Vraťte žádost o nárok na úpravy
- Upravte vrácený návrh
- Stáhněte žádost o vydání kreditu
Vytváření nároků
Vytvoření nároku:
POST/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims
Nahrajte a připojte soubory ke kontrolním bodům nároků:
POST/files
Do požadavky zadejte následující údaje:
- Soubor nebo adresa URL souboru
- Značka (tag)
- URI prostředku nároku
Odesílání nároků
Vytvoření a odeslání návrhu projectClaimVerify modulárních výhod:
POST/proposals
Zobrazení údajů odeslaného návrhu:
GET/proposal/{proposalId}
Zobrazení údajů nároku:
POST/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Ověření nároku
Zobrazení návrhů:
GET/proposals
Načtení údajů konkrétního návrhu:
GET/proposals/{proposalId}
Načtení údajů o konkrétním nároku, pro který byl odeslán návrh na ověření:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Přijetí úkolu ověření nároku:
POST/proposals/{proposalId}/action
Zobrazení seznamu souborů spojené s projektem modulárních výhod:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Zobrazení seznamu souborů spojených s kontrolními body nároku:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpclaims/{claimId}/checkpoints
Zobrazení souboru připojeného ke konkrétnímu prostředku:
GET/files/{fileId}
Jakmile je nárok přijat, vytvoří se odpovídající „Zpracovaný nárok“. Zaznamenejte svá zjištění ověřující zpracovaný nárok. Patří sem aktualizace množství, spoluvýhody nároku. Před odesláním žádosti o vydání úvěru musíte aktualizovat úvěrová doporučení také u zpracovaného nároku:
- Získejte podrobnosti o zpracovaném nároku pomocí akce GET/processedClaims/{processed_claim_id} a zkopírujte hodnotu Etag z hlavičky odpovědi.
- Aktualizujte atributy zpracovaného nároku pomocí rozhraní API PATCH/processedClaims/{processed_claim_id} a zadejte hodnotu Etag v klíči If-Match v záhlaví.
U každého kontrolního bodu, který ověříte, můžete aktualizovat svá zjištění ověření o odpovídající výsledek kontrolního bodu zpracovaného nároku:
- Nahrajte a připojte své ověřovací zprávy k výsledkům kontrolního bodu zpracovaného nároku pomocí rozhraní API POST/files a v těle požadavku zadejte URL File nebo file, Tag a ResourceUri (toto bude URI zdroje výsledku kontrolního bodu).
- Aktualizujte atributy vlivu prostředí před a po výsledku kontrolního bodu (je-li požadováno):
- Získejte podrobnosti výsledku kontrolního bodu pomocí akce GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} a zkopírujte hodnotu Etag z hlavičky odpovědi.
- Aktualizujte atributy výsledků kontrolního bodu pomocí rozhraní API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} a zadejte hodnotu Etag v klíči If-Match v záhlaví.
- Výsledky kontrolních bodů můžete také aktualizovat pomocí opravného rozhraní API pro zpracované nároky.
Po dokončení ověření schvalte nebo odmítněte návrh MBPClaimVerify:
POST/proposals/{proposalId}/action
Zadejte následující podrobnosti:
Akce: Approve nebo Reject
Zpráva: Zadejte komentář (pokud existuje) pro referenci dodavatele.
Jakmile bude návrh MBPClaimVerify schválen, vytvořte a odešlete návrh CreditMint k odeslání žádosti o vydání kreditu:
POST/proposals/
Vrácení žádosti o nárok k úpravám
Pokud jsou v požadavku na nároku nějaké mezery nebo nesprávné údaje, které má dodavatel podle validačního a ověřovacího orgánu opravit, můžete požádat o úpravy žádosti o nárok namísto schválení nebo odmítnutí požadavku. Tato funkce je k dispozici pouze přes rozhraní API.
Nahrajte a připojte soubory (které chcete sdílet s dodavatelem) ke zpracované reklamaci nebo k výsledku kontrolního bodu zpracovaného nároku: POST/files a v těle žádosti zadejte následující podrobnosti
- Soubor nebo adresa URL souboru
- Značka (tag)
- Identifikátor URI zdroje zpracovaného nároku nebo výsledek kontrolního bodu zpracovaného nároku, ke kterému musí být soubor přidán
Přesuňte návrh MBPClaimVerify do stavu submitterActionNeeded provedením akce returnForEdits pomocí rozhraní API POST/proposals/{proposalId}/action API a do těla požadavku zadejte následující údaje:
- Akce: returnForEdits
- Zpráva: Zadejte komentář (je-li vyžadován) pro referenci dodavatele při vracení požadavku na úpravy.
Úprava vráceného návrhu
Dodavatelé pak mohou zobrazit nabídku, která byla odeslána zpět k úpravám. Nyní mohou upravovat atributy nároků a kontrolních bodů a mohou nahrávat další soubory do kontrolních bodů nároků:
Zobrazení návrhu: GET/proposals/{proposalId}
- V případě potřeby může dodavatel také zobrazit odpovídající podrobnosti zpracovaného nároku pomocí API GET/processedClaims/{processed_claim_Id}.
Nahrání a připojení souborů (pokud jsou) ke kontrolním bodům nároku: POST/files a v těle žádosti zadejte následující údaje
- Soubor nebo adresa URL souboru
- Značka (tag)
- Identifikátor URI prostředku kontrolního bodu, do kterého musí být soubor přidán
Aktualizace atributů nároku pomocí operace PATCH:
- Načtěte nejnovější údaje nároku a poznamenejte si hodnotu ETag v záhlaví odpovědi: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
- Aktualizujte atributy nároku a zadejte hodnotu Etag v klíči „If-Match“ v záhlaví požadavku: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
Aktualizujte atributy kontrolního bodu nároku pomocí operace PATCH:
Načtěte nejnovější údaje kontrolního bodu a poznamenejte si hodnotu ETag v záhlaví odpovědi: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}
Aktualizujte atributy nároku a zadejte hodnotu Etag v klíči If-Match v záhlaví požadavku: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}
Poznámka:
Při zadávání atributů aktualizace se ujistěte, že tělo požadavku JSON má stejnou strukturu jako v odpovídajícím volání API get.
Po provedení úpravu může pak dodavatel odeslat návrh zpět do těla validace a ověření pomocí rozhraní API POST/proposals/{proposalId}/action a uvést v těle požadavku následující údaje:
- Akce: Resubmit
- Zpráva: Uveďte libovolný komentář (pokud je vyžadován) pro odkaz na orgán verifikace a ověření.
Po opětovném odeslání návrhu může validační a ověřovací orgán návrh zkontrolovat a schválit, odmítnout nebo znovu požádat o úpravy.
Stažení žádosti o vydání kreditu
Možnost stáhnout předložený návrh žádosti o vydání kreditu (CreditMint):
Po podání návrhu na vydání kreditu do registru v případě jakýchkoli problémů, kvůli kterým chcete podaný návrh stáhnout, můžete podaný návrh stáhnout, pokud registr podle návrhu nejednal. Tato funkce je momentálně k dispozici pouze přes rozhraní API.
Přesuňte návrh CreditMint, který je v odeslaném stavu, do staženého stavu pomocí rozhraní API POST/proposals/{proposalId}/action a v těle požadavku uveďte následující údaje:
- Akce: Withdraw
- Zpráva: Uveďte důvod (pokud existuje) pro stažení návrhu na odkaz na registr.
Stav návrhu je nyní Staženo.
Poté, co je žádost o vydání kreditu stažena, může validační a ověřovací orgán upravit „zpracovaný nárok“ a související výsledky kontrolních bodů a poté žádost o vydání kreditu znovu odeslat.
Nahrání a připojení souborů k výsledkům kontrolního bodu zpracovaného nároku: POST/files a zadejte následující údaje:
- Soubor nebo FileURL
- Značka (tag)
- ResourceURI přidruženého výsledku kontrolního bodu.
Aktualizace atributů zpracovaného nároku: PATCH/processedClaims/{processedClaim_Id}
Znovu odešlete žádost o vydání do registru a v těle žádosti API uveďte následující údaje: POST/proposals/{ proposal_id}/action
- Akce: Zadejte jako Resubmit
- Zpráva: Zadejte zprávu/komentář (pokud existuje) pro odkaz na registr
Vydávání kreditů
Tato část ukazuje, jak prohlížet a vydávat kredity prostřednictvím rozhraní API. Pokyny k používání uživatelského rozhraní naleznete v části Vydávání kreditů ve Službě emisních povolenek.
- Zkontrolujte návrhy
- Schválit kredity
- Odmítnout návrh
- Vrácení žádosti o vydání kreditu pro úpravy
- Zobrazit vydané kredity
- Vyhledávejte a zobrazujte titulky
Revize návrhy na vydání kreditů
Prohlédněte si odeslaný návrh „Token mint“ a získejte URI zdroje „zpracovaného nároku“, který byl odeslán ke kontrole:
GET/proposal/{proposalId}
Zkontrolujte nálezy validačního a ověřovacího orgánu zobrazením zpracovaného nároku a souvisejících výsledků kontrolních bodů (spolu s přidruženými soubory):
GET/processedClaims/{processedClaims_Id}
Zobrazení nároků a odpovídajících údajů kontrolních bodů (spolu se seznamem souborů přiložených dodavatelem pro kontrolní body):
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}/mbpClaims/{mbpClaimId}
Zobrazení údajů projektu modulárních výhod spolu se seznamem připojených souborů:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Stažení souboru pomocí ID souboru:
GET/files/{fileId}
Schválení kreditů
Nahrajte soubory, které chcete připojit ke kreditu k vydání: POST/files a v těle žádosti zadejte následující údaje:
- Soubor nebo adresa URL souboru
- Značka (tag)
Žádost schvalte:
POST/proposals/{proposalId}/action
Do těla žádosti zadejte následující údaje:
- Akce: zadejte jako Mint
- Zpráva: Zadejte zprávu (pokud je vyžadována) pro odkaz na orgán verifikace a ověření
- ID souborů: Zadejte ID souborů nahraných souborů, aby byly soubory připojeny k vydanému kreditu
- Množství
- Starý
- ID prostředku
- Určená hodnota
Poznámka:
Po schválení návrhu bude vytvořen odpovídající kredit.
Zamítnutí návrhu
Nahrajte soubory (pokud jsou) ke zpracovanému nároku: POST/files a zadejte následující údaje:
- Soubor nebo adresa URL souboru
- Značka (tag)
Návrh zamítněte:
POST/proposals/{proposalId}/action
Do těla žádosti zadejte následující údaje:
- Akce: Reject
- Zpráva: Zadejte zprávu (pokud je vyžadována) pro odkaz na orgán verifikace a ověření
- ID souborů: Sem zadejte ID nahraných souborů pro připojení souboru k příslušnému zpracovanému nároku.
Vrácení žádosti o vydání kreditu k úpravám
Pokud jsou v požadavku na vydání nějaké mezery nebo nesprávné údaje, které chcete, aby validační nebo ověřovací orgán opravil, můžete požádat o úpravy žádosti o vydání. Tato funkce je k dispozici pouze přes rozhraní API.
Nahrajte soubory (pokud existují), které chcete sdílet s validačním a ověřovacím orgánem jako součást odeslání žádosti o vydání zpět k úpravám.
Přesuňte požadavek na vydání (návrh CreditMint) do stavu submitterActionNeeded pomocí rozhraní API POST/proposals/{proposalId}/action a uveďte následující údaje:
- Akce: ReturnForEdits
- Zpráva: Zadejte zprávu (pokud existuje) pro ověření a odkaz na tělo ověření, aby pochopili důvod požadavku na úpravu.
- ID souborů: Sem zadejte ID nahraných souborů (pokud jsou) pro připojení souboru k příslušnému zpracovanému nároku.
Validační a ověřovací orgán nyní může zobrazit návrh, kterých byl odeslán zpět k úpravám. Nyní mohou také upravovat odpovídající zpracovaný nárok a výsledky kontrolních bodů. Mohou aktualizovat atributy a také nahrávat aktualizované soubory do výsledků kontrolních bodů.
Je-li to požadováno, může validační a ověřovací orgán v tomto bodě požádat o vysvětlení k ověřenému nároku vrácením nároku k úpravě dodavateli. Jakmile dodavatel znovu odešle nárok, může validační a ověřovací orgán nárok přezkoumat a ověřit, aktualizovat odpovídající zpracovaný nárok a poté znovu odeslat žádost o vydání do registru.
Nahrání a připojení souborů k výsledkům kontrolního bodu: POST/files a zadejte následující údaje:
- Soubor nebo adresa URL souboru
- Značka (tag)
- ResourceURI přidružených výsledků kontrolního bodu
Aktualizujte atributy zpracovaného nároku včetně kreditního doporučení: PATCH/processedClaim/{ID zpracovaného nároku}
Znovu odešlete žádost o vydání a v těle žádosti API uveďte následující údaje: POST/proposals/{ proposal_id}/action
- Akce: Resubmit
- Zpráva: Zadejte zprávu (pokud existuje) pro odkaz na registr
Po opětovném odeslání požadavku může vydávající registr požadavek zkontrolovat a schválit, odmítnout nebo znovu požádat o úpravy.
Zobrazení vydaných kreditů
GET/credits
Vyhledávání a zobrazování kreditů
Načtení všech kreditů:
GET/credits
Poznámka:
Toto rozhraní API vrátí seznam všech kreditů. Kupující pak mohou seznam filtrovat sami na základě stavu kreditu a prohlížet si pouze uvedené kredity.
Zobrazte podrobnosti o kreditu (včetně rodokmenu) pro konkrétní kredit zobrazený v seznamu:
GET/credits/{creditId}/lineage
Vystavení kreditů
Tato část ukazuje, jak vystavit kredity na tržišti pro obchodování prostřednictvím rozhraní API. Pokyny k používání uživatelského rozhraní naleznete v části Vystavení kreditů ve Službě emisních povolenek.
- Zaregistrujte se jako kupující na tržišti
- Odeslat návrh na vypsání kreditu
- Zkontrolujte návrh na výpis kreditu
Registrace jako kupujícího na tržišti
Odešlete návrh MarketplaceTraderRegister jako vlastník kreditu nebo kupující:
POST/proposals
Načtěte a zkontrolujte všechny návrhy MarketplaceTraderRegister jako tržiště:
GET/proposals
Schvalte nebo zamítněte návrhy jako tržiště:
POST/proposals/{proposalId}/action
Načtěte a zobrazte všechny obchodníky registrované na jejich platformě jako tržiště:
GET/marketplaces/{marketplaceId}/traders
Odeslání návrhu k vystavení kreditu
Vytvořte a odešlete návrh MarketplaceListingRegister:
POST/proposals
Kontrola návrhu k vystavení kreditu
GET/proposals
POST /proposals/{proposalId}/action
Správa kreditů
Tato část ukazuje, jak spravovat kredity prostřednictvím rozhraní API. Pokyny k používání uživatelského rozhraní naleznete v části Správa kreditů ve Službě emisních povolenek.
- Odstraňte kredit
- Převést vlastnictví
- Zobrazit úvěrovou řadu
- Rozdělit kredit
- Výpis převodních kreditů
Zrušení vystavení kreditu
Rozdělení kreditu je nezávislá operace ve Službě emisních povolenek. Informace o rozdělení kreditu prostřednictvím rozhraní API naleznete v části Rozdělení kreditu. Po rozdělení kreditu můžete pokračovat dalším krokem.
Vytvořte a odešlete návrh MarketplaceListingDeregister:
POST/proposals
Zobrazte všechny návrhy MarketplaceListingDeregister odeslané ke kontrole:
GET/proposals
Schválení nebo zamítnutí návrhu:
POST/proposals/{proposalId}/action
Převedení vlastnictví
POST/credits/{creditId}/transfer/
Zobrazení rodokmenu kreditu
Organizace s rolemi dodavatelů a registrů mohou zobrazit rodokmen kreditu pro kredity, které vlastní nebo vydaly:
GET/credits/{creditId}/lineage
Rozdělení kreditu
Kredit můžete rozdělit na podřízené kredity. Tato funkce je v současnosti dostupná jen prostřednictvím rozhraní API.
Rozdělte kredit zadáním množství (v mtCO2e) pro alespoň dva podřízené kredity jako vlastník kreditu (u kreditů, které vlastní) nebo jako tržiště (u kreditů uvedených na jejich platformě):
POST/credits/{creditId}/split
Převedení vystavení kreditu
Tržiště může převést vystavení kreditů ze své platformy na jiné tržiště. Tento převod se také nazývá převod věcného břemene. V tradičním toku by dodavatel uvedl kredity na tržišti, které pomůže s poptávkou, zúčtováním a vypořádáním. Někdy tržiště nemusí být schopno provést zúčtování a vypořádání plateb samo a může záviset na jiné platformě, aby je provedla. V tomto případě musí být aktivum převedeno na nové tržiště, aby byla transakce dokončena. Tato funkce je v současnosti dostupná jen prostřednictvím rozhraní API.
Jako tržiště vytvořte a odešlete návrh MarketplaceListingTransfer pro kredit uvedený na vaší platformě:
POST/proposals
Jako schvalovatelské tržiště si prohlédněte všechny návrhy MarketplaceListingTransfer, které mu byly předloženy ke kontrole:
GET/proposals
Jak tržiště schvalovatele schvalte nebo zamítněte návrh. Pokud je návrh schválen, věcné břemeno kreditů se přenese z původního tržiště na tržiště schvalovatele:
POST/proposals/{proposalId}/action
Částečný převod věcného břemene: Tržiště může převést věcné břemeno pro částečný kredit tak, že nejprve rozdělí úvěr jako nezávislou akci. Informace o rozdělení kreditu naleznete v části Rozdělení kreditu. Po rozdělení kreditu pokračujte výše uvedenými kroky pro převod věcného břemene pro podřízené kredity.
Stanovení emisních cílů
Tato část ukazuje, jak nastavit cíle a cíle snížení emisí prostřednictvím rozhraní API.
Vytváření emisních cílů
POST/esgs
Zobrazení emisních cílů
GET/esgs
Sledování emisí
V této části se dozvíte, jak sledovat své emise podle přehledu emisí, který jste nastavili prostřednictvím rozhraní API. Pokyny k používání uživatelského rozhraní naleznete v části Sledování emisních cílů ve Službě emisních povolenek.
Vytváření milníků pro konkrétní období vykazování
POST/esgs/{esgScorecardId}/milestones
Načtení všech milníků:
GET/esgs/{esgScorecardId}/milestones
Načtení konkrétního milníku:
GET/esgs/{esgScorecardId}/milestones/{esgMilestoneId}
Sledování skutečných emisí vůči milníku
POST/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}/emissions
GET/esgs/{esgScorecardId}/milestones/{esgMilestoneId}/reportingPeriods/{esgReportingPeriodId}
Rušení kreditů
Tato část ukazuje, jak kompenzovat nadměrné emise vyřazením vlastněných uhlíkových kreditů prostřednictvím rozhraní API. Pokyny k používání uživatelského rozhraní naleznete v části Vyřazení kreditů ve Službě emisních povolenek.
Odeslání návrhu na vyřazení kreditu
Vytvoření a odeslání návrhu ESGEmissionOffset:
POST/proposals
Kupující také mohou uhlíkový kredit stáhnout přímo, aniž by specifikovali emise, které mají být kompenzovány. Tato funkce je dostupná pouze prostřednictvím rozhraní API.
Vytvoření a odeslání návrhu CreditRetire:
POST/proposals
Kontrola návrhu na vyřazení kreditu
GET/proposals
GET/proposals/{proposalId}
Připojte soubor ke kreditu, který je posuzován pro vyřazení:
POST/files
POST/proposals/{proposalId}/action
Částečné vyřazení kreditu
Informace o rozdělení kreditu prostřednictvím rozhraní API naleznete v části Rozdělení kreditu.
Po rozdělení kreditu použijte rozhraní API v předchozích krocích pro kompenzaci a vyřazení.
Správa souborů
Tato část ukazuje, jak připojit, zobrazit a odstranit soubory pro aktiva, jako je projekt, nárok a kredity, prostřednictvím rozhraní API. Pokyny k používání uživatelského rozhraní naleznete v části Správa souborů ve Službě emisních povolenek.
Připojit soubory
K připojení souboru k aktivu použijte rozhraní API POST/files. Musíte zadat následující údaje:
- Soubor nebo adresa URI souboru
- URI prostředku aktiva
- Popisná značka souboru
Prohlížení souborů
Zobrazení seznamu souborů spolu s vlastnostmi souboru pro aktivum pomocí rozhraní API údajů aktiva:
Projekt modulárních výhod:
GET/ecoprojects/{ecoProjectId}/mbps/{mbpId}
Nároky:
GET/ecoprojects/{ecoProjectId}/mbps/{modular benefit projectId}/mbpClaims/{mbpClaimId}
Kontrolní body nároků:
GET/ecoprojects/{ecoProjectId}/modular benefit projects/{mbpId}/mbpClaims/{mbpClaimId}/checkpoints
Kredit:
GET/credits/{creditId}
Ke stažení souboru použijte ID souboru uvedené ve vlastnostech souboru:
GET/files/{fileId}
Odstranit soubory
K volání rozhraní API pro odstranění použijte ID souboru:
DELETE/files/{fileId}
Související informace
Přehled environmentální kreditní služby
Konfigurace environmentální kreditní služby
glosář environmentální kreditní služby