Présentation de la référence d’API du service de crédit en faveur de l’environnement

Essai gratuit

Important

Tout ou partie de cette fonctionnalité est accessible dans le cadre d’une version préliminaire. Le contenu et les fonctionnalités sont susceptibles d’être modifiés. Vous pouvez accéder à l’environnement de bac à sable du service de crédit en faveur de l’environnement (version préliminaire) pour un essai de 30 jours. Pour utiliser le service de crédit en faveur de l’environnement (version préliminaire) dans un environnement de production, renseignez le Formulaire d’inscription au service de crédit en faveur de l’environnement (version préliminaire).

Cet article vous aide à effectuer des tâches avec les API REST du service de crédit en faveur de l’environnement. Pour voir la référence d’API dans sa totalité, accédez à Référence d’API du service de crédit en faveur de l’environnement. Vous pouvez trouver le fichier Swagger dans les API REST du service de crédit en faveur de l’environnement.

• Enregistrer des projets
• Traiter les réclamations
• Crédits d’émission
• Liste des crédits
• Gérer les crédits
• Fixer des objectifs d’émission
• Suivre les émissions
• Crédits de retraite
• Gérer les fichiers

Enregistrer les projets

Cette section vous montre comment créer, soumettre et réviser des projets écologiques via des API. Pour obtenir des instructions sur l’utilisation de l’interface utilisateur, accédez à Inscrire des projets dans le service de crédit en faveur de l’environnement.

• Créer un projet
• Enregistrer et soumettre un projet
• Voir un projet
• Approuver ou rejeter une proposition
• Supprimer un fichier
• Renvoyer une proposition de modifications
• Enregistrer des projets d’avantages modulaires supplémentaires
• Réviser un projet d’avantages modulaires

Créez un projet

Pour télécharger et joindre des fichiers au moment de la création du projet :

1. Téléchargez des fichiers à l’aide de POST/files. Précisez les détails suivants dans l’API :

   • Fichier ou URL de fichier
   • Balise descriptive pour le fichier

2. Créez le projet écologique et le projet d’avantages modulaires correspondant et spécifiez l’ID de fichier renvoyé dans la réponse de l’appel d’API POST/files en tant qu’attribut dans le corps de la demande d’API de création de projet : POST/ecoprojects.

Enregistrer et soumettre un projet

Récupérez les détails du projet :

   GET/ecoProjects/{ecoProjectId}

Consultez la liste des fichiers (et leurs métadonnées associées) attachés au projet d’avantages modulaires :

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

Téléchargez un fichier à l’aide de l’ID de fichier disponible dans les métadonnées du fichier :

   GET/files/{fileId}

Ajoutez les fichiers au projet d’avantages modulaires :

   POST/files

Spécifiez l’URI de ressource du projet d’avantages modulaires dans le corps de la demande.

Soumettez un projet d’avantages modulaires pour enregistrement en soumettant une proposition MBPRegister :

   POST/proposals

Afficher un projet

Récupérez toutes les propositions :

   GET/proposals

Récupérez les détails d’une proposition spécifique :

   GET/proposals/{proposalId}

Récupérez les détails d’un projet écologique spécifique :

   GET/ecoProjects/{ecoProjectId}

Récupérez les détails du MBP spécifique à examiner :

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

Obtenez la liste des fichiers (et des métadonnées associées) joints au projet d’avantages modulaires :

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

Téléchargez les fichiers à l’aide de l’ID de fichier disponible dans le cadre de la réponse d’API précédente :

   GET/files/{fileId}

Attachez un fichier au projet d’avantages modulaires :

   POST/files

Approuver ou rejeter une transition

Charger des fichiers (le cas échéant) :

POST/fichiers et spécifiez le fichier (ou FileUrl) et les détails de la balise

Rejeter la demande d’inscription :

POST/proposals/{proposalId}/action et spécifiez les détails suivants dans le corps de la requête

• Action : refuser

• Message : spécifiez un commentaire (le cas échéant) que vous souhaitez fournir pour refuser l’enregistrement.

• FileIDs : spécifiez les ID de fichier des fichiers qui ont été téléchargés.

Supprimer un fichier

Afficher la liste des fichiers attachés au projet d’avantages modulaires :

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

Identifiez le fichier que vous avez téléchargé, car un utilisateur ne peut supprimer que les fichiers qu’il a téléchargés.

Supprimer le fichier :

   DELETE/files/{fileId}

Renvoyer une proposition de modifications

S’il y a des lacunes ou des détails incorrects dans les attributs ou fichiers du projet que vous souhaitez que le fournisseur corrige ou ajoute, vous pouvez demander des modifications du projet.

1. Téléchargez les fichiers, le cas échéant, qui doivent être partagés avec le fournisseur :

   POST/files

2. Déplacez la proposition MBPRegister sur l’état submitterActionNeeded en prenant une action returnForEdits à l’aide de l’API POST/proposals/{proposalId}/action et spécifiez les détails suivants dans le corps de la requête :

   • Action : returnForEdits

   • Message : spécifiez un commentaire (si nécessaire) pour la référence du fournisseur lors du retour de la demande de modifications.

   • ID de fichier : spécifiez l’ID de fichier du fichier téléchargé ici pour joindre le fichier au projet d’avantages modulaires concerné.

   Une fois cette opération effectuée, le projet d’avantages modulaires passe à l’état returnedForEdits.

Les fournisseurs peuvent désormais afficher la proposition qui a été renvoyée pour modifications. Ils peuvent désormais modifier les attributs du projet d’avantages modulaires et télécharger davantage de fichiers dans le projet d’avantages modulaires.

• Afficher la proposition : GET/proposals/{proposalId}

• Téléchargez et joignez des fichiers au projet d’avantages modulaires : POST/fichiers et spécifiez les détails suivants dans le corps de la requête :

  • Fichier ou URL de fichier
  • Balise : balise descriptive pour le fichier
  • ResourceURI : spécifiez l’URI de ressource du projet d’avantages modulaires respectif.

• Mettre à jour les attributs du projet d’avantages modulaires

  • Obtenez les détails du projet d’avantages modulaires mis à jour à l’aide de GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} et copiez la valeur Etag à partir de l’en-tête de réponse.
  • Mettez à jour les attributs du projet d’avantages modulaires à l’aide de l’API PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} et spécifiez la valeur Etag dans la clé If-Match dans l’en-tête.

Une fois les modifications terminées, le fournisseur peut maintenant renvoyer la proposition au registre à l’aide de l’API POST/proposals/{proposalId}/action et spécifier les détails suivants dans la demande :

• Action : Soumettre

• Message : spécifiez un commentaire (le cas échéant) pour la référence du registre.

Enregistrez des projets d’avantages modulaires supplémentaires

Soumettez l’avantage écologique pour enregistrement au registre émetteur en créant et en soumettant une proposition MBPRegister :

   POST/proposal

Passer en revue un projet d’avantages modulaires

Affichez les détails de la proposition :

   GET/proposals/{proposalId}

Voir tous les détails du projet :

   GET/ecoProjects/{ecoProjectId}

Voir les détails du projet individuel d’avantages modulaires du projet :

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

Approuvez ou rejetez la proposition d’inscription, ou renvoyez-la pour modification :

   POST/proposals/{proposalId}/action

Traiter les réclamations

Cette section vous montre comment traiter les réclamations via les API. Pour obtenir des instructions sur l’utilisation de l’interface utilisateur, accédez à Traiter les réclamations dans le service de crédit en faveur de l’environnement.

• Créer des réclamations
• Soumettre des réclamations
• Vérifier la réclamation
• Demande de retour pour modifications
• Modifier la proposition renvoyée
• Retirer la demande d’émission de crédit

Créer des réclamations

Créer une réclamation :

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

Téléchargez et joignez des fichiers pour réclamer des points de contrôle :

   POST/files

Précisez les détails suivants dans la demande :

• Fichier ou URL de fichier
• Balise
• URI de ressource de la réclamation

Soumettre des réclamations

Créez et soumettez la proposition projectClaimVerify d’avantages modulaires :

   POST/proposals

Afficher les détails de la proposition soumise :

   GET/proposal/{proposalId}

Affichez les détails de la réclamation :

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

Vérifier la réclamation

Afficher les propositions :

   GET/proposals

Récupérez les détails d’une proposition spécifique :

   GET/proposals/{proposalId}

Récupérer les détails d’une réclamation spécifique pour laquelle la proposition de vérification a été soumise :

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

Acceptez la tâche de vérification de la réclamation :

   POST/proposals/{proposalId}/action

Répertoriez les fichiers associés à un projet d’avantages modulaires :

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

Répertoriez les fichiers associés aux points de contrôle des réclamations :

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

Afficher un fichier joint à un élément spécifique :

   GET/files/{fileId}

Une fois la réclamation acceptée, une "Réclamation traitée" correspondante est créée. Enregistrez vos résultats de vérification sur la demande traitée. Cela inclut la mise à jour de la Quantité, Co avantages de la réclamation. Avant de soumettre la demande d’émission de crédit, vous devez également mettre à jour les recommandations de crédit sur la demande traitée :

• Obtenez les détails de la réclamation traitée à l’aide de GET/processedClaims/{processed_claim_id} et copiez la valeur Etag de l’en-tête de réponse.
• Mettez à jour les attributs de la demande traitée à l’aide de l’API PATCH/processedClaims/{processed_claim_id} et spécifiez la valeur Etag dans la clé If-Match dans l’en-tête.

Pour chaque point de contrôle que vous vérifiez, vous pouvez mettre à jour vos résultats de vérification sur le résultat du point de contrôle correspondant de la réclamation traitée :

• Chargez et joignez vos rapports de résultats de vérification aux résultats du point de contrôle de la demande traitée à l’aide de l’API POST/files et spécifiez le fichier ou l’URL du fichier, la balise et ResourceUri (il s’agira de l’URI de ressource du résultat du point de contrôle) dans le corps de la demande.
• Mettez à jour l’effet environnemental avant et après les attributs du résultat du point de contrôle (si nécessaire) :
  • Obtenez les détails du résultat du point de contrôle traitée à l’aide de GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} et copiez la valeur Etag de l’en-tête de réponse.
  • Mettez à jour les attributs du résultat du point de contrôle à l’aide de l’API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} et spécifiez la valeur Etag dans la clé If-Match dans l’en-tête.
  • Vous pouvez également mettre à jour les résultats du point de contrôle à l’aide de l’API de correctif pour les réclamations traitées.

Une fois la vérification terminée, approuvez ou rejetez la proposition MBPClaimVerify :

   POST/proposals/{proposalId}/action

Indiquez les informations suivantes :

• Action : approuver ou refuser

• Message : spécifiez un commentaire (le cas échéant) pour la référence du fournisseur.

Une fois la proposition MBPClaimVerify approuvée, créez et soumettez la proposition CreditMint pour soumettre la demande d’émission de crédit :

   POST/proposals/

Renvoyer une demande de réclamation pour modifications

S’il y a des lacunes ou des détails incorrects dans la demande de réclamation que la validation et le corps de vérification souhaite que le fournisseur corrige, vous pouvez demander des modifications de la demande de réclamation au lieu de l’approuver ou de la refuser. Cette capacité est disponible uniquement via une API.

1. Chargez et joignez des fichiers (que vous souhaitez partager avec le fournisseur) à la réclamation traitée ou au résultat du point de contrôle de la réclamation traitée : POST/fichiers et spécifiez les détails suivants dans le corps de la requête

   • Fichier ou URL de fichier
   • Balise
   • URI de ressource de la réclamation traitée ou résultat du point de contrôle de la réclamation traitée auquel le fichier doit être ajouté

2. Déplacez la proposition MBPClaimVerify sur l’état submitterActionNeeded en prenant une action returnForEdits à l’aide de l’API POST/proposals/{proposalId}/action et spécifiez les détails suivants dans le corps de la requête :

   • Action : returnForEdits
   • Message : spécifiez un commentaire (si nécessaire) pour la référence du fournisseur lors du retour de la demande de modifications.

Modifier la proposition renvoyée

Les fournisseurs peuvent ensuite afficher la proposition qui a été renvoyée pour modifications. Ils peuvent désormais modifier les attributs de réclamation et de point de contrôle, et ils peuvent télécharger plus de fichiers vers les points de contrôle de réclamation :

1. Afficher la proposition : GET/proposals/{proposalId}

   • Si nécessaire, le fournisseur peut également afficher les détails de la réclamation traitée correspondante à l’aide de GET/processedClaims/{processed_claim_Id} API.

2. Téléchargez et joignez des fichiers (le cas échéant) aux points de contrôle de la réclamation : POST/fichiers et spécifiez les détails suivants dans le corps de la requête

   • Fichier ou URL de fichier
   • Balise
   • URI de ressource du point de contrôle auquel le fichier doit être ajouté

3. Mettez à jour les attributs de réclamation à l’aide d’une opération PATCH :

   • Obtenez les derniers détails de la réclamation et notez la valeur ETag dans l’en-tête de la réponse : GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
   • Mettez à jour les attributs de la réclamation et spécifiez la valeur Etag dans la clé If-Match de l’en-tête de la demande : PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}

4. Mettez à jour les attributs du point de contrôle de la réclamation à l’aide d’une opération PATCH :

   • Obtenez les détails des derniers points de contrôle et notez la valeur ETag dans l’en-tête de réponse : GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

   • Mettez à jour les attributs de la réclamation et spécifiez la valeur Etag dans la clé If-Match de l’en-tête de la demande : PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

     Remarque

     Lors de la spécification des attributs de mise à jour, assurez-vous que le corps de la demande JSON suit la même structure que dans l’appel d’API get correspondant.

5. Une fois les modifications terminées, le fournisseur peut renvoyer la proposition à l’organisme de validation et de vérification à l’aide de l’API POST/proposals/{proposalId}/action et spécifier les détails suivants dans le corps de la requête :

   • Action : Renvoyer
   • Message : spécifiez tout commentaire (le cas échéant) pour la référence du corps de validation et de vérification.

Une fois la proposition renvoyé, la validation net le corps de la vérification vous pouvez la revoir et l’approuver, la refuser ou encore demander des modifications.

Retirer la demande d’émission de crédit

Possibilité de retirer la proposition de demande d’émission de crédit (CreditMint) soumise :

Une fois la proposition d’émission de crédit soumise au registre, en cas de problème pour lequel vous souhaitez retirer la proposition soumise, vous pouvez retirer la proposition soumise si le registre n’a pas donné suite à la proposition. Cette capacité est actuellement disponible uniquement via les API.

• Transférez la proposition CreditMint de l’état soumise à l’état retirée à l’aide de l’API POST/proposals/{proposalId}/action et spécifiez les détails suivants dans le corps de la requête :

  • Action : retirer
  • Message : spécifiez la raison (le cas échéant) du retrait de la proposition de référence au registre.

Le statut de la proposition est maintenant Retiré.

Une fois la demande d’émission de crédit retirée, l’organisme de validation et de vérification peut modifier la "réclamation traitée" et les résultats des points de contrôle associés, puis renvoyer la demande d’émission de crédit.

• Chargez et joignez des fichiers aux résultats du point de contrôle de la demande traitée : POST/fichiers et spécifiez les détails suivants :

  • Fichier ou URL de fichier
  • Balise
  • ResourceURI du résultat du point de contrôle associé.

• Mettez à jour les attributs de la réclamation traitée : PATCH/processedClaims/{processedClaim_Id}

• Soumettez à nouveau la demande d’émission au registre et spécifiez les détails suivants dans le corps de la demande d’API : POST/proposals/{ proposal_id}/action

  • Action : spécifiez comme Renvoyer
  • Message : spécifiez un message/commentaire (le cas échéant) pour la référence du registre

Émettre des crédits

Cette section vous montre comment afficher et émettre des crédits via les API. Pour obtenir des instructions sur l’utilisation de l’interface utilisateur, accédez à Émettre des crédits dans le service de crédit en faveur de l’environnement.

• Propositions d’examen
• Approuver les crédits
• Rejeter une proposition
• Demande d’émission de crédit de retour pour les modifications
• Voir les crédits émis
• Rechercher et consulter les crédits

Examiner les propositions d’émission de crédit

Affichez la proposition "Token mint" soumise et obtenez l’URI de la ressource "réclamation traitée" qui a été soumise pour examen :

GET/proposal/{proposalId}

Examinez les résultats de vérification de l’organisme de validation et de vérification en affichant la demande traitée et les résultats des points de contrôle associés (ainsi que les fichiers associés) :

GET/processedClaims/{processedClaims_Id} 

Afficher la réclamation et les détails des points de contrôle correspondants (ainsi que la liste des fichiers joints par fournisseur pour les points de contrôle) :

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

Consultez les détails du projet d’avantages modulaires, ainsi que la liste des fichiers joints :

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

Téléchargez un fichier en utilisant l’ID de fichier :

   GET/files/{fileId}

Approuver les crédits

Téléchargez les fichiers que vous souhaitez joindre au crédit pour émission : POST/files et spécifiez les détails suivants dans le corps de la requête :

• Fichier ou URL de fichier
• Balise

Approuvez la proposition :

   POST/proposals/{proposalId}/action

Précisez les détails suivants dans le corps de la demande :

• Action : spécifiez comme Menthe
• Message : spécifiez le message (le cas échéant) pour la référence du corps de validation et de vérification
• ID de fichier : spécifiez les ID de fichier des fichiers téléchargés afin que les fichiers soient joints au crédit émis
• Quantité
• Ancien
• ID d’actif
• Valeur déterminée

Remarque

Lorsque la proposition aura été approuvée, un crédit correspondant sera créé.

Refuser une proposition

Chargez les fichiers (le cas échéant) dans la demande traitée : POST/fichiers et spécifiez les détails suivants :

• Fichier ou URL de fichier
• Balise

Refusez la proposition :

   POST/proposals/{proposalId}/action

Précisez les détails suivants dans le corps de la demande :

• Action : refuser
• Message : spécifiez un message (le cas échéant) pour la référence du corps de validation et de vérification
• ID de fichier : spécifiez les ID de fichier du fichier téléchargé afin qu’ils soient joints à la demande traitée associée.

Renvoyer la demande d’émission de crédit pour les modifications

S’il y a des lacunes ou des détails incorrects dans la demande de délivrance que vous souhaitez que l’organisme de validation et de vérification corrige, vous pouvez demander des modifications sur la demande de délivrance. Cette capacité est disponible uniquement via une API.

1. Téléchargez les fichiers (le cas échéant) que vous souhaitez partager avec l’organisme de validation et de vérification dans le cadre du renvoi de la demande d’émission pour modifications.

2. Déplacez la demande d’émission (proposition CreditMint) vers l’état submitterActionNeeded à l’aide de l’API POST/proposals/{proposalId}/action et spécifiez les détails suivants :

   • Action : ReturnForEdits
   • Message : spécifiez un message (le cas échéant) pour la référence du corps de validation et de vérification afin qu’ils puissent comprendre la raison de la demande de modification.
   • ID de fichier : spécifiez les ID de fichier des fichiers téléchargés (le cas échéant) afin que ces derniers soient joints à la demande traitée associée.

L’organisme de validation et de vérification peut maintenant voir la proposition qui a été renvoyée pour modifications. Ils peuvent également désormais modifier les résultats de réclamation et de point de contrôle traités correspondants. Ils peuvent mettre à jour les attributs ainsi que charger des fichiers mis à jour dans les résultats du point de contrôle.

Si nécessaire, l’organisme de validation et de vérification à ce stade peut demander des éclaircissements sur la demande vérifiée en retournant la demande pour modification au fournisseur. Une fois que le fournisseur a renvoyé la demande, l’organisme de validation et de vérification peut examiner et vérifier la demande, mettre à jour la demande traitée correspondante, puis soumettre à nouveau la demande de délivrance au registre.

1. Chargez et joignez des fichiers aux résultats du point de contrôle : POST/fichiers et spécifiez les détails suivants :

   • Fichier ou URL de fichier
   • Balise
   • ResourceURI des résultats du point de contrôle associé

2. Mettez à jour les attributs de la demande traitée, y compris la recommandation de crédit : PATCH/processedClaim/{id de la demande traitée}

3. Soumettez à nouveau la demande d’émission et spécifiez les détails ci-dessous dans le corps de la demande d’API : POST/proposals/{ proposal_id}/action

   • Action : Renvoyer
   • Message : spécifiez un message (le cas échéant) pour la référence du registre

Une fois la demande renvoyée, l’émission d’un registre peut revoir la demande et l’approuver, la refuser ou encore demander des modifications.

Afficher les crédits émis

   GET/credits

Rechercher et afficher des crédits

Extraire tous les crédits :

   GET/credits

Remarque

Cette API renverra la liste de tous les crédits. Les acheteurs peuvent ensuite filtrer la liste par eux-mêmes en fonction de l’état du crédit pour afficher uniquement les crédits répertoriés.

Afficher les détails du crédit (y compris la lignée) pour un crédit spécifique affiché dans la liste :

   GET/credits/{creditId}/lineage

Répertorier les crédits

Cette section vous montre comment répertorier les crédits sur une place de marché pour les échanger via des API. Pour obtenir des instructions sur l’utilisation de l’interface utilisateur, accédez à Répertorier des crédits dans le service de crédit en faveur de l’environnement.

• S’inscrire en tant qu’acheteur sur une marketplace
• Soumettre une proposition pour répertorier un crédit
• Réviser la proposition d’inscription d’un crédit

S’inscrire en tant qu’acheteur ou marché

Envoyer la proposition MarketplaceTraderRegister en tant que propriétaire ou acheteur de crédit :

   POST/proposals

Récupérer et examiner toutes les propositions MarketplaceTraderRegister en tant que marketplace :

   GET/proposals

Approuver ou rejeter les propositions en tant que marché :

   POST/proposals/{proposalId}/action

Récupérez et visualisez tous les commerçants inscrits sur leur plateforme en tant que marché :

   GET/marketplaces/{marketplaceId}/traders

Soumettre la proposition d’inscription d’un crédit

Créer et envoyer la proposition MarketplaceListingRegister :

   POST/proposals

Examiner la proposition d’inscription d’un crédit

   GET/proposals

   POST /proposals/{proposalId}/action

Gérer les crédits

Cette section vous montre comment gérer des crédits via les API. Pour obtenir des instructions sur l’utilisation de l’interface utilisateur, accédez à Gérer des crédits dans le service de crédit en faveur de l’environnement.

• Supprimer un crédit
• Transférer la propriété
• Voir la lignée de crédit
• Diviser un crédit
• Liste des crédits de transfert

Radier un crédit

Le fractionnement d’un crédit est une opération indépendante du service de crédit en faveur de l’environnement Pour plus d’informations sur le fractionnement d’un crédit via l’API, accédez à Fractionner un crédit. Après la répartition des crédits, vous pouvez passer à l’étape suivante.

Créer et envoyer la proposition MarketplaceListingDeregister :

   POST/proposals

Afficher toutes les propositions MarketplaceListingDeregister envoyées pour examen :

   GET/proposals

Pour approuver ou rejeter la proposition :

   POST/proposals/{proposalId}/action

Transférer la propriété

   POST/credits/{creditId}/transfer/

Afficher la lignée de crédit

Les organisations ayant des rôles de fournisseur et de registre peuvent afficher la lignée de crédit pour les crédits qu’elles possèdent ou ont émis :

   GET/credits/{creditId}/lineage

Fractionner un crédit

Vous pouvez fractionner un crédit en crédits enfants. Cette fonctionnalité est actuellement disponible uniquement via l’API.

Fractionnez le crédit en précisant les quantités (en mtCO2e) pour au moins deux crédits enfants en tant que propriétaire de crédit (pour les crédits qu’il possède) ou en tant que marché (pour les crédits listés sur leur plateforme) :

   POST/credits/{creditId}/split

Transférer la liste des crédits

Un marché peut transférer une liste de crédit de sa plateforme vers un autre marché. Ce transfert est également appelé transfert de charge. Dans le flux traditionnel, un fournisseur répertorie les crédits sur un marché qui aideront avec la demande, la compensation et le règlement. Parfois, un marché peut ne pas être en mesure d’effectuer lui-même la compensation et le règlement des paiements et peut dépendre d’une plateforme différente pour les effectuer. Dans ce cas, l’actif doit être transféré sur le nouveau marché pour finaliser la transaction. Cette fonctionnalité est actuellement disponible uniquement via les API.

En tant que marketplace, créez et envoyez la proposition MarketplaceListingTransfer pour un crédit listé sur votre plateforme :

   POST/proposals

En tant que marketplace approbateur, affichez toutes les propositions MarketplaceListingTransfer envoyées pour examen :

   GET/proposals

En tant que marché d’approbateur, approuvez ou refusez la proposition. Si la proposition est approuvée, l’encombrement des crédits est transféré du marché initial au marché de l’approbateur :

   POST/proposals/{proposalId}/action

Transfert partiel de charge : un marché peut transférer une charge pour un crédit partiel en divisant d’abord le crédit en tant qu’action indépendante. Pour plus d’informations sur le fractionnement d’un crédit, accédez à Fractionner un crédit. Une fois le crédit fractionné, continuez avec les étapes ci-dessus pour le transfert de charge pour les crédits pour enfants.

Fixer des objectifs d’émission

Cette section vous montre comment configurer des objectifs et des cibles de réduction des émissions via des API.

• Créer des objectifs d’émission
• Voir les objectifs d’émission

Créer des objectifs d’émission

   POST/esgs

Consulter les objectifs d’émission

   GET/esgs

Suivre les émissions

Cette section vous montre comment suivre vos émissions par rapport au tableau de bord des émissions que vous avez défini via les API. Pour obtenir des instructions sur l’utilisation de l’interface utilisateur, accédez à Suivre les objectifs d’émission dans le service de crédit en faveur de l’environnement.

• Créer des jalons pour une période de rapport spécifique
• Suivre les émissions réelles par rapport au jalon

Créer des jalons pour une période de rapport spécifique

   POST/esgs/{esgScorecardId}/milestones

Récupérez tous les jalons :

   GET/esgs/{esgScorecardId}/milestones

Récupérer un jalon spécifique :

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

Suivre les émissions réelles par rapport au jalon

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

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

Retirer les crédits

Cette section vous montre comment compenser les émissions excédentaires en retirant les crédits carbone détenus via les API. Pour obtenir des instructions sur l’utilisation de l’interface utilisateur, accédez à Retirer des crédits dans le service de crédit en faveur de l’environnement.

• Soumettre une proposition de retraite de crédit
• Examen de la proposition de retraite par crédit
• Retraite partielle à crédit

Soumettre une proposition de retrait de crédit

Créez et soumettez la proposition ESGEmissionOffset :

   POST/proposals

Les acheteurs peuvent également retirer directement le crédit carbone sans spécifier les émissions à compenser. Cette fonctionnalité est disponible uniquement via une API.

Créez et soumettez la proposition CreditRetire :

   POST/proposals

Passer en revue une proposition de retrait de crédit

   GET/proposals

   GET/proposals/{proposalId}

Joindre un fichier au crédit en cours de révision pour le retrait :

   POST/files

   POST/proposals/{proposalId}/action

Retraite partielle de crédit

Pour plus d’informations sur le fractionnement d’un crédit via l’API, accédez à Fractionner un crédit.

Une fois le crédit fractionné, utilisez les API des étapes précédentes pour la compensation et le retrait.

Gérer les fichiers

Cette section vous montre comment joindre, afficher et supprimer des fichiers pour des actifs tels que des projets, des réclamations et des crédits via des API. Pour obtenir des instructions sur l’utilisation de l’interface utilisateur, accédez à Gérer des fichiers dans le service de crédit en faveur de l’environnement.

• Joindre des fichiers
• Voir les fichiers
• Supprimer des fichiers

Joindre des fichiers

Utilisez l’API POST/files pour joindre un fichier à un actif. Vous devez spécifier les détails suivants :

• Fichier ou URI de fichier
• URI de ressource de l’actif
• Balise descriptive pour le fichier

Afficher des fichiers

Affichez la liste des fichiers ainsi que les propriétés de fichier d’un élément à l’aide de l’API des détails de l’actif :

Projet d’avantage modulaire :

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

Revendications :

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

Points de contrôle des revendications :

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

Crédit :

   GET/credits/{creditId}

Utilisez l’ID de fichier présent dans les propriétés du fichier pour télécharger le fichier :

   GET/files/{fileId}

Supprimer les fichiers

Utilisez l’ID de fichier du fichier pour appeler l’API de suppression :

   DELETE/files/{fileId}

Informations associées

Présentation du service de crédit environnemental
Configurer le service de crédit environnemental
Glossaire du Service de crédit environnemental

📄 Page produit
🎓 Formation

✅ Essai gratuit
🎥 YouTube canal

💻 Communauté
Groupe LinkedIn