環境クレジットサービスに関する API リファレンスの概要

重要

この機能の一部またはすべては、プレビュー リリースの一部として利用できます。 コンテンツおよび機能は変更される場合があります。 30 日間の試用版で、環境クレジット サービス (プレビュー) サンドボックス環境にアクセスできます。 運用環境で、環境クレジット サービス (プレビュー) を使用するには、環境クレジット サービス (プレビュー) サインアップ フォームを完了してください。

この記事は、環境クレジットサービス REST API を使った作業を支援するものです。 完全な API リファレンスを表示するには、環境クレジットサービス REST API リファレンス にアクセスしてください。 Swagger ファイルは、環境クレジットサービス REST API にあります。

• プロジェクトを登録する
• 主張を処理する
• クレジットを発行する
• クレジットをリストする
• クレジットを管理する
• 排出目標を設定する
• 排出量を追跡する
• クレジットを廃止する
• ファイルを管理する

プロジェクトを登録する

ここでは、API を使った生態系プロジェクトの作成、提出、レビューの方法を紹介します。 ユーザー インターフェースの使用方法については、環境クレジット サービスへのプロジェクトの登録 をご覧ください。

• プロジェクトの作成
• プロジェクトを保存して提出する
• プロジェクトの表示
• 提案の承認、または却下
• ファイルの削除
• 編集の提案を返す
• 追加のモジュラー ベネフィット プロジェクトを登録する
• モジュール ベネフィット プロジェクトをレビューする

プロジェクトを作成する

プロジェクトの作成時にファイルをアップロードして添付する方法:

1. POST/files を使用してファイルをアップロードします。 API の詳細情報を入力します:

   • ファイルまたはファイルの URL
   • ファイルの内容を示す名前

2. エコ プロジェクトとそれに対応するモジュール ベネフィット プロジェクトを作成し、プロジェクト作成 API リクエスト ボディ (POST/ecoprojects) の属性として、POST/files API コールの応答で返される fileID を指定します。

プロジェクトを保存して提出する

プロジェクトの詳細を取得します:

   GET/ecoProjects/{ecoProjectId}

モジュラー ベネフィット プロジェクトに添付されているファイル (および関連するメタデータ) のリストを表示します:

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

ファイル メタデータの一部として利用可能な fileID を使用してファイルをダウンロードします。

   GET/files/{fileId}

ファイルをモジュール ベネフィット プロジェクトに追加する:

   POST/files

要求本文でモジュール ベネフィット プロジェクトのリソース URI を指定します。

MBPRegister 提案を送信することにより、登録用のモジュラー ベネフィット プロジェクトを送信します:

   POST/proposals

プロジェクトの表示

すべての提案を取得します:

   GET/proposals

特定の提案の詳細を取得します:

   GET/proposals/{proposalId}

特定のエコロジー プロジェクトの詳細を取得します:

   GET/ecoProjects/{ecoProjectId}

レビューする特定の MBP の詳細を取得します:

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

モジュール型特典プロジェクトに添付されているファイル (および関連するメタデータ) のリストを取得します。

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

前の API 応答の一部として利用可能な fileId を使用して、ファイルをダウンロードします:

   GET/files/{fileId}

モジュール ベネフィット プロジェクトにファイルを添付する:

   POST/files

提案の承認、または却下

ファイルのアップロード (該当する場合):

POST/files を実行し、ファイル (または FileUrl) とタグの詳細を指定します

登録の要求を却下する:

POST/proposals/{proposalId}/action を実行し、要求本文に次の詳細を指定します

• アクション: 否認

• メッセージ: 登録を拒否するコメント (該当する場合) を指定します。

• FileIDs: アップロードされたファイルのファイル ID を指定します。

ファイルの削除

モジュラー ベネフィット プロジェクトに添付されているファイル のリストを表示します:

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

ユーザーは自分がアップロードしたファイルのみを削除できるため、アップロードしたファイルを特定します。

ファイルの削除:

   DELETE/files/{fileId}

編集の提案を返す

プロジェクトの属性やファイルに、サプライヤーに修正または追加してほしいギャップや誤った内容がある場合、プロジェクト上で編集を依頼することができます。

1. サプライヤーと共有する必要があるファイルがある場合はアップロードします:

   POST/files

2. POST/proposals/{proposalId}/action API を使用して returnForEdits のアクションを取ることによって MBPRegister の提案を submitterActionNeeded の状態に移行し、要求本文に以下の詳細を指定します。

   • アクション: returnForEdits

   • メッセージ: 編集要求を返す際にサプライヤーが参照するコメント (必要な場合) を指定してください。

   • ファイル ID: アップロードされたファイルのファイル ID をここで指定して、関連するモジュラー ベネフィット プロジェクトにファイルを添付します。

   これが完了すると、モジュラー ベネフィット プロジェクトは returnedForEdits 状態に移行します。

サプライヤーは、編集のために送り返された提案を表示できるようになりました。 以上で、モジュラー ベネフィット プロジェクトの属性を編集し、モジュラー ベネフィット プロジェクトにさらにファイルをアップロードできるようになりました。

• 提案を表示: GET/proposals/{proposalId}

• モジュラー ベネフィット プロジェクト: POST/files にファイルをアップロードして添付し、要求本文で次の詳細を指定します:

  • ファイルまたはファイルの URL
  • タグ: ファイル タグの内容を示す名前
  • ResourceURI: それぞれのモジュラー ベネフィット プロジェクトのリソース URI を指定します。

• モジュラー ベネフィット プロジェクトの属性を更新する

  • GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} を使用して更新されたモジュール ベネフィット プロジェクトの詳細を取得し、応答ヘッダから Etag 値をコピーします。
  • PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} API を使用してモジュール特典のプロジェクト属性を更新し、ヘッダーの If-Match キーに Etag 値を指定します。

変更が完了すると、サプライヤーは POST/proposals/{proposalId}/action API を使用して提案をレジストリに送信し、要求で次の詳細を指定できるようになります:

• アクション: Submit

• メッセージ: レジストリ参照用のコメント (該当する場合) を指定してください。

追加のモジュラー ベネフィット プロジェクトを登録する

MBPRegister 提案を作成、提出し、発行元レジストリに登録するエコロジーを提出します。

   POST/proposal

モジュール ベネフィット プロジェクトをレビューする

提案の詳細を表示する:

   GET/proposals/{proposalId}

プロジェクトの詳細全体を表示する:

   GET/ecoProjects/{ecoProjectId}

プロジェクトの個々のモジュラー ベネフィット プロジェクトの詳細を表示する:

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

登録提案を承認または却下するか、編集のために返却する:

   POST/proposals/{proposalId}/action

クレームを処理する

このセクションでは、API を介してクレームを処理する方法を示します。 ユーザー インターフェースの使用方法については、環境クレジットサービスでのクレーム処理 をご覧ください。

• クレームの作成
• 請求の送信
• クレームの確認
• 編集のクレーム リクエストを返す
• 返された提案の編集
• クレジット発行依頼を取り下げる

クレームの作成

クレームの作成:

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

ファイルをアップロードして添付し、チェックポイントを要求する:

   POST/files

リクエストには以下の内容を明記します:

• ファイルまたはファイルの URL
• タグ
• クレームのリソース URI

クレームの送信

モジュラー ベネフィット projectClaimVerify 提案を作成して送信します:

   POST/proposals

送信した提案の詳細を表示する:

   GET/proposal/{proposalId}

クレームの詳細を表示する:

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

クレームの確認

提案の確認:

   GET/proposals

特定の提案の詳細を取得する:

   GET/proposals/{proposalId}

検証提案が提出された特定の主張の詳細を取得する:

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

クレームを検証するタスクを受け入れる:

   POST/proposals/{proposalId}/action

モジュラー ベネフィット プロジェクトに関連付けられているファイルを一覧表示します:

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

クレーム チェックポイントに関連付けられているファイルを一覧表示する:

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

特定のアセットに添付されたファイルを表示する:

   GET/files/{fileId}

クレームが受理されると、対応する「処理済みクレーム」が作成されます。 処理されたクレームに検証結果を記録します。 これには、クレームの数量、共同利益の更新が含まれます。 クレジット発行リクエストを送信する前に、処理されたクレームについてもクレジットの推奨事項を更新する必要があります。

• GET/processedClaims/{processed_claim_id} を使用して、処理されたクレームの詳細を取得、応答ヘッダーから Etag 値をコピーします。
• PATCH/processedClaims/{processed_claim_id} API を使用して処理されたクレーム属性を更新し、ヘッダーの If-Match キーに Etag 値を指定します。

検証するチェックポイントごとに、処理されたクレームの対応するチェックポイント結果で検証結果を更新できます。

• POST/files API を使用して、検証結果レポートをアップロードし、処理されたクレームのチェックポイント結果に添付し、要求本文でファイルまたはファイルの URL、タグ、および ResourceUri (これはチェックポイント結果のリソース uri になります) を指定します。
• チェックポイント結果の属性の前後の環境効果を更新します (必要な場合)。
  • GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} を使用してチェックポイント結果を取得し、応答ヘッダーから Etag 値をコピーします。
  • PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} API を使用してチェックインポイント結果の属性を更新し、ヘッダーの If-Match キーに Etag 値を指定します。
  • 処理されたクレームのパッチ API を使用して、チェックポイントの結果を更新することもできます。

検証が完了したら、MBPClaimVerify 提案を承認または拒否します。

   POST/proposals/{proposalId}/action

次の詳細情報を入力します:

• アクション: 承認または拒否

• メッセージ: サプライヤー参照用のコメント (該当する場合) を指定してください。

MBPClaimVerify 提案が承認されたら、CreditMint 提案を作成して送信し、クレジット発行要求を送信します。

   POST/proposals/

編集のクレーム リクエストを返す

検証および検証機関がサプライヤーに修正してもらいたい場合は、請求の承認や拒否ではなく、請求内容の編集を依頼することができます。 この機能は、API 経由でのみ利用可能です。

1. 処理されたクレームまたは処理されたクレームのチェックポイント結果に、(サプライヤーと共有したい) ファイルをアップロードして添付します: POST/files で、要求本文に次の詳細を指定します

   • ファイルまたはファイルの URL
   • タグ
   • ファイルを追加する必要がある、処理されたクレームまたは処理されたクレームのチェックポイント結果のリソース URI

2. POST/proposals/{proposalId}/action API を使用して returnForEdits のアクションを取ることによって MBPClaimVerify の提案を submitterActionNeeded の状態に移行し、要求本文に以下の詳細を指定します。

   • アクション: returnForEdits
   • メッセージ: 編集要求を返す際にサプライヤーが参照するコメント (必要な場合) を指定してください。

返された提案の編集

サプライヤーは、編集のために送り返された提案を表示できるようになります。 クレームとチェックポイントの属性を編集できるようになり、クレーム チェックポイントにさらにファイルをアップロードできるようになりました。

1. 提案を表示: GET/proposals/{proposalId}

   • 必要に応じて、サプライヤーは GET/processedClaims/{processed_claim_Id} API を使用して、対応する処理されたクレームの詳細を表示することもできます。

2. クレーム チェック ポイントにファイル (該当がある場合) をアップロードし、添付します: POST/files で、要求本文に以下の内容を指定します

   • ファイルまたはファイルの URL
   • タグ
   • ファイルを追加する必要があるチェックポイントのリソース URI

3. PATCH 操作を使用してクレーム属性を更新する:

   • 最新の請求の詳細を取得し、応答ヘッダーの ETag 値に注意してください: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
   • クレームの属性を更新し、リクエストヘッダの 'If-Match' キーに Etag 値を指定します: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

4. PATCH 操作を使用して、請求のチェックポイント属性を更新します:

   • 最新のチェックポイントの詳細を取得し、レスポンスヒードのETag値を記録します: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

   • クレームの属性を更新し、リクエストヘッダの 'If-Match' キーに Etag 値を指定します: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

     注意

     更新属性を指定するときは、JSON 要求の本文が、対応する get API 呼び出しと同じ構造に従っていることを確認してください。

5. 修正後、POST/proposals/{proposalId}/action API を使用して検証機関に提案書を返送し、要求本文に以下の内容を指定することができます:

   • アクション: 再送信
   • メッセージ: 検証および検証本文参照用のコメント (必要な場合) を指定します。

再提出の後、検証および認証機関は提案書を確認し、承認、拒否、または再度編集を依頼することができます。

クレジット発行依頼を撤回する

提出されたクレジット発行リクエスト (CreditMint) 提案を撤回するオプション:

クレジット発行提案書をレジストリに提出した後、提出した提案書を撤回したい問題が発生した場合、レジストリがその提案書に対してアクションを起こしていなければ、提出した提案書を撤回することができます。 この機能は現在、API によってのみ利用可能です。

• POST/proposals/{proposalId}/action API を使用して、投稿状態の CreditMint の提案を撤回中に移行し、要求本文に以下の内容を指定します:

  • アクション: 撤回
  • メッセージ: レジストリ参照の提案を撤回する理由 (該当する場合) を指定してください。

提案のステータスは現在撤回中です。

クレジット発行リクエストが取り下げられた後、検証および検証機関は「処理されたクレーム」と関連するチェックポイントの結果を変更し、クレジット発行リクエストを再送信できます。

• 処理されたクレームのチェックポイント結果にファイルをアップロードし、添付することができます: POST/files と以下の詳細を指定します:

  • ファイルまたは FileURL
  • タグ
  • 関連付けられたチェックポイント結果の ResourceURI。

• 処理されたクレームの属性を更新します: PATCH/processedClaims/{processedClaim_Id}

• 発行要求をレジストリに再送信し、API 要求本文に次の詳細を指定します: POST/proposals/{ proposal_id}/action

  • アクション: 再送信 と指定します
  • メッセージ: レジストリ参照用のメッセージ/コメント (該当する場合) を指定します

クレジットの発行

このセクションでは、API を介してクレジットを表示および発行する方法を示します。 ユーザー インターフェースの使用方法については、環境クレジットサービスでのクレジットの発行 にアクセスしてください。

• プロポーザルの確認
• クレジットの承認
• 提案の却下
• 編集のためのクレジット発行リクエストを返す
• 発行されたクレジットを表示
• クレジットを検索して表示する

クレジット発行の提案を確認する

提出された「Token mint」提案を表示し、レビューのために提出された「処理されたクレーム」リソース URI を取得します。

GET/proposal/{proposalId}

処理されたクレームと関連するチェックポイントの結果を (関連するファイルと共に) 表示して、検証および検証機関の検証結果を確認します。

GET/processedClaims/{processedClaims_Id} 

クレームと対応するチェックポイントの詳細 (チェックポイントのためにサプライヤーが添付したファイルのリストと共に) を表示する:

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

モジュール クラシックのプロジェクト詳細と、添付ファイル一覧を表示する:

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

ファイル ID を指定してファイルをダウンロードする:

   GET/files/{fileId}

クレジットの承認

発行用クレジットに添付するファイルをアップロードします。POST/files と要求本文に以下の内容を指定します:

• ファイルまたはファイルの URL
• タグ

提案の承認:

   POST/proposals/{proposalId}/action

要求本文には以下の内容を明記します:

• アクション: Mint と指定します
• メッセージ: 検証および検証本文参照用のメッセージ (必要な場合) を指定します
• ファイル ID: 発行されたクレジットにファイルが添付されるように、アップロードされたファイルのファイル ID を指定します
• 品質
• ビンテージ
• 資産 ID
• 確定値

注意

提案が承認されると、対応するクレジットが作成されます。

提案の却下

処理されたクレームにファイル (存在する場合) をアップロードすることができます: POST/files と以下の詳細を指定します:

• ファイルまたはファイルの URL
• タグ

提案の却下:

   POST/proposals/{proposalId}/action

要求本文には以下の内容を明記します:

• アクション: 否認
• メッセージ: 検証および検証本文参照用のメッセージ (必要な場合) を指定します
• ファイル ID: アップロードされたファイルのファイル ID を指定し、関連する処理された請求に添付されるようにします。

編集のためのクレジット発行リクエストを返す

発行依頼書の内容に不備や誤りがあり、検証・確認機関に訂正してもらいたい場合は、発行依頼書の編集を依頼することができます。 この機能は、API 経由でのみ利用可能です。

1. 編集のために発行依頼を送り返す際に、検証・確認機関と共有したいファイルがあればアップロードします。

2. 発行依頼 (CreditMint 提案) を POST/proposals/{proposalId}/action API で submitterActionNeeded 状態に移行し、以下の内容を指定します:

   • アクション: ReturnForEdits
   • メッセージ: 編集要求の理由を理解できるように、検証および検証本文参照用のメッセージ (ある場合) を指定します。
   • ファイル ID: アップロードされたファイルのファイル ID を指定し (存在する場合)、関連する処理された請求クレームに添付されるようにします。

検証および検証機関は、編集のために返送された提案を表示できるようになりました。 また、対応する処理されたクレームとチェックポイントの結果を編集できるようになりました。 属性を更新したり、更新されたファイルをチェックポイント結果にアップロードしたりできます。

必要に応じて、検証および検証機関は、この時点で、編集のためのクレームをサプライヤーに返却することにより、検証済みのクレームの説明を求めることができます。 サプライヤーがクレームを再送信すると、検証および検証機関はクレームを確認および検証し、対応する処理済みクレームを更新してから、発行要求をレジストリに再送信できます。

1. チェックポイント結果にファイルをアップロードし、添付することができます: POST/files と以下の詳細を指定します:

   • ファイルまたはファイルの URL
   • タグ
   • 関連付けられたチェックポイント結果の ResourceURI

2. クレジットの推奨事項を含む処理済みクレームの属性を更新します: PATCH/processedClaim/{処理されたクレーム ID}

3. 発行要求を再送信し、API 要求本文に次の詳細を指定します: POST/proposals/{ proposal_id}/action

   • アクション: 再送信
   • メッセージ: レジストリ参照用のメッセージ (該当する場合) を指定します

再送信後、リクエストの内容を確認し、発行レジストリは承認、拒否、または再度編集を依頼することができます。

発行されたクレジットを表示

   GET/credits

クレジットを検索して表示する

すべてのクレジットを取り込む:

   GET/credits

注意

この API は、すべてのクレジットのリストを返します。 バイヤーは、リストされたクレジットのみを表示するために、クレジット ステータスに基づいて独自にリストをフィルター処理できます。

リストに表示された特定のクレジットのクレジット詳細 (系列を含む) を表示します。

   GET/credits/{creditId}/lineage

クレジットをリストする

このセクションでは、API を介した取引のためにマーケットプレースにクレジットをリストする方法を示します。 ユーザー インターフェースの使用方法については、環境クレジットサービスでのクレジットのリスト にアクセスしてください。

• マーケットプレースにバイヤーとして登録する
• クレジットをリストするためのプロポーザルを提出する
• クレジットをリストするためのプロポーザルをレビューする

バイヤー、またはマーケットプレースとして登録する

MarketplaceTraderRegister 提案をクレジット所有者または購入者として送信します。

   POST/proposals

すべての MarketplaceTraderRegister 提案をマーケットプレイスとして取得してレビューします。

   GET/proposals

提案をマーケットプレースとして承認または却下します:

   POST/proposals/{proposalId}/action

プラットフォームにマーケットプレースとして登録されているすべてのトレーダーを取得して表示します:

   GET/marketplaces/{marketplaceId}/traders

クレジットをリストするためのプロポーザルを提出する

MarketplaceListingRegister 提案を作成して送信します。

   POST/proposals

クレジットをリストするための提案をレビューする

   GET/proposals

   POST /proposals/{proposalId}/action

クレジットを管理する

ここでは、API を利用したクレジット管理について説明します。 ユーザー インターフェースの使用方法については、環境クレジットサービスでのクレジットの管理 にアクセスしてください。

• クレジットの削除
• 所有権の移転
• クレジットの系譜の表示
• クレジットの分割
• クレジット リストの移転

クレジットの削除

クレジットの分割は、環境クレジット サービスの独立した操作です。 API を経由したクレジット分割の詳細については、クレジットの分割 をご覧ください。 クレジット分割後、次のステップに進むことができます。

MarketplaceListingDeregister 提案を作成して送信します。

   POST/proposals

レビューのために送信されたすべての MarketplaceListingDeregister 提案を表示します。

   GET/proposals

提案を承認または拒否する:

   POST/proposals/{proposalId}/action

所有権の移転

   POST/credits/{creditId}/transfer/

クレジットの系譜の表示

サプライヤーとレジストリの役割を持つ組織は、所有または発行したクレジットの信用系列を表示できます:

   GET/credits/{creditId}/lineage

クレジットの分割

クレジットを子クレジットに分割できます。 現在、この機能は API を介してのみ利用できます。

少なくとも 2 つの子クレジットの数量 (mtCO2e 単位) をクレジット所有者 (所有するクレジットの場合) またはマーケットプレース (プラットフォームにリストされているクレジットの場合) として指定して、クレジットを分割します。

   POST/credits/{creditId}/split

クレジット リストの移転

マーケットプレースは、プラットフォームから別のマーケットプレースに信用リストを転送できます。 この譲渡は、負債の譲渡とも呼ばれます。 従来のフローでは、サプライヤーは、需要、清算、および決済に役立つクレジットをマーケットプレースにリストします。 マーケットプレースが独自に決済を行うことができず、別のプラットフォームに決済を依存する場合もあります。 この場合、トランザクションを完了するには、資産を新しいマーケットプレースに転送する必要があります。 現在、この機能は API を介してのみ利用できます。

マーケットプレイスとして、プラットフォームにリストされているクレジットの MarketplaceListingTransfer 提案を作成して送信します。

   POST/proposals

承認者マーケットプレイスとして、レビューのために送信されたすべての MarketplaceListingTransfer 提案を表示します。

   GET/proposals

承認者マーケットプレースとして、提案の承認または拒否を行います。 プロポーザルが承認されると、クレジット負担が初期マーケットプレースから承認者マーケットプレースに転送されます:

   POST/proposals/{proposalId}/action

負担の部分的な譲渡: マーケットプレースは、最初にクレジットを独立したアクションとして分割することにより、部分的なクレジットの負担を譲渡できます。 クレジットを分割する方法については、クレジットを分割する をご覧ください。 クレジットが分割された後、上記の子クレジットのエンベロープの移転の手順に進みます。

排出目標を設定する

このセクションでは、API を介して排出削減の目標とターゲットを設定する方法を示します。

• 排出目標の作成
• 排出目標を表示する

排出目標の作成

   POST/esgs

排出目標を表示する

   GET/esgs

排出量を追跡する

このセクションでは、API を介して設定した排出量スコアカードに対して排出量を追跡する方法を示します。 ユーザー インターフェースの使用方法については、環境クレジットサービスでの排出目標の追跡 にアクセスしてください。

• 特定の報告期間のマイルストーンを作成する
• マイルストーンに対する実際の排出量を追跡する

特定の報告機関のマイルストーンを作成する

   POST/esgs/{esgScorecardId}/milestones

すべてのマイルストーンを取得します:

   GET/esgs/{esgScorecardId}/milestones

特定のマイルストーンを取得します:

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

マイルストーンに対する実際の排出量を追跡する

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

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

クレジットの廃止

このセクションでは、API を介して所有している炭素クレジットを廃止することで、過剰な排出量を相殺する方法を示します。 ユーザー インターフェースの使用方法については、環境クレジットサービスでのクレジットの廃止 にアクセスしてください。

• クレジット廃止の提案を提出する
• クレジット廃止の提案をレビューする
• 部分的なクレジットの廃止

クレジット廃止の提案を提出する

ESGEmissionOffset 提案を作成して送信する:

   POST/proposals

購入者は、相殺する排出量を指定せずに、炭素クレジットを直接廃止することもできます。 この機能は API を介してのみで使用できます。

CreditRetire 提案を作成して送信する:

   POST/proposals

クレジット廃止の提案をレビューする

   GET/proposals

   GET/proposals/{proposalId}

廃止を検討しているクレジットにファイルを添付します:

   POST/files

   POST/proposals/{proposalId}/action

部分的なクレジットの廃止

API を経由したクレジット分割の詳細については、クレジットの分割 をご覧ください。

クレジットが分割された後、前のステップの API を使用してオフセットと廃止を行います。

ファイルを管理する

このセクションでは、API を介してプロジェクト、請求、クレジットなどのアセットのファイルを添付、表示、および削除する方法について説明します。 ユーザー インターフェースの使用方法については、環境クレジットサービスでのファイルの管理 にアクセスしてください。

• ファイルの添付
• ファイルの表示
• ファイルの削除

ファイルの添付

POST/files API を使用して、資産にファイルを添付します。 以下の詳細を指定する必要があります:

• ファイルまたはファイルの URI
• 資産のリソース URI
• ファイルの内容を示す名前

ファイルの表示

アセットの詳細 API を使用して、ファイルのリストと試算のファイル プロパティを表示します:

モジュール型ベネフィット プロジェクト:

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

クレーム:

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

クレームを取得:

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

クレジット:

   GET/credits/{creditId}

ファイルのファイル プロパティにあるファイル ID を使用して、ファイルをダウンロードします:

   GET/files/{fileId}

ファイルを削除する

ファイルのファイル ID を使用して、削除 API を呼び出します:

   DELETE/files/{fileId}

参照

環境クレジット サービスの概要
環境クレジット サービスの構成
環境クレジット サービスの用語集