Огляд довідника API для сервісу екологічного кредитування

Безкоштовна пробна версія

Важливо

Деякі або всі ці функції доступні в підготовчому версії. Вміст і функції можуть змінитися. Ви можете отримати доступ до середовища пісочниці Environmental Credit Service (підготовча версія) для 30-денного пробного періоду. Щоб використовувати Послугу екологічного кредитування (підготовча версія) у виробничому середовищі, заповніть форму реєстрації Служби екологічного кредитування (підготовча версія).

Ця стаття допоможе вам виконувати завдання з API REST сервісу екологічного кредитування. Щоб переглянути повний довідник API, перейдіть до довідника API служби екологічного кредитування. Ви можете знайти файл Swagger за адресою API REST служби екологічного кредитування.

• Реєструвати проекти
• Обробляйте претензії
• Видача кредитів
• Список кредитів
• Керуйте кредитами
• Встановлюйте цілі щодо викидів
• Відстежуйте викиди
• Кредити на пенсію
• Керування файлами

Реєстрація проектів

У цьому розділі показано, як створювати, подавати та перевіряти екологічні проєкти за допомогою API. Щоб отримати інструкцію щодо використання інтерфейсу користувача, перейдіть до розділу Реєстрація проектів у Сервісі екологічного кредиту.

• Створити проект
• Збережіть та надішліть проєкт
• Переглянути проект
• Схвалити або відхилити пропозицію
• Видалення файлу
• Поверніть пропозицію щодо редагування
• Зареєструйте додаткові модульні бенефіціарні проєкти
• Огляд модульного бенефісного проекту

Створення проекту

Щоб завантажити та прикріпити файли під час створення проекту:

1. Завантажте файли за допомогою POST/files. Вкажіть в API такі дані:

   • Файл або URL-адреса файлу
   • Тег опису для файлу

2. Створіть екологічний проєкт і відповідний модульний бенефіт-проєкт і вкажіть ідентифікатор файлу, який повертається у відповіді виклику POST/files API як атрибут у тілі запиту API створення проєкту: POST/ecoprojects.

Збережіть та надішліть проєкт

Ознайомтеся з деталями проекту:

   GET/ecoProjects/{ecoProjectId}

Перегляньте список файлів (і пов’язаних з ними метаданих), прикріплених до модульного проекту вигоди:

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

Завантажте файл за допомогою ідентифікатора файлу, доступного як частина метаданих файлу:

   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}

Завантажте файли, використовуючи fileId, який доступний як частина попередньої відповіді API:

   GET/files/{fileId}

Прикріпіть файл до модульного благодійного проекту:

   POST/files

Схвалити або відхилити пропозицію

Завантажити файли (за наявності):

POST/files і вкажіть File (або FileUrl) та деталі тегу

Відхилити запит на реєстрацію:

POST/proposals/{proposalId}/action та вкажіть наступні деталі в тілі запиту

• Дія: Відхилити

• Повідомлення: Вкажіть коментар (якщо такий є), який ви хочете надати для відхилення реєстрації.

• Ідентифікатори файлів: укажіть ідентифікатори файлів файлів, які було завантажено.

Видалення файлу

Перегляньте список файлів, які прикріплені до модульного бенефісного проекту:

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

Визначте файл, який ви завантажили, оскільки користувач може видалити лише ті файли, які він завантажив.

Видаліть файл:

   DELETE/files/{fileId}

Поверніть пропозицію щодо редагування

Якщо в атрибутах проекту або файлах є прогалини або неправильні деталі, які ви хочете, щоб постачальник виправив або додав, ви можете попросити внести зміни до проекту.

1. Завантажте файли, якщо такі є, які необхідно надати постачальнику:

   POST/файли

2. Перемістіть пропозицію MBPRegister у стан submitterActionNeeded , виконавши дію returnForEdits за допомогою API POST/proposals/{proposalId}/action та вкажіть наступні деталі в тілі запиту:

   • Дія: returnForEdits

   • Повідомлення: Вкажіть коментар (якщо потрібно) для рекомендації постачальника під час повернення запиту на редагування.

   • Ідентифікатори файлів: вкажіть ідентифікатор файлу завантаженого файлу тут, щоб прикріпити файл до відповідного модульного проекту пільг.

   Після того, як це буде зроблено, модульний проект бенефітів переходить у стан returnedForEdits .

Постачальники тепер можуть переглядати пропозицію, яку було надіслано на редагування. Тепер вони можуть редагувати атрибути модульного проекту бенефітів і завантажувати більше файлів до модульного проекту вигоди.

• Переглянути пропозицію: GET/пропозиції/{proposalId}

• Завантажте та прикріпіть до модульного благодійного проекту файли: POST/files та вкажіть у тілі запиту такі деталі:

  • Файл або URL-адреса файлу
  • Тег: Тег описового файлу
  • ResourceURI: Вкажіть URI ресурсу відповідного проекту модульного бенефісу.

• Оновлення атрибутів модульного бенефісного проекту

  • Отримайте оновлені деталі модульного бенефіту за допомогою GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} та скопіюйте значення Etag із заголовка відповідь.
  • Оновіть атрибути проекту modular benefit за допомогою PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} API та вкажіть значення Etag у ключі If-Match у заголовку.

Після завершення змін постачальник тепер може подати пропозицію назад до реєстру за допомогою API POST/proposals/{proposalId}/action та вказати в запиті такі деталі:

• Дія: Надіслати

• Повідомлення: укажіть коментар (якщо є) для посилання в реєстрі.

Зареєструйте додаткові модульні бенефіціарні проєкти

Подати екологічну вигоду для реєстрації до реєстру видачі шляхом створення та подання пропозиції 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 претензії

Подати претензії

Створіть та надішліть пропозицію щодо модульного бенефісуClaimVerify:

   POST/proposals

Переглянути деталі поданої пропозиції:

   GET/proposal/{proposalId}

Переглянути деталі позовної заяви:

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

Підтвердити претензію

Переглянути пропозиції:

   GET/proposals

Отримайте деталі конкретної пропозиції:

   GET/proposals/{proposalId}

Отримайте деталі конкретної претензії, щодо якої було подано пропозицію щодо перевірки:

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

Прийміть завдання перевірки претензії:

   POST/proposals/{proposalId}/action

Перелічіть файли, пов’язані з модульним благодійним проектом:

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

Перелічіть файли, пов’язані з контрольними точками претензій:

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

Перегляньте файл, вкладений у певний об’єкт:

   GET/files/{fileId}

Після прийняття претензії створюється відповідна «Оброблена претензія». Запишіть результати перевірки в обробленій заяві. Це включає оновлення кількості та вигод від позову. Перш ніж подавати запит на видачу кредиту, ви повинні оновити кредитні рекомендації також щодо обробленої заявки:

• Отримайте оброблені деталі заяви за допомогою GET/processedClaims/{processed_claim_id} і скопіюйте значення Etag із заголовка відповіді.
• Оновіть оброблені атрибути претензій за допомогою PATCH/processedClaims/{processed_claim_id} API та вкажіть значення 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/proposals/{proposalId}/action та вкажіть наступні деталі в тілі запиту:

   • Дія: returnForEdits
   • Повідомлення: Вкажіть коментар (якщо потрібно) для рекомендації постачальника під час повернення запиту на редагування.

Відредагуйте повернуту пропозицію

Після цього постачальники можуть переглянути пропозицію, яку було надіслано на редагування. Тепер вони можуть редагувати атрибути claim та checkpoint, а також завантажувати більше файлів на контрольні точки заявок:

1. Переглянути пропозицію: GET/пропозиції/{proposalId}

   • Якщо потрібно, постачальник також може переглянути відповідні деталі обробленої претензії за допомогою GET/processedClaims/{processed_claim_Id} API.

2. Завантажте та прикріпіть файли (якщо такі є) до контрольних точок претензій: POST/files та вкажіть наступні дані в тілі запиту

   • Файл або URL-адреса файлу
   • Тег
   • URI ресурсу контрольної точки, до якої має бути додано файл

3. Оновіть атрибути твердження за допомогою операції PATCH:

   • Отримайте найновішу інформацію про претензію та запишіть значення ETag у заголовку відповіді: GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}
   • Оновіть атрибути claim та вкажіть значення 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}//checkpoints/{mbpcheckpoint_id}

   • Оновіть атрибути claim та вкажіть значення Etag у ключі If-Match заголовка запиту: PATCH /ecoprojects/{ecoproject_id}/mbps/{mbp_id}/mbpclaims/{mbpclaim_id}/checkpoints/{mbpcheckpoint_id}

     Нотатка

     Під час визначення атрибутів оновлення переконайтеся, що тіло запиту JSON має ту саму структуру, що й у відповідному виклику get API.

5. Після того, як зміни будуть виконані, постачальник може відправити пропозицію назад до органу валідації та верифікації за допомогою API POST/proposals/{proposalId}/action та вказати наступні деталі в тілі запиту:

   • Дія: надіслати повторно
   • Повідомлення: вкажіть будь-який коментар (якщо потрібно) для перевірки та посилання на орган підтвердження.

Після повторного подання пропозиції Орган валідації та верифікації може розглянути пропозицію та затвердити, відхилити або знову попросити внести зміни.

Відкликати запит на видачу кредиту

Можливість відкликати поданий запит на видачу кредиту (CreditMint)пропозицію:

Після того, як пропозиція про видачу кредиту буде подана до реєстру, у разі виникнення будь-яких проблем, через які ви хочете відкликати подану пропозицію, ви можете відкликати подану пропозицію, якщо реєстр не відреагував на пропозицію. Наразі ця можливість доступна лише для API.

• Перемістіть пропозицію CreditMint, яка знаходиться в поданому стані, в стан відкликання за допомогою API POST/proposals/{proposalId}/action та вкажіть наступні деталі в тілі запиту:

  • Дія: Відкликати
  • Повідомлення: Вкажіть причину (якщо така є) для відкликання пропозиції про довідку до реєстру.

Статус пропозиції тепер відкликаний.

Після відкликання запиту на видачу кредиту орган перевірки та підтвердження може змінити «оброблену заявку» та пов’язані з нею результати контрольної точки, а потім повторно надіслати запит на видачу кредиту.

• Завантажте та прикріпіть файли до результатів контрольної точки обробки заявки: POST/files та вкажіть наступні дані:

  • Файл або URL-адреса файлу
  • Тег
  • ResourceURI пов’язаного результату контрольної точки.

• Оновіть атрибути обробленої заявки: PATCH/processedClaims/{processedClaim_Id}

• Повторно надішліть запит на видачу до реєстру та вкажіть наступні деталі в тілі запиту API: POST/proposals/{ proposal_id}/action

  • Дія: укажіть як повторне надсилання
  • Повідомлення: Вкажіть повідомлення/коментар (якщо є) для посилання на реєстр

Видача кредитів

У цьому розділі показано, як переглядати та виплачувати кредити через API. Щоб отримати інструкції щодо використання інтерфейсу користувача, перейдіть до розділу Видача кредитів у Службі екологічного кредитування.

• Огляд пропозицій
• Затвердити кредити
• Відхилити пропозицію
• Повернення запиту на видачу кредиту для редагувань
• Переглянути видані кредити
• Пошук і перегляд кредитів

Розгляд пропозицій щодо видачі кредитів

Перегляньте подану пропозицію щодо карбування токенів та отримайте URI ресурсу «Оброблена заявка», який було надіслано на розгляд:

GET/proposal/{proposalId}

Перегляньте результати перевірки органу валідації та верифікації, переглянувши оброблену заяву та пов’язані з нею результати контрольних точок (разом із пов’язаними файлами):

GET/processedClaims/{processedClaims_Id} 

Перегляньте претензію та відповідні деталі контрольно-пропускного пункту (разом з переліком файлів, прикріплених постачальником для пунктів пропуску):

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

Перегляньте деталі проекту modular benefit разом із списком прикріплених файлів:

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

Завантажте файл за ідентифікатором файлу:

   GET/files/{fileId}

Затвердити кредити

Завантажте файли, які ви хочете прикріпити до кредиту для видачі: POST/files та вкажіть наступні дані в тілі запиту:

• Файл або 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{/обробленої заявки}

3. Повторно надішліть запит на видачу та вкажіть деталі нижче в тілі запиту API: POST/proposals/{ proposal_id}/action

   • Дія: надіслати повторно
   • Повідомлення: укажіть повідомлення (якщо є) для довідки з реєстру

Після повторного подання запиту видавець реєстру може розглянути запит і затвердити, відхилити або знову запросити правки.

Переглянути видані кредити

   GET/credits

Пошук і перегляд кредитів

Отримати всі кредити:

   GET/credits

Нотатка

Цей API поверне список усіх кредитів. Після цього покупці можуть самостійно фільтрувати список за статусом кредиту, щоб переглядати лише перераховані кредити.

Перегляньте деталі кредиту (включно з родоводом) для конкретного кредиту, що відображається у списку:

   GET/credits/{creditId}/lineage

Створення списку кредитів

У цьому розділі показано, як розмістити кредити на маркетплейсі для торгівлі через API. Щоб отримати інструкції щодо використання інтерфейсу користувача, перейдіть до розділу Список кредитів у Службі екологічного кредитування.

• Зареєструйтесь як покупець на маркетплейсі
• Подати пропозицію щодо переліку кредитів
• Розгляд пропозиції щодо включення кредиту

Зареєструйтесь як покупець або маркетплейс

Надішліть пропозицію MarketplaceTraderRegister як власник або покупець кредиту:

   POST/proposals

Отримайте та перегляньте всі пропозиції MarketplaceTraderRegister як маркетплейс:

   GET/proposals

Схвалити або відхилити пропозиції як маркетплейс:

   POST/proposals/{proposalId}/action

Отримайте та перегляньте всіх трейдерів, зареєстрованих на їхній платформі як маркетплейс:

   GET/marketplaces/{marketplaceId}/traders

Подати пропозицію щодо переліку кредитів

Створіть та надішліть пропозицію MarketplaceListingRegister:

   POST/proposals

Розгляд пропозиції щодо включення кредиту

   GET/proposals

   POST /proposals/{proposalId}/action

Керування кредитами

У цьому розділі показано, як керувати кредитами через API. Щоб отримати інструкції щодо використання інтерфейсу користувача, перейдіть до розділу Керування кредитами в Службі екологічного кредитування.

• Видалити кредит зі списку
• Передача права власності
• Переглянути кредитний родовід
• Розділити кредит
• Список кредитів на переказ

Видалити кредит зі списку

Дроблення кредиту є самостійною операцією в службі екологічного кредиту. Щоб дізнатися більше про розподіл кредиту через API, перейдіть до розділу Розділення кредиту. Після того, як кредит буде розділено, ви можете перейти до наступного кроку.

Створіть та надішліть пропозицію MarketplaceListingСкасувати реєстрацію:

   POST/proposals

Переглянути всі пропозиції MarketplaceListingDeregister, подані на розгляд:

   GET/proposals

Щоб схвалити або відхилити пропозицію:

   POST/proposals/{proposalId}/action

Передача права власності

   POST/credits/{creditId}/transfer/

Переглянути кредитний родовід

Організації з ролями постачальників і реєстру можуть переглядати кредитну лінію для кредитів, якими вони володіють або видалили:

   GET/credits/{creditId}/lineage

Розділити кредит

Ви можете розділити кредит на дочірні елементи кредити. Наразі цей функціонал доступний лише через API.

Розділіть кредит, вказавши кількість (у mtCO2e) принаймні двох кредитів дочірніх елементів як власника кредиту (для кредитів, якими вони володіють) або як маркетплейс (для кредитів, перелічених на їхній платформі):

   POST/credits/{creditId}/split

Список кредитів на переказ

Маркетплейс може перенести кредитний список зі своєї платформи на інший ринок. Ця передача також відома як передача обтяження. У традиційному потоці постачальник виставляє кредити на маркетплейсі, що допоможе з попитом, клірингом і розрахунками. Іноді маркетплейс може бути не в змозі самостійно виконати кліринг і розрахунки платежів і може залежати від іншої платформи для їх виконання. У цьому випадку актив необхідно перенести на новий маркетплейс для завершення транзакції. Наразі ця функція доступна лише через API.

Як маркетплейс, створіть і надішліть пропозицію MarketplaceListingTransfer для кредиту, зазначеного на вашій платформі:

   POST/proposals

Як маркетплейс, що затверджує, перегляньте всі пропозиції MarketplaceListingTransfer, надіслані їм для ознайомлення:

   GET/proposals

Як маркетплейс, схвалити або відхилити пропозицію. Якщо пропозиція схвалена, то обтяження кредитів переноситься з початкового маркетплейсу на маркетплейс затвердження:

   POST/proposals/{proposalId}/action

Часткова передача обтяження: Маркетплейс може передати обтяження за частковий кредит, спочатку розділивши кредит як незалежну дію. Щоб дізнатися більше про те, як розділити кредит, перегляньте статтю Розділення кредиту. Після того, як кредит буде розділено, перейдіть до наведених вище кроків для передачі обтяження кредитів дочірнього елемента.

Встановлюйте цілі щодо викидів

У цьому розділі показано, як налаштувати цілі та завдання щодо скорочення викидів за допомогою API.

• Створюйте цілі щодо викидів
• Перегляд цільових показників викидів

Створюйте цілі щодо викидів

   POST/esgs

Перегляд цільових показників викидів

   GET/esgs

Відстежуйте викиди

У цьому розділі показано, як відстежувати викиди за допомогою системи показників викидів, яку ви встановили за допомогою API. Щоб отримати інструкції щодо використання інтерфейсу користувача, перейдіть до розділу Відстеження цілей викидів у службі екологічного кредитування.

• Створюйте етапи за конкретний звітний період
• Відстежуйте фактичні викиди відповідно до етапу

Створюйте етапи за конкретний звітний період

   POST/esgs/{esgScorecardId}/milestones

Отримайте всі етапи:

   GET/esgs/{esgScorecardId}/milestones

Отримайте конкретний етап:

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

Відстежуйте фактичні викиди відповідно до етапу

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

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

Списання кредитів

У цьому розділі показано, як компенсувати надмірні викиди шляхом відмови від власних вуглецевих кредитів через API. Щоб отримати інструкції щодо використання інтерфейсу користувача, перейдіть до розділу Пенсійні кредити в Службі екологічного кредитування.

• Подати пропозицію щодо виходу на пенсію за кредитом
• Перегляньте пропозицію щодо виходу на пенсію за кредитом
• Часткове погашення кредиту

Подати пропозицію щодо виходу на пенсію за кредитом

Створіть та надішліть пропозицію ESGEmissionOffset:

   POST/proposals

Покупці також можуть відмовитися від вуглецевого кредиту безпосередньо, не вказуючи викиди, які потрібно компенсувати. Цей функціонал доступний лише через API.

Створіть та надішліть пропозицію CreditRetire:

   POST/proposals

Перегляньте пропозицію щодо виходу на пенсію за кредитом

   GET/proposals

   GET/proposals/{proposalId}

До кредиту, який розглядається для виходу на пенсію, прикріпити файл:

   POST/files

   POST/proposals/{proposalId}/action

Часткове погашення кредиту

Щоб дізнатися більше про розподіл кредиту через API, перейдіть до розділу Розділення кредиту.

Після того, як кредит буде розділено, використовуйте API на попередніх кроках для взаємозаліку та вибуття.

Керування файлами

У цьому розділі показано, як вкладати, переглядати та видаляти файли для таких ресурсів, як проекти, заявки та кредити, за допомогою API. Щоб отримати інструкції щодо використання інтерфейсу користувача, перейдіть до розділу Керування файлами в Службі екологічного кредитування.

• Прикріпити файли
• Переглянути файли
• Видалити файли

Вкласти файли

Використовуйте API POST/files, щоб прикріпити файл до ресурсу. Потрібно вказати такі реквізити:

• Файл або 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}

Пов’язані відомості

Огляд
служби екологічного кредитування Налаштування служби екологічного кредитування
Глосарій служби екологічного кредитування

📄 Сторінка
🎓 продукту Навчання

✅ Безкоштовний пробний
🎥 YouTube канал

💻 Група спільноти
в LinkedIn