Udostępnij za pośrednictwem

Omówienie odwołania do interfejsu API dla Usługi kredytowania na cele ekologiczne

  • Artykuł

Bezpłatny okres próbny

Ważne

Niektóre lub wszystkie te funkcje są dostępne w wersji zapoznawczej. Zawartość i funkcjonalność mogą ulec zmianie. 30-dniowa wersja próbna umożliwia dostęp do środowiska piaskownicy Usługi kredytowania na cele ekologiczne (wersja zapoznawcza). Aby używać usługi kredytowania na cele ekologiczne (wersja zapoznawcza) w środowisku produkcyjnym, wypełnij formularza tworzenia konta Usługi kredytowania na cele ekologiczne (wersja zapoznawcza).

Ten artykuł ułatwia wykonywanie zadań przy użyciu interfejsów API REST usługi kredytowania na cele ekologiczne. Aby zobaczyć pełne odniesienie do API, przejdź na stronę Odnośnik API: Usługa kredytowania na cele ekologiczne. Plik swagger znajdziesz tutaj: REST API: Usługa kredytowania na cele ekologiczne.

Rejestrowanie projektów

W tej części pokazano, jak tworzyć, przesyłać i przeglądać projekty ekologiczne za pomocą interfejsów API. Instrukcje dotyczące korzystania z interfejsu użytkownika znajdziesz na stronie Rejestrowanie projektów w Usłudze kredytowania na cele ekologiczne.

Tworzenie projektu

Przesyłanie i dołączanie plików w czasie tworzenia projektu:

  1. Prześlij pliki za pomocą polecenia POST/files. Określ następujące szczegóły w interfejsie API:

    • Plik lub adres URL pliku
    • Znacznik opisowy dla pliku

  2. Utwórz projekt ekologiczny i odpowiadający mu projekt korzyści modułowych oraz określ identyfikator pliku, który zostanie zwrócony w odpowiedzi na wywołanie POST/files API, jako atrybut w treści żądania API utworzenia projektu: POST/ecoprojects.

Zapisz i prześlij projekt

Pobierz szczegóły dotyczące projektu:

   GET/ecoProjects/{ecoProjectId}

Wyświetl listę plików (i ich metadanych) dołączonych do projektu korzyści modułowych:

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

Pobierz plik, używając identyfikatora fileID, który jest dostępny jako część metadanych pliku:

   GET/files/{fileId}

Dodaj pliki do projektu korzyści modułowych:

   POST/files

W treści żądania podaj URI zasobów projektu korzyści modułowych.

Zgłoś projekt korzyści modułowych do rejestracji, składając propozycję MBPRegister:

   POST/proposals

Wyświetlanie projektu

Pobierz wszystkie propozycje:

   GET/proposals

Pobierz szczegóły dotyczące konkretnej propozycji:

   GET/proposals/{proposalId}

Pobierz szczegóły dotyczące konkretnego projektu ekologicznego:

   GET/ecoProjects/{ecoProjectId}

Pobierz szczegóły dotyczące konkretnego MBP, który chcesz przejrzeć:

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

Pobierz listę plików (i skojarzone z nimi metadane) dołączone do modułowego projektu korzyści:

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

Pobierz pliki, używając identyfikatora fileId, który jest dostępny jako część poprzedniej odpowiedzi API:

   GET/files/{fileId}

Dołącz plik do projektu korzyści modułowych:

   POST/files

Zatwierdzanie lub odrzucanie propozycji

Przekazywanie plików do usługi (jeśli takie są):

POST/files i określ plik (lub FileUrl) oraz szczegóły dotyczące znaczników

Odrzuć żądanie rejestracji:

POST/proposals/{proposalId}/action i podaj w treści żądania następujące informacje

  • Akcja: Odrzuć

  • Komunikat: Określ komentarz (jeśli chcesz), który ma być podany przy odrzucaniu rejestracji.

  • FileIDs: Określ identyfikatory plików, które zostały przesłane.

Usuwanie pliku

Wyświetl listę plików, które są dołączone do projektu korzyści modułowych:

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

Zidentyfikuj plik, który przesłałeś, ponieważ użytkownik może usunąć tylko te pliki, które sam przesłał.

Usuń plik:

   DELETE/files/{fileId}

Zwracanie propozycji do edycji

Jeśli w atrybutach lub plikach projektu są jakieś braki lub błędne dane, które chcesz, aby dostawca poprawił lub dodał, możesz poprosić o edycję projektu.

  1. Prześlij pliki, jeśli są, które muszą być udostępnione dostawcy:

    POST/files

  2. Przenieś propozycję MBPRegister do stanu submitterActionNeeded, wykonując API returnForEdits action using the POST/proposals/{proposalId}/action i podaj następujące informacje w treści żądania:

    • Akcja: returnForEdits

    • Komunikat: Określ komentarz (jeśli jest wymagany) dla dostawcy podczas odsyłania prośby o edycję.

    • Identyfikatory plików: Podaj identyfikator przesłanego pliku, aby dołączyć go do danego projektu korzyści modułowych.

    Po wykonaniu tych czynności projekt korzyści modułowych przechodzi do stanu returnedForEdits.

Dostawcy mogą teraz zobaczyć propozycję, która została odesłana do edycji. Mogą teraz edytować atrybuty projektu korzyści modułowych i przesyłać więcej plików do projektu korzyści modułowych.

  • Wyświetlanie propozycji: GET/proposals/{proposalId}

  • Prześlij i dołącz pliki do projektu korzyści modułowych: POST/pliki i podaj następujące szczegóły w treści żądania:

    • Plik lub adres URL pliku
    • Znacznik: Opisowy znacznik pliku
    • ResourceURI: Określ URI zasobu danego projektu korzyści modułowych.

  • Aktualizuj atrybuty projektu korzyści modułowych

    • Pobierz zaktualizowane szczegóły projektu korzyści modułowych za pomocą polecenia GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} i skopiuj wartość Etag z nagłówka odpowiedzi.
    • Zaktualizuj atrybuty projektu korzyści przy użyciu PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} API i określ wartość atrybutu Etag w kluczu dopasowania w nagłówku.

Po zakończeniu zmian dostawca może teraz przesłać propozycję z powrotem do rejestru, używając interfejsu API POST/proposals/{proposalId}/action i podając w żądaniu następujące szczegóły:

  • Akcja: Prześlij

  • Komunikat: Określ komentarz (jeśli chcesz) dla odniesienia do rejestru.

Rejestrowanie dodatkowych projektów korzyści modułowych

Zgłoś świadczenie ekologiczne do rejestracji w rejestrze wydającym, tworząc i składając wniosek MBPRegister:

   POST/proposal

Przegląd projektu korzyści modułowych

Zobacz szczegóły propozycji:

   GET/proposals/{proposalId}

Zobacz wszystkie szczegóły projektu:

   GET/ecoProjects/{ecoProjectId}

Wyświetl szczegóły dotyczące indywidualnego projektu korzyści modułowych projektu:

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

Zatwierdź lub odrzuć propozycję rejestracji albo zwróć ją do edycji:

   POST/proposals/{proposalId}/action

Rozpatrywanie oświadczeń

Ta sekcja pokazuje, jak rozpatrywać oświadczenia za pomocą interfejsów API. Instrukcje dotyczące korzystania z interfejsu użytkownika znajdziesz na stronie Rozpatrywanie oświadczeń w Usłudze kredytowania na cele ekologiczne.

Tworzenie oświadczenia

Tworzenie oświadczenia:

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

Przesyłanie i dołączanie plików do punktów kontrolnych oświadczeń:

   POST/files

W żądaniu podaj następujące informacje:

  • Plik lub adres URL pliku
  • Tag
  • URI zasobu oświadczenia

Przesyłanie oświadczenia

Utwórz i prześlij propozycję projektu świadczeń modułowych ClaimVerify:

   POST/proposals

Zobacz szczegóły zgłoszonej propozycji:

   GET/proposal/{proposalId}

Wyświetl szczegóły dotyczące oświadczenia:

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

Sprawdzanie oświadczenia

Wyświetl propozycje:

   GET/proposals

Pobierz szczegóły dotyczące konkretnej propozycji:

   GET/proposals/{proposalId}

Pobierz szczegóły dotyczące konkretnego oświadczenia, dla którego została złożona propozycja weryfikacji:

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

Przyjmij zadanie zweryfikowania oświadczenia:

   POST/proposals/{proposalId}/action

Lista plików związanych z projektem korzyści modułowych:

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

Lista plików związanych z punktami kontrolnymi oświadczeń:

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

Wyświetlenie pliku dołączonego do określonego zasobu:

   GET/files/{fileId}

Po zaakceptowaniu oświadczenia tworzone jest odpowiednie „Przetworzone oświadczenie”. Należy zarejestrować ustalenia weryfikacyjne dotyczące przetworzonego oświadczenia. Obejmuje to aktualizowanie ilości and korzyści z oświadczenia. Przed przesłaniem żądania wydania środków należy zaktualizować rekomendacje dotyczące kredytu również dla przetwarzanego oświadczenia:

  • Pobierz przetwarzane szczegóły oświadczenia, używając polecenia GET/processedClaims/{processed_claim_id} i skopiuj wartość Etag z nagłówka odpowiedzi.
  • Zaktualizuj atrybuty przetworzonego oświadczenia przy użyciu interfejsu API PATCH/processedClaims/{processed_claim_id} i określ wartość atrybutu Etag w kluczu dopasowania w nagłówku.

Dla każdego weryfikowania punktu kontrolnego można zaktualizować ustalenia weryfikacyjne dotyczące odpowiadającego mu wyniku przetworzonego oświadczenia:

  • Przekaż i dołącz raporty weryfikacyjne do wyników wyszukiwania punktów kontrolnych przetwarzanego oświadczenia za pomocą interfejsu API POST/files i określ plik lub adres URL, tag i ResourceUri pliku (będzie to kod uri zasobu w wyniku punktu kontrolnego) w treści żądania.
  • Zaktualizuj efekt środowiskowy przed i po atrybutach wyniku punktu kontrolnego (jeśli jest to wymagane):
    • Pobierz szczegóły wyniku punktu kontrolnego, używając polecenia GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} i skopiuj wartość Etag z nagłówka odpowiedzi.
    • Zaktualizuj atrybuty wyniku punktu kontrolnego przy użyciu interfejsu API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} i określ wartość atrybutu Etag w kluczu dopasowania w nagłówku.
    • Można również aktualizować wyniki punktów kontrolnych, używając interfejsu API poprawek w przypadku przetwarzanych oświadczeń.

Po zakończeniu weryfikacji należy zatwierdzić lub odrzucić propozycję MBPClaimVerify:

   POST/proposals/{proposalId}/action

Określ następujące informacje szczegółowe:

  • Akcja: Zatwierdź lub odrzuć

  • Komunikat: Określ komentarz (jeśli chcesz) dla odniesienia do rejestru dostawcy.

Po zatwierdzeniu propozycji MBPClaimVerify można utworzyć i przesłać ofertę CreditMint w celu przesłania żądania wydania środków:

   POST/proposals/

Zwrot oświadczenia do edycji

Jeśli we wniosku o zwrot kosztów są pewne braki lub nieprawidłowe dane, które zgodnie z wnioskiem organu ds. walidacji i weryfikacji dostawca ma poprawić, możesz poprosić o edycję wniosku zamiast zatwierdzać lub odrzucać wniosek. Ta możliwość jest dostępna tylko przez API.

  1. Przekaż i dołącz pliki (które chcesz udostępnić dostawcy) do przetwarzanego oświadczenia lub do wyniku punktu kontrolnego przetwarzanego oświadczenia: POST/files i podaj następujące informacje szczegółowe w treści żądania

    • Plik lub adres URL pliku
    • Tag
    • URI zasobu przetworzonego oświadczenia lub wyniku punktu kontrolnego przetwarzanego oświadczenia, do którego należy dodać plik

  2. Przenieś propozycję MBPClaimVerify do stanu submitterActionNeeded, wykonując API returnForEdits action using the POST/proposals/{proposalId}/action i podaj następujące informacje w treści żądania:

    • Akcja: returnForEdits
    • Komunikat: Określ komentarz (jeśli jest wymagany) dla dostawcy podczas odsyłania prośby o edycję.

Edycja zwróconej propozycji

Dostawcy mogą teraz zobaczyć propozycję, która została odesłana do edycji. Mogą teraz edytować atrybuty oświadczeń i punktów kontrolnych oraz przesyłać więcej plików do punktów kontrolnych żądań:

  1. Wyświetlanie propozycji: GET/proposals/{proposalId}

    • W razie potrzeby dostawca może także wyświetlić odpowiadające szczegóły przetworzonego oświadczenia, korzystając z interfejs API GET/processedClaims/{processed_claim_Id}.

  2. Prześlij i dołącz pliki (jeśli są) do punktów kontrolnych oświadczeń: POST/pliki i podaj następujące szczegóły w treści żądania

    • Plik lub adres URL pliku
    • Tag
    • URI zasobu punktu kontrolnego, do którego ma być dodany plik

  3. Uaktualnij atrybuty oświadczenia za pomocą operacji PATCH:

    • Pobierz najnowsze szczegóły dotyczące roszczeń i zwróć uwagę na wartość ETag w nagłówku odpowiedzi: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Uaktualnij atrybuty oświadczenia i określ wartość Etag w kluczu "If-Match" nagłówka żądania: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Uaktualnij atrybuty kontrolnych oświadczeń za pomocą operacji PATCH:

    • Pobierz najnowsze szczegóły dotyczące punktu kontrolnego i zwróć uwagę na wartość ETag w nagłówku odpowiedzi: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

    • Uaktualnij atrybuty oświadczenia i określ wartość Etag w kluczu "If-Match" nagłówka żądania: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

      Uwaga

      Określając atrybuty aktualizacji, upewnij się, że treść żądania JSON ma taką samą strukturę, jak w odpowiednim wywołaniu API get.

  5. Po wprowadzeniu zmian dostawca może ponownie przedstawić propozycję organowi walidacyjnemu i weryfikacyjnemu, wykorzystując API POST/proposals/{proposalId}/action i podając w żądaniu następujące szczegóły:

    • Akcja: Prześlij ponownie
    • Komunikat: Określ komentarz (jeśli jest wymagany) dla walidacji i odniesienia do treści odnosnika.

Po ponownym wysłaniu propozycji organ ds. walidacji i weryfikacji może ją przejrzeć i zatwierdzić, odrzucić lub ponownie poprosić o edycję.

Wycofanie wniosku o wydanie kredytu

Możliwość wycofania przesłanej propozycji wniosku o wydanie środków (CreditMint):

Po złożeniu propozycji wydania kredytu w rejestrze, w przypadku wystąpienia jakichkolwiek problemów, z powodu których chcesz wycofać złożoną propozycję, możesz wycofać złożoną propozycję, jeśli rejestr nie podjął działań w związku z tą propozycją. Ta możliwość jest obecnie dostępna tylko przez interfejsy API.

  • Przenieś propozycję CreditMint, która jest w stanie submitted, do stanu wycofane, używając POST/proposals/{proposalId}/action API i podaj następujące szczegóły w treści żądania:

    • Akcja: Wycofanie
    • Komunikat: Określ powód (jeśli jest) wycofania propozycji dla rejestru.

Status wniosku to obecnie Wycofany.

Po wycofaniu wniosku o wydanie środków organ ds. walidacji i weryfikacji może zmodyfikować „przetworzone oświadczenie” i skojarzone z nimi wyniki punktów kontrolnych, a następnie ponownie przesłać wniosek o wydanie środków.

  • Prześlij i dołącz pliki do projektu wyników punktów kontrolnych przetworzonego oświadczenia: POST/files i określ następujące szczegóły:

    • Plik lub FileURL
    • Tag
    • ResourceURI skojarzonego wyniku punktu kontrolnego.

  • Zaktualizuj atrybuty przetworzonego oświadczenia: PATCH/processedClaims/{processedClaim_Id}

  • Ponownie prześlij żądanie wydania do rejestru i podaj następujące informacje w treści żądania interfejsu API: POST/proposals/{ proposal_id}/action

    • Akcja: Określ jako ponowne przesyłanie
    • Komunikat: Określ wiadomość/komentarz (jeśli chcesz) dla odniesienia do rejestru

Wydawanie kredytów

W tej części pokazano, jak przeglądać i wystawiać kredyty za pomocą interfejsów API. Instrukcje dotyczące korzystania z interfejsu użytkownika znajdziesz na stronie Wydawanie kredytów w Usłudze kredytowania na cele ekologiczne.

Przeglądanie ofert kredytowych

Wyświetl przesłaną propozycję „Token — Mint” i pobierz URI zasobu „przetworzone oświadczenie”, który został przesłany do przeglądu:

GET/proposal/{proposalId}

Przejrzyj ustalenia weryfikacyjne organu ds. walidacji i weryfikacji, przeglądając przetworzone oświadczenie i skojarzone wyniki punktów kontrolnych (razem ze skojarzonymi plikami):

GET/processedClaims/{processedClaims_Id}

Wyświetl szczegóły dotyczące roszczenia i odpowiadających mu punktów kontrolnych (wraz z listą plików dołączonych przez dostawcę do punktów kontrolnych):

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

Zobacz szczegóły projektu korzyści modułowych wraz z listą załączonych plików:

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

Pobierz plik, używając identyfikatora pliku:

   GET/files/{fileId}

Przyznawanie kredytów

Prześlij pliki, które chcesz dołączyć do kredytu w celu jego wydania: POST/files i podaj następujące informacje w treści żądania:

  • Plik lub adres URL pliku
  • Tag

Zatwierdzanie propozycji:

   POST/proposals/{proposalId}/action

W treści żądania podaj następujące informacje:

  • Akcja: Określ jako Wystawienie
  • Komunikat: Określenie komunikatu (jeśli jest) dla walidacji i odniesienia do ciała weryfikacyjnego
  • Identyfikatory plików: Określ identyfikatory przesłanych plików, aby zostały one dołączone do wystawionego kredytu
  • Ilość
  • Zabytkowe
  • Identyfikator zasobu
  • Wartość ustalona

Uwaga

Gdy propozycja zostanie zatwierdzona, zostanie utworzony odpowiedni kredyt.

Odrzucenie propozycji

Prześlij pliki (jeśli chcesz) do przetworzonego oświadczenia: POST/pliki i określ następujące szczegóły:

  • Plik lub adres URL pliku
  • Tag

Odrzucenie propozycji:

   POST/proposals/{proposalId}/action

W treści żądania podaj następujące informacje:

  • Akcja: Odrzuć
  • Komunikat: Określenie komunikatu (jeśli jest) dla walidacji i odniesienia do ciała weryfikacyjnego
  • Identyfikatory plików: Podaj identyfikatory przesłanych plików, aby zostały one dołączone do powiązanego przetworzonego oświadczenia.

Zwrot wniosku o wystawienie kredytu do edycji

Jeśli we wniosku o wydanie są braki lub nieprawidłowe dane, które chcesz, aby organ walidacyjny i weryfikacyjny poprawił, możesz poprosić o edycję wniosku o wydanie. Ta możliwość jest dostępna tylko przez API.

  1. Prześlij pliki (jeśli są), które chcesz udostępnić organowi walidacyjnemu i weryfikacyjnemu w ramach odsyłania wniosku o wydanie do edycji.

  2. Przenieś propozycję wydania (CreditMint), która jest w stanie submitted, do stanu submitterActionNeeded, używając POST/proposals/{proposalId}/action API i podaj następujące szczegóły w treści żądania:

    • Akcja: ReturnForEdits
    • Komunikat: Określ komunikat (jeśli jest) dla organu walidacji i weryfikacji, aby mogły one zrozumieć powód żądania edycji.
    • Identyfikatory plików: Podaj identyfikatory przesłanych plików (jeśli są), aby zostały one dołączone do skojarzonego przetworzonego oświadczenia.

Instytucja walidująca i weryfikująca może teraz zobaczyć propozycję, która została odesłana do edycji. Może teraz także edytować odpowiednie przetworzone oświadczenie i wyniki punktów kontrolnych. Może aktualizować atrybuty oraz przekazywać zaktualizowane pliki do wyników punktów kontrolnych.

W razie potrzeby organ ds. walidacji i weryfikacji może w tym momencie poprosić o wyjaśnienie sprawdzonego oświadczenia, zwracając oświadczenie do edycji przez dostawcę. Po ponownym przesłaniu oświadczenia przez dostawcę organ ds. walidacji i weryfikacji może przejrzeć i zweryfikować oświadczenie, zaktualizować odpowiednie przetwarzane oświadczenie, a następnie ponownie przesłać żądanie wydania do rejestru.

  1. Prześlij i dołącz pliki do wyników punktów kontrolnych: POST/files i określ następujące szczegóły:

    • Plik lub adres URL pliku
    • Tag
    • ResourceURI skojarzonych wyników punktu kontrolnego

  2. Zaktualizuj atrybuty przetwarzanego oświadczenia, w tym rekomendację dotycząca środków: PATCH/processedClaim/{identyfikator przetwarzanego oświadczenia}

  3. Ponownie prześlij żądanie wydania i podaj poniższe informacje w treści żądania interfejsu API: POST/proposals/{ proposal_id}/action

    • Akcja: Prześlij ponownie
    • Komunikat: Określ wiadomość (jeśli chcesz) dla odniesienia do rejestru

Po ponownym wysłaniu żądania rejestr wystawiający może przejrzeć i zatwierdzić, odrzucić lub ponownie poprosić o edycję.

Zobacz wystawione kredyty

   GET/credits

Wyszukiwanie i wyświetlanie kredytów

Pobierz wszystkie alerty

   GET/credits

Uwaga

Ten interfejs API zwróci listę wszystkich kredytów. Kupujący mogą samodzielnie filtrować listę na podstawie statusu kredytu, aby zobaczyć tylko wymienione kredyty.

Wyświetl szczegóły kredytu (w tym historię) dla konkretnego kredytu wyświetlonego na liście:

   GET/credits/{creditId}/lineage

Lista kredytów

Ta sekcja pokazuje, jak wystawiać kredyty na rynku, aby można było nimi handlować za pomocą interfejsów API. Instrukcje dotyczące korzystania z interfejsu użytkownika znajdziesz na stronie Lista kredytów w Usłudze kredytowania na cele ekologiczne.

Zarejestruj się jako kupujący na platformie

Prześlij ofertę MarketplaceTraderRegister jako właściciel kredytu lub kupujący:

   POST/proposals

Pobierz i przejrzyj wszystkie propozycje MarketplaceTraderRegister jako marketplace:

   GET/proposals

Zatwierdzanie i odrzucanie ofert jako platforma:

   POST/proposals/{proposalId}/action

Wyszukuj i przeglądaj wszystkich sprzedawców zarejestrowanych na ich platformie jako platforma handlowa:

   GET/marketplaces/{marketplaceId}/traders

Złóż wniosek o wpisanie na listę kredytów

Utwórz i prześlij propozycję MarketplaceListingRegister:

   POST/proposals

Przegląd propozycji umieszczenia kredytu na liście

   GET/proposals

   POST /proposals/{proposalId}/action

Zarządzanie kredytami

Ta sekcja pokazuje, jak zarządzać kredytami za pomocą interfejsów API. Instrukcje dotyczące korzystania z interfejsu użytkownika znajdziesz na stronie Zarządzanie kredytami w Usłudze kredytowania na cele ekologiczne.

Usuń kredyt z listy

Dzielenie kredytu jest niezależną operacją w Usłudze kredytowania na cele ekologiczne. Aby uzyskać informacje o dzieleniu kredytu przez API, przejdź do strony Podział kredytu. Po rozdzieleniu kredytu możesz przejść do następnego kroku.

Utwórz i prześlij propozycję MarketplaceListingDeregister:

   POST/proposals

Wyświetl wszystkie oferty z listy MarketplaceListingDeregister przesłane do zrecenzowania:

   GET/proposals

Aby zatwierdzić lub odrzucić żadanie:

   POST/proposals/{proposalId}/action

Przenieś prawo własności

   POST/credits/{creditId}/transfer/

Zobacz pochodzenie kredytów

Organizacje z rolami dostawców i rejestrów mogą przeglądać linie kredytowe dla kredytów, które posiadają lub wydały:

   GET/credits/{creditId}/lineage

Podział kredytu

Możesz podzielić kredyt na kredyty podrzędne. Ta funkcja jest aktualnie dostępna tylko w API.

Podziel kredyt poprzez określenie ilości (w mtCO2e) dla co najmniej dwóch kredytów pochodnych jako właściciel kredytu (dla kredytów, które posiada) lub jako rynek (dla kredytów wymienionych na jego platformie):

   POST/credits/{creditId}/split

Przeniesienie listy kredytów

Rynek może przenieść ofertę kredytową ze swojej platformy na inny rynek. Takie przeniesienie jest również znane jako przeniesienie obciążenia. W tradycyjnym trybie dostawca wymienia kredyty na rynku, który pomaga w obsłudze popytu, rozliczeń i rozrachunku. Czasami rynek może nie być w stanie samodzielnie przeprowadzić rozliczenia płatności i może polegać na innej platformie. W takim przypadku aktywa muszą zostać przekazane na nowy rynek, aby zakończyć transakcję. Ta funkcja jest aktualnie dostępna tylko w API.

Jako marketplace utwórz i prześlij propozycję MarketplaceListingTransfer kredytu wymienioną na platformie:

   POST/proposals

Jako osoba zatwierdzająca marketplace wyświetl wszystkie propozycje MarketplaceListingTransfer przesłane do nich do zrecenzowania:

   GET/proposals

Jako zatwierdzający rynek, zatwierdź lub odrzuć propozycję. Jeśli propozycja zostanie zatwierdzona, obciążenie kredytowe zostanie przeniesione z rynku początkowego na rynek zatwierdzającego:

   POST/proposals/{proposalId}/action

Częściowe przeniesienie obciążenia: Rynek może dokonać częściowego przeniesienia obciążeń, dzieląc je najpierw na niezależne działania. Aby uzyskać informacje o dzieleniu kredytu przez API, przejdź do strony Podział kredytu. Po podzieleniu kredytu kontynuuj powyższe kroki w celu przeniesienia obciążeń dla kredytów na dzieci.

Ustawianie celów emisyjnych

W tej części pokazano, jak ustawić cele i zadania redukcji emisji za pomocą interfejsów API.

Tworzenie celów emisyjnych

   POST/esgs

Przeglądanie celów emisyjnych

   GET/esgs

Śledzenie emisji

W tej części pokazano, jak śledzić emisje w odniesieniu do karty wyników emisji, którą ustawiłeś za pomocą interfejsów API. Instrukcje dotyczące korzystania z interfejsu użytkownika znajdziesz na stronie Śledzenie celów emisyjnych w Usłudze kredytowania na cele ekologiczne.

Tworzenie punktów kontrolnych dla danego okresu sprawozdawczego

   POST/esgs/{esgScorecardId}/milestones

Pobierz wszystkie punkty kontrolne:

   GET/esgs/{esgScorecardId}/milestones

Pobierz określony punkt kontrolny:

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

Śledzenie rzeczywistych emisji w odniesieniu do punktu kontrolnego

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

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

Wycofanie kredytów

Ta sekcja pokazuje, jak zrównoważyć nadmierną emisję poprzez wycofanie posiadanych kredytów węglowych za pomocą interfejsów API. Instrukcje dotyczące korzystania z interfejsu użytkownika znajdziesz na stronie Wycofywanie kredytów w Usłudze kredytowania na cele ekologiczne.

Złóż wniosek o wycofanie kredytów

Utwórz i prześlij propozycję ESGEmissionOffset:

   POST/proposals

Nabywcy mogą również bezpośrednio wycofać kredyty węglowe bez określania emisji, które mają zostać skompensowane. Ta funkcja jest dostępna tylko przez API.

Utwórz i prześlij propozycję CreditRetire:

   POST/proposals

Przejrzyj wniosek o wycofanie kredytów

   GET/proposals

   GET/proposals/{proposalId}

Dołącz plik do kredytu, który jest sprawdzany pod kątem wycofania:

   POST/files

   POST/proposals/{proposalId}/action

Częściowe wycofanie kredytów

Aby uzyskać informacje o dzieleniu kredytu przez API, przejdź do strony Podział kredytu.

Po podzieleniu kredytu użyj interfejsów API z poprzednich kroków, aby uzyskać offset i wycofanie.

Zarządzanie plikami

W tej części dowiesz się, jak za pomocą interfejsów API dołączać, przeglądać i usuwać pliki dla takich aktywów jak projekt, roszczenia i kredyty. Instrukcje dotyczące korzystania z interfejsu użytkownika znajdziesz na stronie Zarządzanie plikami w Usłudze kredytowania na cele ekologiczne.

Dołącz pliki

Użyj interfejsu API POST/files, aby dołączyć plik do zasobu. Musisz określić następujące szczegóły:

  • Plik lub adres URI pliku
  • URI zasobu dla zasobu
  • Znacznik opisowy dla pliku

Wyświetlanie plików

Wyświetl listę plików wraz z właściwościami pliku dla zasobu, korzystając z interfejsu API szczegółów zasobu:

Projekt korzyści modułowych:

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

Oświadczenia:

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

Punkty kontrolne oświadczeń:

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

Kredyt:

   GET/credits/{creditId}

Aby pobrać plik, użyj identyfikatora pliku znajdującego się we właściwościach pliku:

   GET/files/{fileId}

Usuń pliki

Użyj identyfikatora pliku, aby wywołać interfejs API usuwania:

   DELETE/files/{fileId}

Omówienie
Usługi kredytowania na cele ekologiczne Konfiguracja usługi
kredytowania na cele ekologiczne Słowniczek usługi kredytowania na cele ekologiczne

📄 Strona
🎓 produktu Szkolenia

✅ Bezpłatny kanał próbny
🎥 YouTube

💻 Społeczność
Ikona serwisu LinkedIn.LinkedIn grupa