Delen via

Overzicht van API-referentie voor Service voor milieucredits

  • Artikel

Gratis proefperiode

Belangrijk

Een gedeelte van of alle functionaliteit is beschikbaar als onderdeel van een preview-release. De inhoud en functionaliteit zijn aan verandering onderhevig. U hebt toegang tot de Sandbox-omgeving van Service voor milieucredits (preview) voor een proefperiode van 30 dagen. Als u Service voor milieucredits (preview) wilt gebruiken in een productieomgeving, gaat u naar het Aanmeldingsformulier van Service voor milieucredits (preview).

Dit artikel helpt u bij het uitvoeren van taken met de REST-API's voor Service voor milieucredits. Ga voor de volledige API-referentie naar API-referentie voor Service voor milieucredits. U vindt het Swagger-bestand op REST-API's voor Service voor milieucredits.

Projecten registreren

In dit gedeelte wordt uitgelegd hoe u ecologische projecten kunt maken, indienen en beoordelen via API's. Ga voor instructies over het gebruik van de gebruikersinterface naar Projecten registreren in Service voor milieucredits.

Een project maken

Bestanden uploaden en bijvoegen op het moment dat het project wordt gemaakt:

  1. Upload bestanden met behulp van POST/files. Geef de volgende gegevens op in de API:

    • Bestand of bestands-URL
    • Een beschrijvend label voor het bestand

  2. Maak het ecologische project en het bijbehorende modulaire voordeelproject en geef de fileID op die wordt geretourneerd in de respons van de API-aanroep van POST/files als een kenmerk in de API-aanvraagbody voor het maken van projecten: POST/ecoprojects.

Een project opslaan en indienen

Haal de details van het project op:

   GET/ecoProjects/{ecoProjectId}

Bekijk de lijst met bestanden (en de bijbehorende metagegevens) die zijn gekoppeld aan het modulaire voordeelproject:

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

Download een bestand met behulp van de fileID die beschikbaar is als onderdeel van de metagegevens van het bestand:

   GET/files/{fileId}

Voeg bestanden toe aan het modulaire voordeelproject:

   POST/files

Geef de resource-URI van het modulaire voordeelproject op in de aanvraagbody.

Dien een modulair voordeelproject in voor registratie door het indienen van een MBPRegister-voorstel:

   POST/proposals

Een project weergeven

Haal alle voorstellen op:

   GET/proposals

Haal details van een specifiek voorstel op:

   GET/proposals/{proposalId}

Haal details van een specifiek ecologisch project op:

   GET/ecoProjects/{ecoProjectId}

Haal details op van het specifieke modulaire voordeelproject dat u wilt bekijken:

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

Download de lijst met bestanden (en de bijbehorende metagegevens) die aan het modulaire uitkeringsproject zijn gekoppeld:

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

Download de bestanden met behulp van de fileId die beschikbaar is als onderdeel van de vorige API-respons:

   GET/files/{fileId}

Voeg een bestand toe aan het modulaire voordeelproject:

   POST/files

Een voorstel goedkeuren of afwijzen

Upload bestanden (indien aanwezig):

POST/files en geef File (of FileUrl) en labeldetails op

Wijs de registratieaanvraag af:

POST/proposals/{proposalId}/action en geef de volgende details in de aanvraagbody op

  • Actie: Afwijzen

  • Bericht: geef een opmerking (indien aanwezig) op die u wilt opgeven voor het afwijzen van de registratie.

  • FileIDs: geef de bestands-id's op van de bestanden die zijn geüpload.

Een bestand verwijderen

Bekijk de lijst met bestanden die zijn gekoppeld aan het modulaire voordeelproject:

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

Identificeer het bestand dat u hebt geüpload, omdat een gebruiker alleen de bestanden kan verwijderen die deze heeft geüpload.

Verwijder het bestand:

   DELETE/files/{fileId}

Een voorstel voor bewerkingen terugsturen

Als er hiaten of onjuiste details zijn in de projectkenmerken of -bestanden waarvan u wilt dat de leverancier deze corrigeert of toevoegt, kunt u om bewerkingen van het project vragen.

  1. Upload eventueel bestanden die gedeeld moeten worden met de leverancier:

    POST/files

  2. Plaats het voorstel MBPRegister in de status submitterActionNeeded door de actie returnForEdits te gebruiken met de API POST/proposals/{proposalId}/action en geef de volgende details in de aanvraagbody op:

    • Actie: returnForEdits

    • Bericht: geef een opmerking op (indien vereist) ter referentie voor de leverancier bij het terugsturen van de aanvraag om bewerkingen.

    • Bestands-id's: geef hier de bestands-id van het geüploade bestand op om het bestand aan het betreffende modulaire voordeelproject te koppelen.

    Nadat dit is gedaan, krijgt het modulaire voordeelproject de status returnedForEdits.

Leveranciers kunnen nu het voorstel bekijken dat voor bewerking is teruggestuurd. Ze kunnen nu de kenmerken van het modulaire voordeelproject bewerken en meer bestanden uploaden naar het modulaire voordeelproject.

  • Voorstel bekijken: GET/proposals/{proposalId}

  • Upload bestanden en voeg ze toe aan het modulaire voordeelproject: POST/files en geef de volgende details in de aanvraagbody op:

    • Bestand of bestands-URL
    • Tag: een beschrijvend label voor het bestand
    • ResourceURI: geef de resource-URI op van het respectieve modulaire voordeelproject.

  • Kenmerken van het modulaire voordeelproject bijwerken

    • Haal de bijgewerkte details van het modulaire voordeelproject op met behulp van GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} en kopieer de Etag-waarde uit de responskoptekst.
    • Werk de kenmerken van het modulaire voordeelproject bij met behulp van de API PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} en geef de Etag-waarde in de sleutel If-Match in de koptekst op.

Nadat de wijzigingen zijn voltooid, kan de leverancier het voorstel nu terugsturen naar het register met behulp van de API POST/proposals/{proposalId}/action en de volgende details in de aanvraag opgeven:

  • Actie: Indienen

  • Bericht: geef een opmerking op (indien aanwezig) voor registerreferentie.

Aanvullende modulaire voordeelprojecten registreren

Dien het ecologische voordeel voor registratie in bij het uitgevende register door een MBPRegister-voorstel te maken en in te dienen:

   POST/proposal

Een modulair voordeelproject beoordelen

Geef de voorsteldetails weer:

   GET/proposals/{proposalId}

Geef de volledige projectdetails weer:

   GET/ecoProjects/{ecoProjectId}

Geef de details van het individuele modulaire voordeelproject van het project weer:

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

Keur het registratievoorstel goed of wijs het af of stuur het terug voor bewerkingen:

   POST/proposals/{proposalId}/action

Claims verwerken

In dit gedeelte ziet u hoe u claims via API's kunt verwerken. Ga voor instructies over het gebruik van de gebruikersinterface naar Claims verwerken in Service voor milieucredits.

Claims maken

Maak een claim:

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

Upload bestanden en koppel ze aan claimcontrolepunten:

   POST/files

Geef de volgende details in de aanvraag op:

  • Bestand of bestands-URL
  • Tag
  • Resource-URI van de claim

Claims indienen

Maak het ClaimVerify-voorstel van het modulaire voordeelproject en dien het in:

   POST/proposals

Geef details van het ingediende voorstel weer:

   GET/proposal/{proposalId}

Geef details van de claim weer:

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

Claim verifiëren

Geef voorstellen weer:

   GET/proposals

Haal de details van een specifiek voorstel op:

   GET/proposals/{proposalId}

Haal de details op van een specifieke claim waarvoor het verificatievoorstel is ingediend:

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

Accepteer de taak om de claim te verifiëren:

   POST/proposals/{proposalId}/action

Maak een lijst van de bestanden die zijn gekoppeld aan een modulair voordeelproject:

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

Maak een lijst van de bestanden die zijn gekoppeld aan claimcontrolepunten:

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

Geef een bestand weer dat is gekoppeld aan een specifiek activum:

   GET/files/{fileId}

Zodra de claim is geaccepteerd, wordt een overeenkomstige 'Verwerkte claim' gemaakt. Leg uw verificatiebevindingen met betrekking tot de verwerkte claim vast. Dit omvat het bijwerken van hoeveelheid, co-voordelen van de claim. Voordat u de credituitgifteaanvraag indient, moet u de creditaanbevelingen ook bijwerken voor de verwerkte claim:

  • Haal de verwerkte claimgegevens op met behulp van GET/processedClaims/{processed_claim_id} en kopieer de Etag-waarde uit de responsheader.
  • Werk de kenmerken van de verwerkte claim bij met behulp van de API PATCH/processedClaims/{processed_claim_id} en geef de Etag-waarde in de sleutel If-Match in de header op.

Voor elk controlepunt dat u verifieert, kunt u uw verificatiebevindingen bijwerken in het overeenkomstige controlepuntresultaat van de verwerkte claim:

  • Upload uw verificatiebevindingsrapporten en voeg ze toe aan de controlepuntresultaten van de verwerkte claim met behulp van de API POST/files en geef het bestand of de bestands-URL, tag en ResourceUri op (dit wordt de resource-URI van het controlepuntresultaat) in de aanvraagtekst.
  • Werk het omgevingseffect bij vóór en na de kenmerken van het controlepuntresultaat (indien nodig):
    • Haal de details van de controlepuntresultaten op met behulp van GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} en kopieer de Etag-waarde uit de responsheader.
    • Werk de kenmerken van het controlepuntresultaat bij met behulp van de API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} en geef de Etag-waarde in de sleutel If-Match in de header op.
    • U kunt de controlepuntresultaten ook bijwerken met behulp van de patch-API voor verwerkte claims.

Nadat de verificatie is voltooid, keurt u het MBPClaimVerify-voorstel goed of wijst u het af:

   POST/proposals/{proposalId}/action

Geef de volgende gegevens op:

  • Actie: Goedkeuren of Afwijzen

  • Bericht: geef een opmerking op (indien aanwezig) ter referentie voor de leverancier.

Zodra het MBPClaimVerify-voorstel is goedgekeurd, maakt u het CreditMint-voorstel en dient u het in om de credituitgifteaanvraag in te dienen:

   POST/proposals/

Claimaanvraag terugsturen voor bewerkingen

Als er hiaten of onjuiste details zijn in de claimaanvraag waarvan de validatie- en verificatie-instantie wil dat de leverancier deze corrigeert, kunt u om bewerkingen van de claimaanvraag vragen in plaats van de aanvraag goed te keuren of af te wijzen. Deze mogelijkheid is alleen beschikbaar via API.

  1. Upload bestanden (die u met de leverancier wilt delen) en voeg deze toe aan de verwerkte claim of aan het controlepuntresultaat van de verwerkte claim: POST/files en geef de volgende details op in de aanvraagtekst

    • Bestand of bestands-URL
    • Tag
    • Resource-URI van de verwerkte claim of controlepuntresultaat van de verwerkte claim waaraan het bestand moet worden toegevoegd

  2. Plaats het voorstel MBPClaimVerify in de status submitterActionNeeded door de actie returnForEdits te gebruiken met de API POST/proposals/{proposalId}/action en geef de volgende details in de aanvraagbody op:

    • Actie: returnForEdits
    • Bericht: geef een opmerking op (indien vereist) ter referentie voor de leverancier bij het terugsturen van de aanvraag om bewerkingen.

Het teruggestuurde voorstel bewerken

Leveranciers kunnen vervolgens het voorstel bekijken dat voor bewerking is teruggestuurd. Ze kunnen nu de claim- en controlepuntkenmerken bewerken en ze kunnen meer bestanden uploaden naar de claimcontrolepunten:

  1. Voorstel bekijken: GET/proposals/{proposalId}

    • Indien nodig kan de leverancier ook de bijbehorende verwerkte claimgegevens bekijken via de API GET/processedClaims/{processed_claim_Id}.

  2. Upload bestanden (indien aanwezig) en koppel ze aan de claimcontrolepunten: POST/files en geef de volgende details in de aanvraagbody op

    • Bestand of bestands-URL
    • Tag
    • Resource-URI van het controlepunt waaraan het bestand moet worden toegevoegd

  3. Werk claimkenmerken bij met een PATCH-bewerking:

    • Haal de laatste claimdetails op en noteer de ETag-waarde in de responskoptekst: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Werk de claimkenmerken bij en geef de Etag-waarde op in de sleutel ‘If-Match’ van de aanvraagkoptekst: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

  4. Werk de controlepuntkenmerken van de claim bij met een PATCH-bewerking:

    • Haal de laatste controlepuntdetails op en noteer de ETag-waarde in de responskoptekst: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

    • Werk de claimkenmerken bij en geef de Etag-waarde op in de sleutel If-Match van de aanvraagkoptekst: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

      Notitie

      Zorg er bij het opgeven van de updatekenmerken voor dat de JSON-aanvraagbody dezelfde structuur volgt als in de overeenkomstige API-aanroep Get.

  5. Nadat de wijzigingen zijn aangebracht, kan de leverancier het voorstel vervolgens terugsturen naar de validatie- en verificatie-instantie met behulp van de API POST/proposals/{proposalId}/action en de volgende details in de aanvraagbody opgeven:

    • Actie: Opnieuw indienen
    • Bericht: geef eventuele opmerkingen op (indien vereist) ter referentie voor de validatie- en verificatie-instantie.

Nadat het voorstel opnieuw is ingediend, kan de validatie- en verificatie-instantie het voorstel beoordelen en goedkeuren, afwijzen of opnieuw vragen om bewerkingen.

De credituitgifteaanvraag intrekken

Optie om het ingediende voorstel van de credituitgifteaanvraag (CreditMint) in te trekken:

Nadat het voorstel voor credituitgifte bij het register is ingediend, kunt u in het geval van problemen waardoor u het ingediende voorstel wilt intrekken, het ingediende voorstel intrekken als het register niet op het voorstel heeft gereageerd. Deze mogelijkheid is momenteel alleen beschikbaar voor API´s.

  • Plaats het CreditMint-voorstel met de status Ingediend in de status Ingetrokken met behulp van de API POST/proposals/{proposalId}/action en geef de volgende details in de aanvraagtekst op:

    • Actie: Intrekken
    • Bericht: geef de reden (indien van toepassing) op voor het intrekken van het voorstel ter referentie voor het register.

De status van het voorstel is nu Ingetrokken.

Nadat de credituitgifteaanvraag is ingetrokken, kan de validatie- en verificatie-instantie de 'verwerkte claim' en de bijbehorende controlepuntresultaten wijzigen en vervolgens de credituitgifteaanvraag opnieuw indienen.

  • Upload bestanden en voeg ze toe aan de controlepuntresultaten van de verwerkte claim: POST/files en geef de volgende details op:

    • Bestand of bestands-URL
    • Tag
    • ResourceURI van het bijbehorende controlepuntresultaat.

  • Werk de kenmerken van de verwerkte claim bij: PATCH/processedClaims/{processedClaim_Id}

  • Dien de uitgifteaanvraag opnieuw in bij het register en specificeer de volgende details in de API-aanvraagtekst: POST/proposals/{ proposal_id}/action

    • Actie: geef deze op als Opnieuw indienen
    • Bericht: geef een bericht/opmerking op (indien aanwezig) ter referentie voor het register

Credits uitgeven

In dit gedeelte wordt uitgelegd hoe u credits kunt weergeven en uitgeven via API's. Ga voor instructies over het gebruik van de gebruikersinterface naar Credits uitgeven in Service voor milieucredits.

Credituitgiftevoorstellen beoordelen

Bekijk het ingediende 'Token mint'-voorstel en haal de 'verwerkte claim'-resource-URI op die ter beoordeling is ingediend:

GET/proposal/{proposalId}

Bekijk de verificatiebevindingen van de validatie- en verificatie-instantie door de verwerkte claim en de bijbehorende controlepuntresultaten (samen met de bijbehorende bestanden) te bekijken:

GET/processedClaims/{processedClaims_Id}

Geef de claim en bijbehorende controlepuntdetails weer (samen met een lijst met bestanden die door de leverancier zijn bijgevoegd voor de controlepunten):

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

Geef samen met de lijst met bijgevoegde bestanden de details van het modulaire voordeelproject weer:

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

Download een bestand met de bestands-id:

   GET/files/{fileId}

Credits goedkeuren

Upload bestanden die u wilt koppelen aan de credituitgifte: POST/files en geef de volgende details in de aanvraagbody op:

  • Bestand of bestands-URL
  • Tag

Keur het voorstel goed:

   POST/proposals/{proposalId}/action

Geef de volgende details in de aanvraagbody op:

  • Actie: geef deze op als Mint
  • Bericht: geef het eventuele bericht op ter referentie voor de validatie- en verificatie-instantie
  • Bestands-id's: geef de bestands-id's van de geüploade bestanden op zodat de bestanden aan de uitgegeven credit worden gekoppeld
  • Aantal
  • Vintage
  • Activum-id
  • Bepaalde waarde

Notitie

Wanneer het voorstel wordt goedgekeurd, wordt een bijbehorende credit gemaakt.

Een voorstel afwijzen

Upload bestanden (indien aanwezig) naar de verwerkte claim: POST/files en geef de volgende details op:

  • Bestand of bestands-URL
  • Tag

Wijs het voorstel af:

   POST/proposals/{proposalId}/action

Geef de volgende details in de aanvraagbody op:

  • Actie: Afwijzen
  • Bericht: geef een bericht (indien aanwezig) op ter referentie voor de validatie- en verificatie-instantie
  • Bestands-id's: geef de bestands-id´s van het geüploade bestand op zodat deze worden gekoppeld aan de bijbehorende verwerkte claim.

Aanvraag voor credituitgifte terugsturen voor bewerkingen

Als er hiaten of onjuiste details zijn in de uitgifteaanvraag waarvan u wilt dat de validatie- of verificatie-instantie deze corrigeert, kunt u om bewerkingen van de uitgifteaanvraag vragen. Deze mogelijkheid is alleen beschikbaar via API.

  1. Upload bestanden (indien aanwezig) die u wilt delen met de validatie- en verificatie-instantie als onderdeel van het terugzenden van de uitgifteaanvraag voor bewerkingen.

  2. Plaats de uitgifteaanvraag (CreditMint-voorstel) in de status submitterActionNeeded met behulp van de API POST/proposals/{proposalId}/action en geef de volgende details op:

    • Actie: ReturnForEdits
    • Bericht: geef een bericht op (indien aanwezig) ter referentie voor de validatie- en verificatie-instantie, zodat de reden voor de bewerkingsaanvraag duidelijk is.
    • Bestands-id's: geef de bestands-id´s van de geüploade bestanden (indien aanwezig) op zodat de bestanden worden gekoppeld aan de bijbehorende verwerkte claim.

De validatie- en verificatie-instantie kan nu het voorstel bekijken dat voor bewerking is teruggestuurd. De bijbehorende verwerkte claim en controlepuntresultaten kunnen nu ook worden bewerkt. Kenmerken kunnen worden bijgewerkt en bijgewerkte bestanden kunnen worden geüpload naar de controlepuntresultaten.

Indien nodig kan de validatie- en verificatie-instantie op dit moment om opheldering vragen over de geverifieerde claim door de claim voor bewerking terug te sturen naar de leverancier. Zodra de leverancier de claim opnieuw indient, kan de validatie- en verificatie-instantie de claim beoordelen en verifiëren, de overeenkomstige verwerkte claim bijwerken en vervolgens de uitgifteaanvraag opnieuw indienen bij het register.

  1. Upload bestanden en voeg ze toe aan de controlepuntresultaten: POST/files en geef de volgende details op:

    • Bestand of bestands-URL
    • Tag
    • ResourceURI van de bijbehorende controlepuntresultaten

  2. Werk de kenmerken van de verwerkte claim bij, inclusief de creditaanbeveling: PATCH/processedClaim/{processed claim id}

  3. Dien de uitgifteaanvraag opnieuw in en specificeer de onderstaande details in de API-aanvraagtekst: POST/proposals/{ proposal_id}/action

    • Actie: Opnieuw indienen
    • Bericht: geef een bericht (indien aanwezig) op ter referentie voor het register

Nadat de aanvraag opnieuw is ingediend, kan het uitgevende register de aanvraag weergeven en goedkeuren, afwijzen of opnieuw vragen om bewerkingen.

Uitgegeven credits weergeven

   GET/credits

Credits zoeken en weergeven

Haal alle credits op:

   GET/credits

Notitie

Deze API retourneert de lijst met alle credits. Kopers kunnen de lijst vervolgens zelf filteren op basis van creditstatus om alleen vermelde credits weer te geven.

Geef de creditdetails weer (inclusief herkomst) voor een specifieke credit die in de lijst wordt weergegeven:

   GET/credits/{creditId}/lineage

Credits weergeven

In dit gedeelte wordt uitgelegd hoe u via API´s credits op een marketplace kunt weergeven om te verhandelen. Ga voor instructies over het gebruik van de gebruikersinterface naar Credits weergeven in Service voor milieucredits.

Registratie als koper op een marketplace

Dien het MarketplaceTraderRegister-voorstel in als kredieteigenaar of koper:

   POST/proposals

Haal alle MarketplaceTraderRegister-voorstellen op en bekijk ze als een marketplace:

   GET/proposals

Keur de voorstellen als een marketplace goed of wijs ze af:

   POST/proposals/{proposalId}/action

Haal alle handelaren op die op hun platform als marketplace zijn geregistreerd en geef ze weer:

   GET/marketplaces/{marketplaceId}/traders

Voorstel indienen om een credit te vermelden

Maak en verzend MarketplaceListingRegister-voorstel:

   POST/proposals

Voorstel beoordelen om een credit weer te geven

   GET/proposals

   POST /proposals/{proposalId}/action

Credits beheren

In dit gedeelte ziet u hoe u credits via API's kunt beheren. Ga voor instructies over het gebruik van de gebruikersinterface naar Credits beheren in Service voor milieucredits.

Vermelding van een credit verwijderen

Het splitsen van een credit is een zelfstandige bewerking in Service voor milieucredits. Ga voor informatie over het splitsen van een credit via API naar Een credit splitsen. Na splitsing van de credit kunt u doorgaan met de volgende stap.

Maak en verzend MarketplaceListingDeregister-voorstel:

   POST/proposals

Bekijk alle MarketplaceListingDeregister-voorstellen die ter beoordeling zijn ingediend:

   GET/proposals

Het voorstel goedkeuren of afwijzen:

   POST/proposals/{proposalId}/action

Eigendom overdragen

   POST/credits/{creditId}/transfer/

Herkomst van credit weergeven

Organisaties met leveranciers- en registerrollen kunnen de creditherkomst weergeven voor de credits die zij bezitten of hebben uitgegeven:

   GET/credits/{creditId}/lineage

Een credit splitsen

U kunt een credit opsplitsen in onderliggende credits. Deze functionaliteit is momenteel alleen beschikbaar via API.

Splits de credit door de hoeveelheden (in mtCO2e) voor ten minste twee onderliggende credits op te geven als crediteigenaar (voor de credits die in eigendom zijn) of als een marketplace (voor de credits die op het platform worden weergegeven):

   POST/credits/{creditId}/split

Creditlijst overdragen

Een marketplace kan een creditlijst van het platform overdragen naar een andere marketplace. Deze overdracht wordt ook wel overdracht van vordering genoemd. In de traditionele stroom plaatst een leverancier de credits op een marketplace die helpt bij de vraag, vereffening en verrekening. Soms is een marketplace niet in staat om de vereffening en verrekening van betalingen zelf uit te voeren en is deze afhankelijk van een ander platform om dit uit te voeren. In dit geval moet het activum worden overgedragen aan de nieuwe marketplace om de transactie te voltooien. Deze functie is momenteel alleen beschikbaar via API´s.

Maak als marketplace het MarketplaceListingTransfer-voorstel voor een op uw platform vermeld tegoed aan en dien dit in:

   POST/proposals

Bekijk als goedkeurende marketplaces alle MarketplaceListingTransfer-voorstellen die ter beoordeling aan hen zijn voorgelegd:

   GET/proposals

Keur het voorstel als goedkeurende marketplace goed of wijs het af: Als het voorstel wordt goedgekeurd, wordt de creditvordering overgedragen van de initiële marketplace naar de goedkeurende marketplace:

   POST/proposals/{proposalId}/action

Gedeeltelijke overdracht van vordering: een marketplace kan een vordering voor gedeeltelijke credit overdragen door eerst de credit te splitsen als een onafhankelijke actie. Ga voor informatie over het splitsen van een credit naar Een credit splitsen. Nadat de credit is gesplitst, gaat u verder met de bovenstaande stappen voor het overdragen van vordering voor onderliggende credits.

Uitstootdoelstellingen instellen

In dit gedeelte ziet u hoe u doelen en doelstellingen van uitstootreductie kunt instellen via API's.

Uitstootdoelstellingen maken

   POST/esgs

Uitstootdoelstellingen weergeven

   GET/esgs

Uitstoot bijhouden

In dit gedeelte ziet u hoe u uw uitstoot kunt bijhouden aan de hand van de uitstootscorekaart die u via API's hebt ingesteld. Ga voor instructies over het gebruik van de gebruikersinterface naar Uitstootdoelstellingen bijhouden in Service voor milieucredits.

Mijlpalen voor specifieke rapportageperiode maken

   POST/esgs/{esgScorecardId}/milestones

Haal alle mijlpalen op:

   GET/esgs/{esgScorecardId}/milestones

Haal een specifieke mijlpaal op:

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

Werkelijke uitstoot ten opzichte van de mijlpaal bijhouden

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

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

Credits intrekken

In dit gedeelte ziet u hoe u teveel uitstoot kunt compenseren door eigen CO2-credits in te trekken via API's. Ga voor instructies over het gebruik van de gebruikersinterface naar Credits intrekken in Service voor milieucredits.

Voorstel voor creditintrekking indienen

Maak het ESGEmissionOffset-voorstel en dien het in:

   POST/proposals

Kopers kunnen CO2-credit ook direct intrekken zonder de te compenseren uitstoot op te geven. Deze functionaliteit is alleen beschikbaar via API.

Maak het CreditRetire-voorstel en dien het in:

   POST/proposals

Voorstel voor creditintrekking beoordelen

   GET/proposals

   GET/proposals/{proposalId}

Koppel het bestand aan de credit die wordt beoordeeld voor intrekking:

   POST/files

   POST/proposals/{proposalId}/action

Gedeeltelijke creditintrekking

Ga voor informatie over het splitsen van een credit via API naar Een credit splitsen.

Nadat de credit is gesplitst, gebruikt u de API's in de vorige stappen voor compensatie en intrekking.

Bestanden beheren

In dit gedeelte ziet u hoe u bestanden voor activa zoals project, claim en credits kunt koppelen, weergeven en verwijderen via API's. Ga voor instructies over het gebruik van de gebruikersinterface naar Bestanden beheren in Service voor milieucredits.

Bestanden bijvoegen

Gebruik de API POST/files om een bestand aan een activum te koppelen. U moet de volgende details opgeven:

  • Bestand of bestands-URI
  • Resource-URI van het activum
  • Een beschrijvend label voor het bestand

Bestanden weergeven

Geef de lijst met bestanden weer samen met bestandseigenschappen voor een activum met behulp van de API voor activumdetails:

Modulair voordeelproject:

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

Claims:

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

Claimcontrolepunten:

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

Credit:

   GET/credits/{creditId}

Gebruik de bestands-id die aanwezig is in de bestandseigenschappen van het bestand om het bestand te downloaden:

   GET/files/{fileId}

Bestanden verwijderen

Gebruik de bestands-id van het bestand om de API voor verwijderen aan te roepen:

   DELETE/files/{fileId}

Overzicht van Environmental Credit Service
Configureer Environmental Credit Service
Woordenlijst Environmental Credit Service

📄 productpagina
🎓 Opleiding

✅ Gratis proefperiode
🎥 YouTube kanaal

💻 Community
LinkedIn-pictogram.LinkedIn groep