Поделиться через

Справочный обзор API-интерфейса для службы экологических кредитов

  • Статья

Значок Microsoft Cloud for Sustainability.

             Бесплатная пробная версия

Важно

Некоторые или все функции доступны в рамках предварительного выпуска. Содержимое и функциональность могут быть изменены. Вы можете получить доступ к среде песочницы службы экологических кредитов (предварительная версия) для 30-дневной пробной версии. Чтобы использовать службу экологических кредитов (предварительная версия) в производственной среде, заполните форму регистрации в службе экологических кредитов (предварительная версия).

Эта статья поможет вам выполнять задачи с помощью API-интерфейсов REST службы экологических кредитов. Чтобы просмотреть полный справочник по API-интерфейсам, перейдите по ссылке Справочник по API-интерфейсам службы экологических кредитов. Файл Swagger можно найти по адресу API-интерфейс REST службы экологических кредитов.

Регистрация проектов

В этом разделе показано, как создавать, отправлять и просматривать экологические проекты с помощью API-интерфейсов. Инструкции по использованию пользовательского интерфейса см. в разделе Регистрация проектов в службе экологических кредитов.

Создать проект

Чтобы отправить и прикрепить файлы во время создания проекта:

  1. Отправьте файлы с помощью POST/files. Укажите следующие сведения в API-интерфейсе:

    • Файл или URL-адрес файла
    • Описательный тег для файла

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

Сохранение и отправка проекта

Извлечение сведений о проекте:

   GET/ecoProjects/{ecoProjectId}

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

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

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

   GET/files/{fileId}

Добавьте файлы в модульный проект преимуществ:

   POST/files

Укажите URI ресурса модульного проекта преимуществ в тексте запроса.

Отправьте проект модульных преимуществ на регистрацию, отправив предложение MMBPRegister:

   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

Утверждение или отклонение предложения

Отправьте файлы (при наличии):

POST/files и укажите файл (или FileUrl) и данные тега

Отклонение запроса регистрации:

POST/proposals/{proposalId}/action и укажите в теле запроса следующие данные

  • Действие: Отклонить

  • Сообщение: укажите комментарий (если есть), который вы хотите предоставить для отклонения регистрации.

  • FileIDs: укажите идентификаторы отправленных файлов.

Удаление файла

Просмотрите список файлов, прикрепленных к проекту модульных преимуществ:

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

Определите файл, который вы отправили, поскольку пользователь может удалить только те файлы, которые он отправил.

Удалите файл:

   DELETE/files/{fileId}

Возврат предложения для внесения изменений

Если в атрибутах или файлах проекта есть какие-то пробелы или неверные сведения, которые вы хотите, чтобы поставщик исправил или добавил, вы можете попросить внести изменения в проект.

  1. Отправьте файлы, если таковые имеются, которые необходимо предоставить поставщику:

    POST/files

  2. Переведите предложение MBPRegister в состояние SubmitterActionNeded, выполнив действие returnForEdits с использованием API-интерфейса POST/proposals/{proposalId}/action и укажите в тексте запроса следующие данные:

    • Действие: returnForEdits

    • Сообщение: укажите комментарий (если требуется) для справки поставщика при возврате запроса на внесение изменений.

    • Идентификаторы файлов: укажите здесь идентификатор отправленного файла, чтобы прикрепить его к соответствующему проекту модульных преимуществ.

    После этого модульный проект преимуществ переходит в состояние returnedForEdits.

Поставщики теперь могут просмотреть предложение, которое было отправлено обратно на редактирование. Теперь они могут редактировать атрибуты проекта модульных преимуществ и отправлять дополнительные файлы в проект модульных преимуществ.

  • Посмотреть предложение: GET/proposals/{proposalId}

  • Отправьте и прикрепите к проекту модульных преимуществ файлы: POST/files и в теле запроса укажите следующие данные:

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

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

    • Получите обновленную информацию о проекте модульных преимуществ, используя GET/ecoprojects/{ecoproject_id}/mbps/{mbp_id} и скопируйте значение Etag из заголовка ответа.
    • Обновите атрибуты проекта модульных преимуществ, используя API-интерфейс PATCH/ecoprojects/{ecoproject_id}/mbps/{mbp_id} и укажите значение 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 ресурса требования

Отправка требований

Создайте и отправьте предложение модульного преимущества 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-интерфейс PPATCH/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 в состояние SubmitterActionNeded, выполнив действие returnForEdits с использованием API-интерфейса POST/proposals/{proposalId}/action и укажите в тексте запроса следующие данные:

    • Действие: returnForEdits
    • Сообщение: укажите комментарий (если требуется) для справки поставщика при возврате запроса на внесение изменений.

Изменение возвращенного предложения

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

  1. Посмотреть предложение: GET/proposals/{proposalId}

    • При необходимости поставщик также может просмотреть сведения о соответствующем обработанном требовании с помощью API-интерфейса GET/processedClaims/{processed_claim_Id}.

  2. Отправьте и прикрепите файлы (при наличии) к контрольным точкам требования: POST/files и в теле запроса укажите следующие данные

    • Файл или 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}/checkpoints/{mbpcheckpoint_id}

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

      Заметка

      При указании атрибутов обновления убедитесь, что текст запроса JSON соответствует той же структуре, что и соответствующий вызов API get.

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

    • Действие: Отправить заново
    • Сообщение: укажите любой комментарий (если требуется) для сведения органа по валидации и верификации.

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

Отзыв запроса выдачи кредита

Возможность отозвать поданное предложение о выдаче кредита (CreditMint):

После подачи предложения о выдаче кредита в реестр, в случае возникновения каких-либо проблем, из-за которых вы хотите отозвать поданное предложение, вы можете отозвать поданное предложение, если реестр не принял действий по этому предложению. Эта возможность в настоящее время доступна только через API-интерфейсы.

  • Переместите предложение CreditMint, находящееся в состоянии «Отправлено», в состояние отозвано с использованием API-интерфейса POST/proposals/{proposalId}/action и укажите в тексте запроса следующие данные:

    • Действие: Отозвать
    • Сообщение: укажите причину (если таковая имеется) отзыва предложения для информирования реестра.

Статус предложения сейчас Отозвано.

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

  • Отправьте и прикрепите файлы к результатам контрольной точки обработанного требования: POST/files и укажите следующие данные:

    • Файл или FileURL
    • Тег
    • 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}

Утверждение кредитов

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

  • Файл или URL-адрес файла
  • Тег

Утверждение предложения:

   POST/proposals/{proposalId}/action

Укажите следующие данные в тексте запроса:

  • Действие: укажите как Mint
  • Сообщение: укажите сообщение (при наличии) для сведения органа по валидации и верификации
  • Идентификаторы файлов: укажите идентификаторы отправленных файлов, чтобы файлы были прикреплены к выданному кредиту
  • Количество
  • Винтаж
  • ИД актива
  • Определенное значение

Заметка

Когда предложение одобрено, будет создан соответствующий кредит.

Отклонение предложения

Отправьте файлы (при наличии) к обработанному требованию: 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-интерфейс см. в разделе Разделение кредита. После разделения кредита вы можете перейти к следующему шагу.

Создайте и отправьте предложение MarketplaceListingDeregister:

   POST/proposals

Просмотр всех предложений MarketplaceListingDeregister, представленных на рассмотрение:

   GET/proposals

Чтобы утвердить или отклонить предложение:

   POST/proposals/{proposalId}/action

Передача права владения

   POST/credits/{creditId}/transfer/

Просмотр происхождения кредита

Организации с ролями поставщика и реестра могут просматривать кредитную линию кредитов, которыми они владеют или выдали:

   GET/credits/{creditId}/lineage

Разделение кредита

Вы можете разделить кредит на дочерние кредиты. Эта функциональная возможность в настоящее время доступна только через API-интерфейсы.

Разделите кредит, указав количества (в млн тонн CO2-экв.) как минимум для двух дочерних кредитов в качестве владельца кредита (для кредитов, которыми они владеют) или в качестве торговой площадки (для кредитов, размещенных на их платформе):

   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.Группа в LinkedIn