Freigeben über

API-Referenzübersicht für Umwelt-Kreditservice

  • Artikel

Kostenlose Testversion

Wichtig

Einige oder alle dieser Funktionen sind als Teil einer Vorschauversion verfügbar. Inhalt und Funktionalität können sich ändern. Sie können eine 30-tägige Testversion der Sandbox-Umgebung des Umwelt-Kreditservice (Vorschauversion) nutzen. Um sich für Umwelt-Kreditservice (Vorschauversion) in einer Produktionsumgebung anzumelden, gehen Sie zum Anmeldeformular für Umwelt-Kreditservice (Vorschauversion).

Dieser Artikel hilft Ihnen, Aufgaben mit den REST-APIs des Umwelt-Kreditservice auszuführen. Die vollständige API-Referenz finden Sie unter Umwelt-Kreditservice API-Referenz. Die Swagger-Datei finden Sie unter Umwelt-Kreditservice REST-APIs.

Projekte registrieren

In diesem Abschnitt erfahren Sie, wie Sie umweltfreundliche Projekte über APIs erstellen, senden und überprüfen können. Anweisungen zur Verwendung der Benutzeroberfläche finden Sie unter Projekte in Umwelt-Kreditservice registrieren.

Projekt erstellen

Hochladen und Anhängen von Dateien zum Zeitpunkt der Projekterstellung:

  1. Laden Sie Dateien mit POST/files hoch. Geben Sie die folgenden Details in der API an:

    • Datei oder Datei-URL
    • Beschreibendes Tag für die Datei

  2. Erstellen Sie das umweltfreundliche Projekt und das entsprechende modulare Leistungsprojekt und geben Sie die fileID, die in der Antwort des POST/files API-Aufrufs zurückgegeben wird, als Attribut im Body der Projekt-Erstellungs-API-Anfrage an: POST/ecoprojects.

Speichern und senden Sie ein Projekt

Holen Sie sich die Details des Projekts:

   GET/ecoProjects/{ecoProjectId}

Zeigen Sie die Liste der Dateien (und der zugehörigen Metadaten) an, die dem modularen Leistungsprojekt angehängt sind:

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

Laden Sie eine Datei unter Verwendung der fileID herunter, die als Teil der Datei-Metadaten verfügbar ist:

   GET/files/{fileId}

Fügen Sie Dateien zu dem modularen Leistungsprojekt hinzu:

   POST/files

Geben Sie die Ressourcen-URI des modularen Leistungsprojekts im Body der Anfrage an.

Reichen Sie ein modulares Leistungsprojekt zur Registrierung ein, indem Sie ein Angebot für MBPRegister senden:

   POST/proposals

Ein Projekt ansehen

Holen Sie alle Angebote:

   GET/proposals

Details zu einem bestimmten Angebot abrufen:

   GET/proposals/{proposalId}

Details zu einem bestimmten umweltfreundlichen Projekt abrufen:

   GET/ecoProjects/{ecoProjectId}

Details des zu überprüfenden MBP abrufen:

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

Rufen Sie die Liste der Dateien (und der zugehörigen Metadaten) ab, die dem modularen Leistungsprojekt beigefügt sind:

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

Laden Sie die Dateien unter Verwendung der fileId herunter, die als Teil der vorherigen API-Antwort verfügbar ist:

   GET/files/{fileId}

Hängen Sie eine Datei an das modulare Leistungsprojekt an:

   POST/files

Ein Angebot genehmigen oder ablehnen

Dateien hochladen (falls vorhanden):

POST/files und Angabe von Datei (oder FileUrl) und Tag-Details

Weisen Sie die Registrierungsanfrage zurück:

POST/proposals/{proposalId}/action und geben Sie die folgenden Details im Body der Anfrage an

  • Aktion: Ablehnen

  • Nachricht: Geben Sie einen Kommentar (falls zutreffend) an, den Sie für die Ablehnung der Registrierung angeben möchten.

  • Datei-IDs: Geben Sie die Datei-IDs der Dateien an, die hochgeladen wurden.

Eine Datei löschen

Sehen Sie sich die Liste der Dateien an, die an das modulare Leistungsprojekt angehängt sind:

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

Identifizieren Sie die Datei, die Sie hochgeladen haben, denn ein Benutzer kann nur die Dateien löschen, die er selbst hochgeladen hat.

Löschen Sie die Datei:

   DELETE/files/{fileId}

Angebot für Bearbeitungen zurücksenden

Wenn die Projektattribute oder -dateien Lücken aufweisen oder falsche Angaben enthalten, die der Lieferant korrigieren oder hinzufügen soll, können Sie um Änderungen am Projekt bitten.

  1. Laden Sie ggf. Dateien hoch, die mit dem Lieferanten geteilt werden müssen:

    POST/files

  2. Verschieben Sie das Angebot MBPRegister in den Status submitterActionNeeded, indem Sie die Aktion returnForEdits unter Verwendung der POST/proposals/{proposalId}/action API ausführen und die folgenden Details im Body der Anfrage angeben:

    • Aktion: ReturnForEdits

    • Nachricht: Geben Sie einen Kommentar (falls erforderlich) für die Lieferantenreferenz an, wenn Sie die Anfrage zur Bearbeitung zurücksenden.

    • Datei-IDs: Geben Sie hier die Datei-ID der hochgeladenen Datei an, um die Datei an das betreffende modulare Leistungsprojekt anzuhängen.

    Nachdem dies geschehen ist, geht das modulare Leistungsprojekt in den Status zurückgekehrtFürBearbeitungen.

Lieferanten können jetzt das Angebot einsehen, das zur Überarbeitung zurückgeschickt wurde. Sie können jetzt die Attribute des modularen Leistungsprojekts bearbeiten und weitere Dateien in das modulare Leistungsprojekt hochladen.

  • Angebot ansehen: GET/proposals/{proposalId}

  • Hochladen und Anhängen von Dateien an das modulare Leistungsprojekt: POST/files und geben Sie die folgenden Details im Body der Anfrage an:

    • Datei oder Datei-URL
    • Tag: Beschreibendes Datei-Tag
    • Ressourcen-URI: Geben Sie die Ressourcen-URI des jeweiligen modularen Leistungsprojekts an.

  • Attribute des modularen Leistungsprojekts aktualisieren

    • Abrufen der aktualisierten Details des modularen Leistungsprojekts über GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} und Kopieren des Etag-Werts aus der Kopfzeile der Antwort.
    • Aktualisieren Sie die Attribute des modularen Leistungsprojekts mit Hilfe der API PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} und geben Sie den Etag-Wert im If-Match-Schlüssel in der Kopfzeile an.

Nachdem die Änderungen abgeschlossen sind, kann der Lieferant nun das Angebot über die API POST/proposals/{proposalId}/action zurück an die Registrierungsstelle senden und die folgenden Details in der Anfrage angeben:

  • Aktion: Senden

  • Nachricht: Geben Sie einen Kommentar (falls vorhanden) für die Registrierungsreferenz an.

Registrieren Sie zusätzliche modulare Leistungsprojekte

Reichen Sie die umweltfreundliche Leistung zur Registrierung bei der ausstellenden Registrierungsstelle ein, indem Sie einen MBPRegister-Vorschlag erstellen und senden:

   POST/proposal

Überprüfen Sie ein modulares Leistungsprojekt

Sehen Sie sich die Details des Angebots an:

   GET/proposals/{proposalId}

Sehen Sie sich die gesamten Projektdetails an:

   GET/ecoProjects/{ecoProjectId}

Sehen Sie sich die Details des einzelnen modularen Leistungsprojekts des Projekts an:

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

Genehmigen Sie das Angebot oder lehnen Sie es ab, oder geben Sie es zur Überarbeitung zurück:

   POST/proposals/{proposalId}/action

Ansprüche verarbeiten

Dieser Abschnitt zeigt Ihnen, wie Sie Ansprüche über APIs verarbeiten können. Eine Anleitung zur Verwendung der Benutzeroberfläche finden Sie unter Ansprüche in Umwelt-Kreditservice verarbeiten.

Erstellen Sie Ansprüche

Erstellen Sie einen Anspruch:

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

Hochladen und Anhängen von Dateien an die Kontrollpunkte für Ansprüche:

   POST/files

Geben Sie die folgenden Details in der Anfrage an:

  • Datei oder Datei-URL
  • Tag
  • Ressourcen-URI des Anspruchs

Ansprüche senden

Erstellen und senden Sie den modularen Nutzen projectClaimVerify Vorschlag:

   POST/proposals

Details zum gesendeten Angebot ansehen:

   GET/proposal/{proposalId}

Details zum Anspruch ansehen:

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

Anspruch verifizieren

Angebote ansehen:

   GET/proposals

Details zu einem bestimmten Angebot abrufen:

   GET/proposals/{proposalId}

Holen Sie die Details eines bestimmten Anspruchs, für den das Angebot zur Überprüfung gesendet wurde:

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

Akzeptieren Sie die Aufgabe, den Anspruch zu überprüfen:

   POST/proposals/{proposalId}/action

Listen Sie die Dateien auf, die mit einem modularen Leistungsprojekt verbunden sind:

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

Auflisten der Dateien, die mit Anspruchs-Checkpoints verbunden sind:

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

Eine an eine bestimmte Anlage angehängte Datei ansehen:

   GET/files/{fileId}

Sobald der Anspruch angenommen wurde, wird ein entsprechender „Bearbeiteter Anspruch“ erstellt. Notieren Sie Ihre Überprüfungsergebnisse für den bearbeiteten Anspruch. Dies umfasst die Aktualisierung von Menge, Co-Leistungen des Anspruchs. Vor dem Einreichen der Kreditausstellungsanfrage müssen Sie die Kreditempfehlungen auch für die bearbeitete Forderung aktualisieren:

  • Rufen Sie die verarbeiteten Anspruchsdetails mit GET/processedClaims/{processed_claim_id} und kopieren Sie den Etag-Wert aus dem Antwortheader.
  • Aktualisieren Sie die Attribute des bearbeiteten Anspruchs mit Hilfe der API PATCH/processedClaims/{processed_claim_id} und geben Sie den Etag-Wert im If-Match-Schlüssel in der Kopfzeile an.

Für jeden Checkpoint, den Sie verifizieren, können Sie Ihre Verifizierungsergebnisse für das entsprechende Checkpoint-Ergebnis des verarbeiteten Anspruchs aktualisieren:

  • Laden Sie Ihre Überprüfungsergebnisberichte hoch und hängen Sie sie an die Checkpoint-Ergebnisse des verarbeiteten Anspruchs mit der POST/files-API an, und geben Sie die Datei- oder Datei-URL, das Tag und die ResourceUri (dies ist die Ressourcen-URI des Checkpoint-Ergebnisses) im Anfragetext an.
  • Aktualisieren Sie die Umweltauswirkungen vor und nach den Attributen des Prüfpunktergebnisses (falls erforderlich):
    • Rufen Sie die Prüfpunktergebnis-Details mit GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} und kopieren Sie den Etag-Wert aus dem Antwortheader.
    • Aktualisieren Sie die Attribute des Prüfpunktergebnisses mit Hilfe der PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} API und geben Sie den Etag-Wert im If-Match-Schlüssel in der Kopfzeile an.
    • Sie können die Prüfpunktergebnisse auch aktualisieren, indem Sie die Patch-API für verarbeitete Ansprüche verwenden.

Genehmigen Sie nach Abschluss der Überprüfung den MBPClaimVerify-Vorschlag oder lehnen Sie ihn ab:

   POST/proposals/{proposalId}/action

Geben Sie die folgenden Details an:

  • Aktion: Genehmigen oder Ablehnen

  • Nachricht: Geben Sie einen Kommentar (falls zutreffend) für die Lieferantenreferenz an.

Sobald der MBPClaimVerify-Vorschlag genehmigt wurde, erstellen und übermitteln Sie den CreditMint-Vorschlag, um die Kreditausstellungsanfrage einzureichen:

   POST/proposals/

Antrag auf Rückgabe eines Anspruchs für Bearbeitungen

Wenn der Anspruch Lücken aufweist oder falsche Angaben enthält, die der Lieferant korrigieren soll, können Validierungs- und Verifizierungs Body die Bearbeitung des Anspruchs verlangen, anstatt den Anspruch zu genehmigen oder abzulehnen. Diese Funktionalität ist nur über eine API verfügbar.

  1. Laden Sie Dateien (die Sie mit dem Lieferanten teilen möchten) hoch und hängen Sie sie an die bearbeitete Reklamation oder an das Checkpoint-Ergebnis der bearbeiteten Reklamation an: POST/files und geben Sie die folgenden Details im Anfragetext an

    • Datei oder Datei-URL
    • Tag
    • Ressourcen-URI des verarbeiteten Anspruchs oder Prüfpunktergebnis des verarbeiteten Anspruchs, dem die Datei hinzugefügt werden muss

  2. Verschieben Sie das MBPClaimVerify Angebot in den submitterActionNeeded Status, indem Sie die returnForEdits Aktion mit Hilfe der POST/proposals/{proposalId}/action API ausführen und die folgenden Details im Request Body angeben:

    • Aktion: ReturnForEdits
    • Nachricht: Geben Sie einen Kommentar (falls erforderlich) für die Lieferantenreferenz an, wenn Sie die Anfrage zur Bearbeitung zurücksenden.

Bearbeiten Sie das zurückgegebene Angebot

Lieferanten können nun das Angebot einsehen, das zur Überarbeitung zurückgeschickt wurde. Sie können jetzt die Attribute des Anspruchs und des Prüfpunkts bearbeiten und weitere Dateien zu den Prüfpunkten des Anspruchs hochladen:

  1. Angebot ansehen: GET/proposals/{proposalId}

    • Bei Bedarf kann der Lieferant auch die entsprechenden verarbeiteten Anspruchsdetails mit der API GET/processedClaims/{processed_claim_Id}.

  2. Laden Sie Dateien hoch und hängen Sie sie an die Prüfpunkte für den Anspruch an (falls vorhanden): POST/files und geben Sie die folgenden Details im Body der Anfrage an

    • Datei oder Datei-URL
    • Tag
    • Ressourcen-URI des Kontrollpunkts, zu dem die Datei hinzugefügt werden muss

  3. Aktualisieren Sie die Attribute des Anspruchs mit einem PATCH-Vorgang:

    • Rufen Sie die neuesten Details zu einem Anspruch ab und notieren Sie den ETag-Wert in der Kopfzeile der Antwort: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Aktualisieren Sie die Attribute des Anspruchs und geben Sie den Etag-Wert im 'If-Match'-Schlüssel der Kopfzeile der Anfrage an: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Aktualisieren Sie die Checkpoint-Attribute des Anspruchs mit einem PATCH-Vorgang:

    • Rufen Sie die letzten Checkpoint-Details ab und notieren Sie sich den ETag-Wert in der Kopfzeile der Antwort: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

    • Aktualisieren Sie die Attribute des Anspruchs und geben Sie den Etag-Wert im If-Match-Schlüssel des Anfrage-Headers an: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

      Notiz

      Achten Sie bei der Angabe der Aktualisierungsattribute darauf, dass der JSON Request Body der gleichen Struktur folgt wie beim entsprechenden get API-Aufruf.

  5. Nachdem die Änderungen vorgenommen wurden, kann der Lieferant das Angebot mit POST/proposals/{proposalId}/action API an die Validierungs- und Überprüfungsstelle senden und die folgenden Details im Request Body angeben:

    • Aktion: Erneut senden
    • Nachricht: Geben Sie einen Kommentar (falls erforderlich) für den Verweis auf den Validierungs- und Verifizierungsbody an.

Nachdem das Angebot erneut eingereicht wurde, können Validierungs- und Verifizierungs Body das Angebot überprüfen und genehmigen, ablehnen oder erneut um Änderungen bitten.

Antrag auf Ausstellung einer Gutschrift zurückziehen

Option zum Zurückziehen des gesendeten Antrags auf Gutschrift (CreditMint)proposal:

Nachdem der Antrag auf Ausstellung einer Gutschrift an die Registrierungsstelle gesendet wurde, können Sie das Angebot zurückziehen, wenn die Registrierungsstelle nicht auf den Antrag reagiert hat. Diese Funktionalität ist derzeit nur über APIs verfügbar.

  • Verschieben Sie den CreditMint Vorschlag, der sich im Status „submitted“ befindet, mit POST/proposals/{proposalId}/action API in den Status withdrawn und geben Sie die folgenden Details im Body der Anfrage an:

    • Aktion: Zurückziehen
    • Nachricht: Geben Sie den Grund (falls zutreffend) für das Zurückziehen des Angebots für die Registerreferenz an.

Der Status des Angebots lautet jetzt Zurückgezogen.

Nachdem der Kreditausstellungsantrag zurückgezogen wurde, kann die Validierungs- und Verifizierungsstelle den „bearbeiteten Anspruch“ und die zugehörigen Prüfpunktergebnisse ändern und dann den Kreditausstellungsantrag erneut einreichen.

  • Hochladen und Anhängen von Dateien des verarbeiteten Anspruchs von Prüfpunktergebnisse: POST/files und geben Sie die folgenden Details an:

    • Datei oder Datei-URL
    • Tag
    • ResourceURI des zugeordneten Prüfpunktergebnisses.

  • Aktualisieren Sie die Attribute des verarbeiteten Anspruchs: PATCH/processedClaims/{processedClaim_Id}

  • Senden Sie die Ausstellungsanforderung erneut an die Registrierungsstelle und geben Sie die folgenden Details im API-Anfragetext an: POST/proposals/{ Vorschlags-ID}/Aktion

    • Aktion: Angeben als Erneut senden
    • Nachricht: Geben Sie eine Nachricht/Kommentar (falls zutreffend) für die Registrierungsreferenz an

Gutschriften ausstellen

In diesem Abschnitt erfahren Sie, wie Sie Gutschriften über APIs anzeigen und ausgeben können. Anweisungen zur Verwendung der Benutzeroberfläche finden Sie unter Gutschriften in Umwelt-Kreditservice ausstellen.

Vorschläge zur Gutschrift überprüfen

Sehen Sie sich den eingereichten „Token mint“-Vorschlag an und rufen Sie den Ressourcen-URI „verarbeiteter Anspruch“ ab, der zur Überprüfung eingereicht wurde:

GET/proposal/{proposalId}

Überprüfen Sie die Verifizierungsergebnisse der Validierungs- und Verifizierungsstelle, indem Sie den verarbeiteten Anspruch und die zugehörigen Checkpoint-Ergebnisse (zusammen mit den zugehörigen Dateien) anzeigen:

GET/processedClaims/{processedClaims_Id}

Sehen Sie sich den Anspruch und die entsprechenden Prüfpunkte an (zusammen mit einer Liste der Dateien, die der Lieferant für die Prüfpunkte angehängt hat):

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

Sehen Sie sich die Details des modularen Leistungsprojekts an, zusammen mit der Liste der angehängten Dateien:

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

Laden Sie eine Datei mit Hilfe der Datei-ID herunter:

   GET/files/{fileId}

Gutschriften genehmigen

Laden Sie Dateien hoch, die Sie der Gutschrift zur Ausstellung beifügen möchten: POST/files und geben Sie die folgenden Details im Body der Anfrage an:

  • Datei oder Datei-URL
  • Tag

Genehmigen Sie das Angebot:

   POST/proposals/{proposalId}/action

Geben Sie die folgenden Details im Body der Anfrage an:

  • Aktion: angeben als Mint
  • Nachricht: Geben Sie die Nachricht (falls erforderlich) für den Verweis auf den Validierungs- und Verifizierungsbody an
  • Datei-IDs: Geben Sie die Datei-IDs der hochgeladenen Dateien an, damit die Dateien an die ausgestellte Gutschrift angehängt werden
  • Menge
  • Jahrgang
  • Anlagen-ID
  • Ermittelter Wert

Anmerkung

Wenn das Angebot genehmigt wird, wird eine entsprechende Gutschrift erstellt.

Ein Angebot ablehnen

Hochladen von Dateien (falls vorhanden) für den verarbeiteten Anspruch: POST/files und Angabe der folgenden Details:

  • Datei oder Datei-URL
  • Tag

Lehnen Sie das Angebot ab:

   POST/proposals/{proposalId}/action

Geben Sie die folgenden Details im Body der Anfrage an:

  • Aktion: Ablehnen
  • Nachricht: Geben Sie eine Nachricht (falls zutreffend) für die Referenz der Validierungs- und Verifizierungsstelle an
  • Datei-IDs: Geben Sie hier die Datei-IDs der hochgeladenen Datei an, damit diese an den entsprechenden Anspruch des verarbeiteten Anspruchs angehängt werden.

Antrag auf Ausstellung von Gutschriften zur Bearbeitung zurückgeben

Wenn der Erteilungsantrag Lücken oder falsche Angaben enthält, die von der Validierungs- und Verifizierungsstelle korrigiert werden sollen, können Sie eine Bearbeitung des Erteilungsantrags beantragen. Diese Funktionalität ist nur über eine API verfügbar.

  1. Hochladen von Dateien (falls vorhanden), die Sie mit der Validierungs- und Überprüfungsstelle teilen möchten, als Teil der Rücksendung der Ausgabeanforderung für Bearbeitungen.

  2. Verschieben Sie den Antrag auf Ausstellung (CreditMint Angebot) in den Status submitterActionNeeded mit Hilfe von POST/proposals/{proposalId}/action API und geben Sie die folgenden Details an:

    • Aktion: ReturnForEdits
    • Nachricht: Geben Sie eine Nachricht (falls zutreffend) für den Verweis auf den Validierungs- und Verifizierungsbody an, damit sie den Grund für die Bearbeitungsanfrage verstehen können.
    • Datei-IDs: Geben Sie die Datei-IDs der hochgeladenen Dateien (falls vorhanden) an, damit die Dateien an den zugehörigen verarbeiteten Anspruchs angehängt werden.

Die Validierungs- und Überprüfungsstelle kann nun das Angebot einsehen, das zur Bearbeitung zurückgeschickt wurde. Sie können jetzt auch die entsprechenden verarbeiteten Anspruchs- und Prüfpunktergebnisse bearbeiten. Sie können Attribute aktualisieren sowie aktualisierte Dateien in die Prüfpunktergebnisse hochladen.

Falls erforderlich, kann die Validierungs‑ und Verifizierungsstelle an dieser Stelle um Klärung der verifizierten Behauptung bitten, indem sie die Behauptung zur Bearbeitung an den Lieferanten zurücksendet. Sobald der Lieferant die Forderung erneut einreicht, kann die Validierungs‑ und Verifizierungsstelle die Forderung überprüfen und verifizieren, die entsprechende bearbeitete Forderung aktualisieren und dann den Ausstellungsantrag erneut an die Registrierungsstelle senden.

  1. Hochladen und Anhängen von Dateien von Prüfpunktergebnisse: POST/files und geben Sie die folgenden Details an:

    • Datei oder Datei-URL
    • Tag
    • ResourceURI des zugeordneten Prüfpunktergebnisses

  2. Aktualisieren Sie die Attribute des verarbeiteten Anspruchs einschließlich der Kreditempfehlung: PATCH/processedClaim/{processed claim id}

  3. Senden Sie die Ausstellungsanforderung erneut an die Registrierungsstelle und geben Sie die folgenden Details unten im API-Anfragetext an: POST/proposals/{ Vorschlags-ID}/Aktion

    • Aktion: Erneut senden
    • Nachricht: Geben Sie eine Nachricht (falls erforderlich) für die Referenz des Registers an

Nachdem die Anfrage erneut eingereicht wurde, kann das ausstellende Register die Anfrage überprüfen und genehmigen, ablehnen oder erneut um Änderungen bitten.

Ausgegebene Gutschriften ansehen

   GET/credits

Gutschriften suchen und ansehen

Holen Sie alle Gutschriften:

   GET/credits

Anmerkung

Diese API gibt die Liste aller Gutschriften zurück. Käufer können die Liste dann selbst nach dem Status der Gutschriften filtern, um nur die gelisteten Gutschriften anzuzeigen.

Sehen Sie sich die Details zu einer Gutschrift (einschließlich der Abstammung) an, die in der Liste angezeigt wird:

   GET/credits/{creditId}/lineage

Gutschriften auflisten

In diesem Abschnitt erfahren Sie, wie Sie Gutschriften über APIs auf einem Marketplace zum Handel anbieten können. Eine Anleitung zur Verwendung der Benutzeroberfläche finden Sie unter Gutschriften im Umwelt-Kreditservice auflisten.

Registrieren Sie sich als Käufer oder als Marketplace

Reichen Sie den MarketplaceTraderRegister-Vorschlag als Gutschriftsinhaber oder Käufer ein:

   POST/proposals

Rufen Sie alle MarketplaceTraderRegister-Vorschläge als Marktplatz ab und überprüfen Sie sie:

   GET/proposals

Genehmigen Sie die Angebote als Marketplace oder lehnen Sie sie ab:

   POST/proposals/{proposalId}/action

Alle Händler, die auf ihrer Plattform als Marketplace registriert sind, abrufen und ansehen:

   GET/marketplaces/{marketplaceId}/traders

Angebot zur Auflistung einer Gutschrift senden

MarketplaceListingRegister-Vorschlag erstellen und einreichen:

   POST/proposals

Angebot zur Auflistung einer Gutschrift überprüfen

   GET/proposals

   POST /proposals/{proposalId}/action

Gutschriften verwalten

Dieser Abschnitt zeigt Ihnen, wie Sie Gutschriften über APIs verwalten können. Eine Anleitung zur Verwendung der Benutzeroberfläche finden Sie unter Gutschriften im Umwelt-Kreditservice verwalten.

Eine Gutschrift auslisten

Die Aufteilung eines Kredits ist ein unabhängiger Vorgang im Umwelt-Kreditservice. Informationen zum Aufteilen einer Gutschrift über die API finden Sie unter Gutschrift aufteilen. Nachdem die Gutschrift gesplittet wurde, können Sie mit dem nächsten Schritt fortfahren.

MarketplaceListingDeregister-Vorschlag erstellen und einreichen:

   POST/proposals

Sehen Sie sich alle zur Überprüfung eingereichten MarketplaceListingDeregister-Vorschläge an:

   GET/proposals

Um das Angebot zu genehmigen oder abzulehnen:

   POST/proposals/{proposalId}/action

Eigentum übertragen

   POST/credits/{creditId}/transfer/

Gutschrift anzeigen

Organisationen mit einer Lieferanten- und Registerrolle können den Verlauf der Gutschriften einsehen, die sie besitzen oder ausgestellt haben:

   GET/credits/{creditId}/lineage

Eine Gutschrift aufteilen

Sie können eine Gutschrift in untergeordnete Gutschriften aufteilen. Diese Funktion ist derzeit nur über die API verfügbar.

Teilen Sie die Gutschrift auf, indem Sie die Mengen (in mtCO2e) für mindestens zwei untergeordnete Gutschriften als Besitzer der Gutschrift (für die Gutschriften, die sie besitzen) oder als Marketplace (für die Gutschriften, die auf ihrer Plattform aufgeführt sind) angeben:

   POST/credits/{creditId}/split

Auflistung von Gutschriften übertragen

Ein Marketplace kann eine Gutschrift von seiner Plattform auf einen anderen Marketplace übertragen. Diese Übertragung wird auch als Übertragung der Belastung bezeichnet. Beim traditionellen Flow würde ein Lieferant die Gutschriften auf einem Marketplace anbieten, der den Bedarf, das Clearing und die Abrechnung übernimmt. Manchmal ist ein Marketplace nicht in der Lage, das Clearing und die Abrechnung von Zahlungen selbst vorzunehmen und ist dafür auf eine andere Plattform angewiesen. In diesem Fall muss die Anlage auf den neuen Marketplace übertragen werden, um die Transaktion abzuschließen. Diese Funktion ist derzeit nur über APIs verfügbar.

Als Marktplatz erstellen und übermitteln Sie den MarketplaceListingTransfer-Vorschlag für eine auf Ihrer Plattform gelistete Gutschrift:

   POST/proposals

Sehen Sie sich als Genehmiger-Marktplatz alle MarketplaceListingTransfer-Vorschläge an, die ihm zur Prüfung vorgelegt wurden:

   GET/proposals

Als genehmigender Marketplace genehmigen Sie das Angebot oder lehnen es ab. Wenn das Angebot genehmigt wird, wird die Gutschrift vom ursprünglichen Marktplatz auf den Marktplatz des Genehmigers übertragen:

   POST/proposals/{proposalId}/action

Teilweise Übertragung von Lasten: Ein Marketplace kann Lasten für eine Teilgutschrift übertragen, indem er die Gutschrift zunächst als unabhängige Aktion aufteilt. Informationen darüber, wie Sie eine Gutschrift aufteilen können, finden Sie unter Gutschrift aufteilen. Nachdem die Gutschrift geteilt wurde, fahren Sie mit den oben genannten Schritten für die Übertragung der Belastung für untergeordnete Gutschriften fort.

Emissionsziele festlegen

In diesem Abschnitt erfahren Sie, wie Sie Emissionsziele und -vorgaben über APIs festlegen können.

Erzeugen von Emissionszielen

   POST/esgs

Emissionsziele ansehen

   GET/esgs

Emissionen verfolgen

In diesem Abschnitt erfahren Sie, wie Sie Ihre Emissionen anhand der von Ihnen über APIs festgelegten Scorecard für Emissionen verfolgen können. Eine Anleitung zur Verwendung der Benutzeroberfläche finden Sie unter Emissionsziele im Umwelt-Kreditservice verfolgen.

Erstellen Sie Meilensteine für einen bestimmten Berichtszeitraum

   POST/esgs/{esgScorecardId}/milestones

Holen Sie alle Meilensteine:

   GET/esgs/{esgScorecardId}/milestones

Abrufen eines bestimmten Meilensteins:

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

Verfolgen Sie die tatsächlichen Emissionen anhand des Meilensteins

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

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

Gutschriften ausbuchen

In diesem Abschnitt erfahren Sie, wie Sie überschüssige Emissionen ausgleichen können, indem Sie CO2-Gutschriften über APIs aus dem Verkehr ziehen. Eine Anleitung zur Verwendung der Benutzeroberfläche finden Sie unter Gutschriften ausbuchen im Umwelt-Kreditservice.

Angebot für Gutschrift ausbuchen senden

Erstellen und senden Sie ein ESGEmissionOffset Angebot:

   POST/proposals

Käufer können CO2-Gutschriften auch direkt ausbuchen, ohne die zu kompensierenden Emissionen anzugeben. Diese Funktion ist nur über die API verfügbar.

CreditRetire-Vorschlag erstellen und senden:

   POST/proposals

Angebot zur Gutschrift ausbuchen überprüfen

   GET/proposals

   GET/proposals/{proposalId}

Hängen Sie eine Datei an die Gutschrift an, die für den Ruhestand geprüft wird:

   POST/files

   POST/proposals/{proposalId}/action

Teilweise Gutschrift ausbuchen

Informationen zum Aufteilen einer Gutschrift über die API finden Sie unter Gutschrift aufteilen.

Nachdem die Gutschrift gesplittet wurde, verwenden Sie die APIs in den vorherigen Schritten für die Verrechnung und den Ausstieg.

Dateien verwalten

In diesem Abschnitt erfahren Sie, wie Sie Dateien für Anlagen wie Projekte, Ansprüche und Gutschriften über APIs anhängen, anzeigen und löschen können. Eine Anleitung zur Verwendung der Benutzeroberfläche finden Sie unter Dateien im Umwelt-Kreditservice verwalten.

Dateien anfügen

Verwenden Sie die POST/files API, um eine Datei an eine Anlage anzuhängen. Sie müssen die folgenden Details angeben:

  • Datei oder Datei-URI
  • Ressourcen-URI der Anlage
  • Beschreibendes Tag für die Datei

Dateien anzeigen

Sehen Sie sich die Liste der Dateien zusammen mit den Dateieigenschaften für eine Anlage über die API für Anlagendetails an:

Modulares Leistungsprojekt:

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

Ansprüche:

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

Kontrollpunkte für Ansprüche:

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

Gutschrift:

   GET/credits/{creditId}

Verwenden Sie die Datei-ID, die in den Dateieigenschaften der Datei enthalten ist, um die Datei herunterzuladen:

   GET/files/{fileId}

Dateien löschen

Verwenden Sie die Datei-ID der Datei, um die Lösch-API aufzurufen:

   DELETE/files/{fileId}

Überblick zum Environmental Credit Service
Environmental Credit Service konfigurieren
Glossar zum Environmental Credit Service

📄 Produktseite
🎓 Schulung

✅ Kostenloser Test
🎥 YouTube Kanal

💻 Community
LinkedIn-Symbol.LinkedIn-Gruppe