Κοινή χρήση μέσω


Επισκόπηση αναφοράς API για την Υπηρεσία περιβαλλοντικής πίστωσης

Σημαντικό

Ορισμένες ή όλες οι λειτουργίες είναι διαθέσιμες ως μέρος μιας έκδοσης προεπισκόπησης. Το περιεχόμενο και η λειτουργικότητα υπόκεινται σε αλλαγές. Μπορείτε να αποκτήσετε πρόσβαση στο περιβάλλον προστατευμένης εκτέλεσης της υπηρεσίας περιβαλλοντικής πίστωσης (έκδοση προεπισκόπησης) για μια δοκιμαστική περίοδο 30 ημερών. Για να χρησιμοποιήσετε την Υπηρεσία περιβαλλοντικής πίστωσης σε ένα περιβάλλον παραγωγής, συμπληρώστε τη φόρμα εγγραφής της Υπηρεσίας περιβαλλοντικής πίστωσης (έκδοση προεπισκόπησης).

Αυτό το άρθρο σάς βοηθά να εκτελέσετε εργασίες με τα API REST της Υπηρεσίας περιβαλλοντικής πίστωσης. Για να δείτε την πλήρη αναφορά API, μεταβείτε στην Αναφορά API της Υπηρεσίας περιβαλλοντικής πίστωσης. Μπορείτε να βρείτε το αρχείο Swagger στα API REST της υπηρεσίας περιβαλλοντικής πίστωσης.

Καταχώρηση έργων

Αυτή η ενότητα σάς δείχνει πώς να δημιουργείτε, να υποβάλλετε και να εξετάζετε οικολογικά έργα μέσω API. Για οδηγίες σχετικά με τη χρήση του περιβάλλοντος εργασίας χρήστη, μεταβείτε στην Καταχώρηση έργων στην Υπηρεσία περιβαλλοντικής πίστωσης.

Δημιουργία έργου

Για να αποστείλετε και να επισυνάψετε αρχεία κατά τη δημιουργία έργου:

  1. Φορτώστε αρχεία χρησιμοποιώντας το POST/αρχεία. Καθορίστε τις παρακάτω λεπτομέρειες στο API:

    • Αρχείο ή διεύθυνση URL αρχείου
    • Περιγραφική ετικέτα για το αρχείο
  2. Δημιουργήστε το οικολογικό έργο και το αντίστοιχο έργο αρθρωτού οφέλους και καθορίστε το fileID που επιστρέφεται στην απόκριση της κλήσης POST/API αρχείων ως χαρακτηριστικό στο σώμα του αιτήματος API: POST/ecoprojects.

Αποθήκευση και υποβολή έργου

Λήψη των λεπτομερειών του έργου:

   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:

   GET/files/{fileId}

Επισυνάψτε ένα αρχείο στο έργο αρθρωτού οφέλους:

   POST/files

Εγκρίνετε ή απορρίψτε μια πρόταση

Στείλτε αρχεία (εάν υπάρχουν):

ΔΗΜΟΣΙΕΥΣΤΕ/αρχεία και καθορίστε τις λεπτομέρειες αρχείου (ή FileUrl) και ετικετών

Απορρίψτε την αίτηση εγγραφής:

ΔΗΜΟΣΙΕΥΣΤΕ/προτάσεις/{proposalId}/ενέργεια και καθορίστε τις ακόλουθες λεπτομέρειες στο σώμα της αίτησης

  • Ενέργεια: Απόρριψη

  • Μήνυμα: Καθορίστε ένα σχόλιο (εάν υπάρχει) που θέλετε να δώσετε για απόρριψη της καταχώρησης.

  • Αναγνωριστικά αρχείων: Καθορίστε τα αναγνωριστικά αρχείων των αρχείων που στάλθηκαν.

Διαγραφή ενός αρχείου

Προβάλετε τη λίστα αρχείων που επισυνάπτονται στο έργο αρθρωτού οφέλους:

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

Προσδιορίστε το αρχείο που αποστείλετε, επειδή ένας χρήστης μπορεί να διαγράψει μόνο τα αρχεία που έχει αποστείλει.

Διαγράψτε το αρχείο:

   DELETE/files/{fileId}

Επιστροφή πρότασης για επεξεργασίες

Εάν υπάρχουν ορισμένα κενά ή εσφαλμένες λεπτομέρειες στα χαρακτηριστικά ή τα αρχεία έργου που θέλετε να διορθώσει ή να προσθέσει ο προμηθευτής, μπορείτε να ζητήσετε επεξεργασία στο έργο.

  1. Φορτώστε αρχεία, εάν υπάρχουν, τα οποία πρέπει να είναι κοινόχρηστα με τον προμηθευτή:

    ΔΗΜΟΣΙΕΥΣΗ/Αρχεία

  2. Μετακινήστε την πρόταση MBPRegister για κατάσταση submitterActionNeeded προβαίνοντας σε ενέργεια returnForEdits χρησιμοποιώντας το API POST/προτάσεων/{proposalId}/ενέργειας και καθορίστε τις παρακάτω λεπτομέρειες στο σώμα της αίτησης:

    • Ενέργεια: returnForEdits

    • Μήνυμα: Καθορίστε ένα σχόλιο (εάν απαιτείται) για την αναφορά προμηθευτή κατά την επιστροφή της αίτησης για επεξεργασία.

    • Αναγνωριστικά αρχείων: Καθορίστε το αναγνωριστικό αρχείου του αρχείου που έχει αποστείλετε εδώ, για να επισυνάψετε το αρχείο στο έργο αρθρωτού οφέλους.

    Μετά από αυτό, το έργο αρθρωτού οφέλους μετακινείται στην κατάσταση returnedForEdits .

Οι προμηθευτές μπορούν πλέον να προβάλλουν την πρόταση που είχε αποσταλεί για επεξεργασία. Τώρα μπορούν να επεξεργαστούν τα χαρακτηριστικά έργου αρθρωτού οφέλους και να φορτώσουν περισσότερα αρχεία στο έργο αρθρωτού οφέλους.

  • Προβολή πρότασης: GET/προτάσεις/{proposalId}

  • Φορτώστε και επισυνάψτε αρχεία στο έργο αρθρωτού οφέλους: ΔΗΜΟΣΙΕΥΣΤΕ/αρχεία και καθορίστε τις παρακάτω λεπτομέρειες στο σώμα της αίτησης:

    • Αρχείο ή διεύθυνση URL αρχείου
    • Ετικέτα: Περιγραφική ετικέτα αρχείου
    • ResourceURI: Καθορισμός URI πόρου για το αντίστοιχο έργο αρθρωτού οφέλους.
  • Ενημέρωση χαρακτηριστικών του έργου αρθρωτού οφέλους

    • Αποκτήστε τις ενημερωμένες λεπτομέρειες έργου αρθρωτού οφέλους GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} και αντιγράψτε την τιμή Etag από την κεφαλίδα απόκρισης.
    • Ενημερώστε τα χαρακτηριστικά έργου αρθρωτού οφέλους χρησιμοποιώντας το API PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} και καθορίστε την τιμή Etag στο κλειδί If-Match στην κεφαλίδα.

Μετά την ολοκλήρωση των αλλαγών, ο προμηθευτής μπορεί τώρα να υποβάλει την πρόταση ξανά στο μητρώο χρησιμοποιώντας το API POST/προτάσεων/{proposalId}/ενέργειας και να καθορίσει τις παρακάτω λεπτομέρειες στο αίτημα:

  • Ενέργεια: Υποβολή

  • Μήνυμα: Καθορίστε ένα σχόλιο (εάν υπάρχει) για αναφορά μητρώου.

Καταχώρηση πρόσθετων έργων αρθρωτού οφέλους

Υποβάλετε το οικολογικό όφελος για την εγγραφή στο μητρώο έκδοσης, δημιουργώντας και υποβάλλοντας μια πρόταση 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 από την κεφαλίδα απάντησης.
  • Ενημερώστε τα χαρακτηριστικά των επεξεργασμένων ισχυρισμών με τη χρήση του API PATCH/processedClaims/{processed_claim_id} και καθορίστε την τιμή Etag στο κλειδί If-Match στην κεφαλίδα.

Για κάθε σημείο ελέγχου που επαληθεύετε, μπορείτε να ενημερώσετε τα αποτελέσματα επαλήθευσης στο αντίστοιχο αποτέλεσμα του σημείου ελέγχου του επεξεργασμένου ισχυρισμού:

  • Φορτώστε και επισυνάψτε τις αναφορές εύρεσης επαλήθευσης στα αποτελέσματα του σημείου ελέγχου του επεξεργασμένου ισχυρισμού χρησιμοποιώντας το API POST/files και καθορίστε το αρχείο ή τη διεύθυνση URL του αρχείου, την Ετικέτα και το ResourceUri (θα είναι το uri πόρων του αποτελέσματος του σημείου ελέγχου) στο σώμα της αίτησης.
  • Ενημερώστε τα χαρακτηριστικά περιβάλλοντος πριν και μετά από το αποτέλεσμα του σημείου ελέγχου (εάν χρειάζεται):
    • Λάβετε τα στοιχεία του αποτελέσματος ελέγχου με την εντολή GET/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} και αντιγράψτε την τιμή Etag από την κεφαλίδα απάντησης.
    • Ενημερώστε τα χαρακτηριστικά του αποτελέσματος ελέγχου με τη χρήση του API PATCH/processedClaims/{processed_claim_Id}/checkpointResults/{checkpoint_result_Id} και καθορίστε την τιμή Etag στο κλειδί If-Match στην κεφαλίδα.
    • Μπορείτε επίσης να ενημερώσετε τα αποτελέσματα του σημείου ελέγχου χρησιμοποιώντας το API επιθέματος για επεξεργασμένους ισχυρισμούς.

Όταν ολοκληρωθεί η επαλήθευση, εγκρίνετε ή απορρίψτε την πρόταση MBPClaimVerify:

   POST/proposals/{proposalId}/action

Καθορίστε τις παρακάτω λεπτομέρειες:

  • Ενέργεια: Έγκριση ή απόρριψη

  • Μήνυμα: Καθορίστε ένα σχόλιο (εάν υπάρχει) για αναφορά προμηθευτή.

Μόλις εγκριθεί η πρόταση MBPClaimVerify, δημιουργήστε και υποβάλετε την πρόταση CreditMint για να υποβάλετε το αίτημα έκδοσης πίστωσης:

   POST/proposals/

Επιστροφή αίτησης ισχυρισμού για επεξεργασία

Εάν υπάρχουν ορισμένα κενά ή εσφαλμένες λεπτομέρειες στην αίτηση που ο Φορέας επικύρωσης και επαλήθευσης θέλει να διορθώσει ο προμηθευτής, μπορείτε να ζητήσει επεξεργασίες στην αίτηση ισχυρισμού αντί να εγκρίνει ή να απορρίψει την αίτηση. Αυτή η δυνατότητα είναι διαθέσιμη μόνο μέσω API.

  1. Φορτώστε και επισυνάψτε αρχεία (που θέλετε να μοιραστείτε με τον προμηθευτή) στον επεξεργασμένο ισχυρισμό ή στο αποτέλεσμα του σημείου ελέγχου της επεξεργασμένης απαίτησης: POST/files και καθορίστε τις παρακάτω λεπτομέρειες στο σώμα της αίτησης

    • Αρχείο ή διεύθυνση URL αρχείου
    • Ετικέτα
    • Το URI πόρου του επεξεργασμένου ισχυρισμού ή του αποτελέσματος του σημείου ελέγχου του επεξεργασμένου ισχυρισμού στην οποία πρέπει να προστεθεί το αρχείο
  2. Μετακινήστε την πρόταση MBPClaimVerify για κατάσταση submitterActionNeeded προβαίνοντας σε ενέργεια returnForEdits χρησιμοποιώντας το API POST/προτάσεων/{proposalId}/ενέργειας και καθορίστε τις παρακάτω λεπτομέρειες στο σώμα της αίτησης:

    • Ενέργεια: returnForEdits
    • Μήνυμα: Καθορίστε ένα σχόλιο (εάν απαιτείται) για την αναφορά προμηθευτή κατά την επιστροφή της αίτησης για επεξεργασία.

Επεξεργασία της πρότασης που έχει επιστραφεί

Οι προμηθευτές μπορούν έπειτα να προβάλλουν την πρόταση που είχε αποσταλεί για επεξεργασία. Τώρα μπορούν να επεξεργαστούν τα χαρακτηριστικά του ισχυρισμού και του σημείου ελέγχου, ενώ μπορούν να κάνουν αποστολή περισσότερων αρχείων στα σημεία ελέγχου των ισχυρισμών τους:

  1. Προβολή πρότασης: GET/προτάσεις/{proposalId}

    • Εάν απαιτείται, ο προμηθευτής μπορεί επίσης να δει τα αντίστοιχα στοιχεία του επεξεργασμένου ισχυρισμού χρησιμοποιώντας το API GET/processedClaims/{processed_claim_Id}.
  2. Φορτώστε και επισυνάψτε αρχεία (εάν υπάρχει) στα σημεία ελέγχου του ισχυρισμού: ΔΗΜΟΣΙΕΥΣΤΕ/αρχεία και καθορίστε τις παρακάτω λεπτομέρειες στο σώμα της αίτησης

    • Αρχείο ή διεύθυνση URL αρχείου
    • Ετικέτα
    • Το URI πόρου του σημείου ελέγχου στο οποίο πρέπει να προστεθεί το αρχείο
  3. Ενημερώστε τα χαρακτηριστικά ισχυρισμού χρησιμοποιώντας μια λειτουργία PATCH:

    • Αποκτήστε τις πιο πρόσφατες λεπτομέρειες της απαίτησης και σημειώστε την τιμή ETag στην κεφαλίδα απόκρισης: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
    • Ενημερώστε τα χαρακτηριστικά ισχυρισμού και προσδιορίστε την τιμή Etag στο κλειδί ‘If-Match’ της κεφαλίδας αίτησης: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
  4. Ενημερώστε τα χαρακτηριστικά του σημείου ελέγχου του ισχυρισμού χρησιμοποιώντας μια λειτουργία PATCH:

    • Αποκτήστε τις πιο πρόσφατες λεπτομέρειες σημείου ελέγχου και σημειώστε την τιμή ETag στην κεφαλίδα απόκρισης: GET /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/σημεία ελέγχου/{mbpcheckpoint_id}

    • Ενημερώστε τα χαρακτηριστικά ισχυρισμού και προσδιορίστε την τιμή Etag στο κλειδί If-Match της κεφαλίδας αίτησης: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/σημεία ελέγχου/{mbpcheckpoint_id}

      Σημείωμα

      Κατά τον καθορισμό των χαρακτηριστικών ενημέρωσης, βεβαιωθείτε ότι το σώμα της αίτησης JSON ακολουθεί την ίδια δομή όπως στην αντίστοιχη λήψη κλήσης API.

  5. Μετά την ολοκλήρωση των τροποποιήσεων, ο προμηθευτής μπορεί στη συνέχεια να υποβάλει την πρόταση ξανά στο σώμα επικύρωσης και επαλήθευσης χρησιμοποιώντας το API POST/προτάσεων/{proposalId}/ενέργειας και να καθορίσει τις παρακάτω λεπτομέρειες στο σώμα της αίτησης:

    • Ενέργεια: Εκ νέου υποβολή
    • Μήνυμα: Καθορίστε τυχόν σχόλιο (εάν απαιτείται) για αναφορά σώματος επικύρωσης και επαλήθευσης.

Μετά την εκ νέου υποβολή της πρότασης, ο Φορέας επικύρωσης και επαλήθευσης μπορεί να αναθεωρήσει την πρόταση και να την εγκρίνει, να την απορρίψει ή να ζητήσει ξανά τροποποιήσεις.

Ανάκληση της αίτησης πιστωτικής έκδοσης

Επιλογή για την ανάκληση της πρότασης πιστωτικής έκδοσης που έχει υποβληθεί (CreditMint):

Μετά την υποβολή της πρότασης πιστωτικής έκδοσης στο μητρώο, σε περίπτωση τυχόν ζητημάτων για τα οποία θέλετε να αποσύρετε την υποβληθείσα πρόταση, μπορείτε να αποσύρετε την υποβληθείσα πρόταση, εάν το μητρώο δεν έχει ενεργήσει κατόπιν αυτής της πρότασης. Αυτή η δυνατότητα είναι προς το παρόν διαθέσιμη μόνο από API.

  • Μετακινήστε την πρόταση CreditMint που είναι σε κατάσταση υποβολής σε κατάσταση ανακλήθηκε χρησιμοποιώντας API POST/proposals/{proposalId}/action και καθορίστε τις παρακάτω λεπτομέρειες στο σώμα της αίτησης:

    • Ενέργεια: Ανάκληση
    • Μήνυμα: Καθορίστε την αιτία (εάν υπάρχει) για την ανάκληση της πρότασης για αναφορά στο μητρώο.

Η κατάσταση της πρότασης έχει πλέον Ανακληθεί.

Μετά την έγκριση της αίτησης πιστωτικής έκδοσης, ο φορέας επικύρωσης και επαλήθευσης μπορεί να τροποποιήσει τον επεξεργασμένο ισχυρισμό και τα σχετικά αποτελέσματα του σημείου ελέγχου και, στη συνέχεια, να κάνει εκ νέου υποβολή του αιτήματος πιστωτικής έκδοσης.

  • Ανέβασμα και επισύναψη αρχείων στα αποτελέσματα των σημείων ελέγχου της επεξεργασμένης απαίτησης: POST/files και καθορίστε τις ακόλουθες λεπτομέρειες:

    • Αρχείο ή διεύθυνση URL αρχείου
    • Ετικέτα
    • 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}

Κάντε λήψη ενός αρχείου χρησιμοποιώντας το αναγνωριστικό αρχείου:

   GET/files/{fileId}

Έγκριση πιστώσεων

Φορτώστε αρχεία που θέλετε να επισυνάψετε στην πίστωση για έκδοση: ΔΗΜΟΣΙΕΥΣΤΕ/αρχεία και καθορίστε τις παρακάτω λεπτομέρειες στο σώμα της αίτησης:

  • Αρχείο ή διεύθυνση URL αρχείου
  • Ετικέτα

Έγκριση της πρότασης:

   POST/proposals/{proposalId}/action

Προσδιορίστε τις εξής λεπτομέρειες στο σώμα της αίτησης:

  • Ενέργεια: καθορισμός ως Μέντα
  • Μήνυμα: Καθορίστε το μήνυμα (εάν υπάρχει) για αναφορά σώματος επικύρωσης και επαλήθευσης
  • Αναγνωριστικά αρχείων: Καθορίστε τα αναγνωριστικά αρχείων των αρχείων που έχουν σταλεί, ώστε τα αρχεία να επισυναφθούν στην εκδοθείσα πίστωση
  • Ποσότητα
  • Ρετρό
  • Αναγνωριστικό παγίου στοιχείου
  • Καθορισμένη τιμή

Σημείωμα

Όταν η πρόταση εγκριθεί, θα δημιουργηθεί μια αντίστοιχη πίστωση.

Απόρριψη πρότασης

Ανεβάστε αρχεία (εάν υπάρχουν) στον επεξεργασμένο ισχυρισμό: POST/files και καθορίστε τις ακόλουθες λεπτομέρειες:

  • Αρχείο ή διεύθυνση URL αρχείου
  • Ετικέτα

Απόρριψη της πρότασης:

   POST/proposals/{proposalId}/action

Προσδιορίστε τις εξής λεπτομέρειες στο σώμα της αίτησης:

  • Ενέργεια: Απόρριψη
  • Μήνυμα: Καθορίστε ένα μήνυμα (εάν υπάρχει) για αναφορά σώματος επικύρωσης και επαλήθευσης
  • Αναγνωριστικά αρχείων: Καθορίστε τα αναγνωριστικά αρχείου του αρχείου που έχει αποσταλεί, έτσι ώστε αυτά να επισυναφθούν στη συσχετισμένη επεξεργασμένη αίτηση.

Επιστροφή αίτησης έκδοσης πίστωσης για τροποποιήσεις

Εάν υπάρχουν κενά ή εσφαλμένες λεπτομέρειες στην αίτηση έκδοσης που θέλετε να διορθώσει το σώμα επικύρωσης και επαλήθευσης, μπορείτε να ζητήσετε επεξεργασία στην αίτηση έκδοσης. Αυτή η δυνατότητα είναι διαθέσιμη μόνο μέσω API.

  1. Φορτώστε αρχεία (αν υπάρχουν) που θέλετε να μοιραστείτε με το σώμα επικύρωσης και επαλήθευσης ως μέρος της αποστολής της αίτησης έκδοσης ξανά για επεξεργασία.

  2. Μετακινήστε την αίτηση έκδοση (πρόταση CreditMint) σε κατάσταση submitterActionNeeded χρησιμοποιώντας το API POST/proposals/{proposalId}/action και καθορίστε τις παρακάτω λεπτομέρειες:

    • Ενέργεια: ReturnForEdits
    • Μήνυμα: Καθορίστε ένα μήνυμα (εάν υπάρχει) για αναφορά του σώματος επικύρωσης και επαλήθευσης, ώστε να μπορούν να κατανοήσουν τους λόγους για τους οποίο ζητείται η επεξεργασία.
    • Αναγνωριστικά αρχείων: Καθορίστε τα αναγνωριστικά αρχείου των αρχείων που έχει σταλεί (εάν υπάρχουν), έτσι ώστε τα αρχεία να επισυναφθούν στη συσχετισμένη επεξεργασμένη αίτηση.

Το σώμα επικύρωσης και επαλήθευσης μπορεί πλέον να προβάλει την πρόταση που έχει αποσταλεί για επεξεργασία. Τώρα μπορούν να επεξεργαστούν τα αντίστοιχα επεξεργασμένα αποτελέσματα αίτησης και σημείου ελέγχου. Μπορούν επίσης να ενημερώσουν χαρακτηριστικά, καθώς και να κάνουν αποστολή ενημερωμένων αρχείων στα αποτελέσματα των σημείων ελέγχου.

Εάν απαιτείται, ο φορέας επικύρωσης και επαλήθευσης στο σημείο αυτό μπορεί να ζητήσει διευκρινίσεις για την επαληθευμένο αίτηση, επιστρέφοντας την αίτηση για επεξεργασία στον προμηθευτή. Μόλις ο προμηθευτής κάνει εκ νέου υποβολή του ισχυρισμού, ο φορέας επικύρωσης και επαλήθευσης μπορεί να εξετάσει και να επαληθεύσει τον ισχυρισμό, να ενημερώσει τον αντίστοιχη επεξεργασμένο ισχυρισμό και, στη συνέχεια, να την υποβάλει εκ νέου στο μητρώο.

  1. Αποστολή και επισύναψη αρχείων στα αποτελέσματα των σημείων ελέγχου: POST/files και καθορίστε τις ακόλουθες λεπτομέρειες:

    • Αρχείο ή διεύθυνση URL αρχείου
    • Ετικέτα
    • ResourceURI των συσχετισμένων αποτελεσμάτων σημείου ελέγχου
  2. Ενημερώστε τα χαρακτηριστικά του επεξεργασμένου ισχυρισμού συμπεριλαμβανομένης της σύστασης πίστωσης: PATCH/processedClaim/{processed claim id}

  3. Εκ νέου υποβολή του αιτήματος έκδοσης στο μητρώο και καθορισμός των ακόλουθων λεπτομερειών στο σώμα του αιτήματος API: POST/proposals/{ proposal_id}/action

    • Ενέργεια: Εκ νέου υποβολή
    • Μήνυμα: Καθορίστε ένα μήνυμα (εάν υπάρχει) για αναφορά μητρώου

Μετά την εκ νέου υποβολή της αίτησης, το μητρώο έκδοσης μπορεί να επανεξετάσει την αίτηση και να την εγκρίνει, να την απορρίψει ή να ζητήσει εκ νέου επεξεργασία.

Προβολή εκδοθέντων πιστώσεων

   GET/credits

Αναζήτηση και προβολή πιστώσεων

Λήψη όλων των πιστώσεων:

   GET/credits

Σημείωμα

Αυτό το API θα επιστρέψει τη λίστα όλων των πιστώσεων. Στη συνέχεια, οι αγοραστές μπορούν να φιλτράρουν τη λίστα μόνοι τους με βάση την πιστωτική κατάσταση για προβολή μόνο των πιστωτικών μονάδων που παρατίθενται.

Προβάλετε τις λεπτομέρειες πίστωσης (συμπεριλαμβανομένης της γραμμής συγγένειαςςς) για μια συγκεκριμένη πίστωση που εμφανίζεται στη λίστα:

   GET/credits/{creditId}/lineage

Παράθεση πιστώσεων

Αυτή η ενότητα σάς δείχνει πώς να παραθέσετε πιστώσεις σε μια αγορά για ανταλλαγή μέσω API. Για οδηγίες σχετικά με τη χρήση του περιβάλλοντος εργασίας χρήστη, μεταβείτε στην Παράθεση πιστώσεων στην Υπηρεσία περιβαλλοντικής πίστωσης.

Εγγραφή ως αγοραστής ή αγορά

Υποβάλετε την πρόταση MarketplaceTraderRegister ως κάτοχος πίστωσης ή αγοραστής:

   POST/proposals

Λάβετε και εξετάστε όλες τις προτάσεις MarketplaceTraderRegister ως marketplace:

   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.

Χωρίστε την πίστωση καθορίζοντας τις ποσότητες (στο mtCO2e) για τουλάχιστον δύο θυγατρικές πιστώσεις ως κατόχους πίστωσης (για τις πιστώσεις που έχουν στην κυριότητά τους) ή ως αγορά (για τις πιστώσεις που παρατίθενται στην πλατφόρμα τους):

   POST/credits/{creditId}/split

Μεταφορά λίστας πίστωσης

Μι αγορά μπορεί να μεταφέρει μια λίστα πίστωσης από την πλατφόρμα σε άλλη αγορά. Αυτή η μεταφορά είναι επίσης γνωστή ως μεταφορά βάρους. Στην παραδοσιακή ροή, ένας προμηθευτής θα παρέθετε τις πιστώσεις σε μια αγορά που θα βοηθήσει με τη ζήτηση, την εκκαθάριση και τη διευθέτηση. Μερικές φορές μια αγορά μπορεί να μην είναι σε θέση να εκτελέσει την εκκαθάριση και τον διακανονισμό των πληρωμών από μόνη της και μπορεί να εξαρτάται από μια διαφορετική πλατφόρμα για την εκτέλεσή της. Σε αυτή την περίπτωση, το πάγιο στοιχείο πρέπει να μεταβιβαστεί στη νέα αγορά για να ολοκληρωθεί η συναλλαγή. Αυτή η δυνατότητα είναι διαθέσιμη προς το παρόν μόνο μέσω API.

Ως marketplace, δημιουργήστε και υποβάλετε την πρόταση MarketplaceListingTransfer για πίστωση που παρατίθενται στην πλατφόρμα σας:

   POST/proposals

Ως marketplace υπεύθυνου έγκρισης, προβάλετε όλες τις προτάσεις 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. Για οδηγίες σχετικά με τη χρήση του περιβάλλοντος εργασίας χρήστη, μεταβείτε στην Διαχείριση αρχείων στην Υπηρεσία περιβαλλοντικής πίστωσης.

Επισύναψη αρχείων

Χρησιμοποιήστε το API POST/αρχείων για να επισυνάψετε ένα αρχείο σε ένα πάγιο στοιχείο. Πρέπει να καθορίσετε τις εξής λεπτομέρειες:

  • Αρχείο ή διεύθυνση 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}

Χρησιμοποιήστε το αναγνωριστικό αρχείου που υπάρχει στις ιδιότητες αρχείου του αρχείου για να κάνετε λήψη του αρχείου:

   GET/files/{fileId}

Διαγραφή αρχείων

Χρησιμοποιήστε το αναγνωριστικό αρχείου του αρχείου για να καλέσετε το API διαγραφής:

   DELETE/files/{fileId}

Επισκόπηση
υπηρεσίας περιβαλλοντικής πίστωσης Διαμόρφωση υπηρεσίας
περιβαλλοντικής πίστωσης Γλωσσάριο υπηρεσίας περιβαλλοντικής πίστωσης