Eventos no Serviço de Crédito Ambiental (versão preliminar)
As organizações transacionais podem extrair eventos do Serviço de Crédito Ambiental (versão preliminar) para entender quais ativos foram alterados desde a última interação com o aplicativo. No momento, essa capacidade só é permitida por APIs.
Tipos de eventos aceitos
A tabela a seguir fornece detalhes para os tipos de eventos aceitos pelo Serviço de Crédito Ambiental (versão preliminar).
| ID do tipo de evento | Nome do tipo de evento | URI de tipo de evento | Tipo de organização que pode receber os eventos |
|---|---|---|---|
| 0 | MBP criada | ecoProjects/modularBenefitProjects/create | Supplier |
| 2 | MBP enviada para registro | ecoProjects/modularBenefitProjects/registration/submit | Fornecedor, registro emissor |
| 3 | MBP aprovada | ecoProjects/modularBenefitProjects/registration/approve | Fornecedor, registro emissor |
| 4 | MBP Rejeitada | ecoProjects/modularBenefitProjects/registration/reject | Fornecedor, registro emissor |
| 5 | Declaração de MBP criada | ecoProjects/modularBenefitProjects/claims/create | Supplier |
| 6 | Declaração de MBP enviada | ecoProjects/modularBenefitProjects/claims/verification/submit | Fornecedor, registro emissor, corpo de validação e verificação |
| 7 | Declaração de MBP na verificação | ecoProjects/modularBenefitProjects/claims/verification/accept | Fornecedor, registro emissor, corpo de validação e verificação |
| 8 | Declaração de MBP rejeitada | ecoProjects/modularBenefitProjects/claims/verification/reject | Fornecedor, registro emissor, corpo de validação e verificação |
| 9 | Declaração de MBP aprovada | ecoProjects/modularBenefitProjects/claims/verification/approve | Fornecedor, corpo de validação e verificação |
| 10 | Solicitação de emissão de crédito enviada | processedClaims/submit | Fornecedor, órgão de validação e verificação, registro de emissor |
| 11 | Emissão de crédito aprovada | processedClaims/approve | Fornecedor, órgão de validação e verificação, registro de emissor |
| 12 | Emissão de crédito rejeitada | processedClaims/reject | Fornecedor, órgão de validação e verificação, registro de emissor |
| 13 | Divisão de crédito | credits/split | Proprietário do crédito (fornecedor ou comprador), corpo de validação e verificação, marketplace (se o crédito estiver listado) |
| 14 | Solicitação de listagem de crédito enviada | credits/listing/submit | Proprietário do crédito (fornecedor ou comprador), marketplace |
| 15 | Listagem de crédito aprovada | credits/listing/approve | Proprietário do crédito (fornecedor ou comprador), marketplace, corpo de validação e verificação |
| 16 | Listagem de crédito rejeitada | credits/listing/reject | Proprietário do crédito (fornecedor ou comprador), marketplace |
| 17 | Solicitação de registro de trader enviada | traders/registration/submit | Fornecedor ou comprador, marketplace |
| 18 | Registro de trader aprovado | traders/registration/approve | Fornecedor ou comprador, marketplace |
| 19 | Registro de trader rejeitado | traders/registration/reject | Fornecedor ou comprador, marketplace |
| 20 | Propriedade do crédito transferida Observação Este evento é emitido quando os detalhes do proprietário ou do comprador final de um crédito são atualizados. | credits/transfer | Proprietário do crédito atual e anterior (fornecedor ou comprador), marketplace (se o crédito estiver listado), corpo de validação e verificação. |
| 21 | Solicitação de cancelamento de listagem de crédito enviada | credits/delisting/submit | Proprietário do crédito (fornecedor ou comprador), marketplace |
| 22 | Cancelamento de listagem de crédito aprovada | credits/delisting/approve | Proprietário do crédito (fornecedor ou comprador), marketplace, corpo de validação e verificação |
| 23 | Cancelamento de listagem de crédito rejeitada | credits/delisting/reject | Proprietário do crédito (fornecedor ou comprador), marketplace |
| 24 | Solicitação de retirada de crédito enviada | credits/retirement/submit | Comprador, corpo de validação e verificação |
| 25 | Retirada de crédito aprovada | credits/retirement/approve | Comprador, corpo de validação e verificação |
| 26 | Retirada de crédito rejeitada | credits/retirement/reject | Comprador, corpo de validação e verificação |
| 27 | Solicitação de transferência de listagem de crédito enviada | credits/listingTransfer/submit | Marketplaces transacionais, proprietário do crédito (fornecedor ou comprador) |
| 28 | Transferência de listagem de crédito aprovada | credits/listingTransfer/approve | Marketplaces transacionais, proprietário do crédito (fornecedor ou comprador), corpo de validação e verificação |
| 29 | Transferência de listagem de crédito rejeitada | credits/listingTransfer/reject | Marketplaces transacionais, proprietário do crédito (fornecedor ou comprador) |
| 30 | Registro de MBP retornado para edições | ecoProjects/modularBenefitProjects/registration/returnForEdits | Fornecedor, registro emissor |
| 31 | MBP reenviada para registro | ecoProjects/modularBenefitProjects/registration/resubmit | Fornecedor, registro emissor |
| 32 | Declaração de MBP retornada para edições | ecoProjects/modularBenefitProjects/claims/verification/returnForEdits | Fornecedor, registro emissor, corpo de validação e verificação |
| 33 | Declaração de MBP reenviada | ecoProjects/modularBenefitProjects/claims/verification/resubmit | Fornecedor, registro emissor, corpo de validação e verificação |
| 34 | Solicitação de emissão de crédito retornado para edições | processedClaims/returnForEdits | Fornecedor, órgão de validação e verificação, registro de emissor |
| 35 | Solicitação de emissão de crédito reenviada | processedClaims/resubmit | Fornecedor, órgão de validação e verificação, registro de emissor |
| 36 | Solicitação de emissão de crédito retirada | processedClaims/withdraw | Fornecedor, órgão de validação e verificação, registro de emissor |
| 37 | Solicitação de emissão de crédito criada | processedClaims/create | Corpo de validação e verificação |
| 38 | Solicitação de emissão de crédito atualizada | processedClaims/update | Corpo de validação e verificação |
| 39 | Solicitação de listagem de crédito retornada para edições | credits/listing/returnForEdits | Proprietário do crédito (proprietário do projeto ou comprador), marketplace |
| 40 | Solicitação de listagem de crédito reenviada | credits/listing/resubmit | Proprietário do crédito (proprietário do projeto ou comprador), marketplace |
| 41 | Solicitação de registro de comerciante retornada para edições | traders/registration/returnForEdits | Proprietário ou comprador do projeto, marketplace |
| 42 | Solicitação de registro de comerciante reenviada | traders/registration/resubmit | Proprietário ou comprador do projeto, marketplace |
| 43 | Solicitação de retirada da lista de crédito retornada para edições | credits/delisting/returnForEdits | Proprietário do crédito (proprietário do projeto ou comprador), marketplace |
| 44 | Solicitação de retirada da lista de crédito reenviada | credits/delisting/resubmit | Proprietário do crédito (proprietário do projeto ou comprador), marketplace |
| 45 | Solicitação de desativação de crédito retornada para edições | credits/retirement/returnForEdits | Comprador, registro padrão |
| 46 | Solicitação de desativação de crédito reenviada | credits/retirement/resubmit | Comprador, registro padrão |
| 47 | Solicitação de transferência da lista de crédito retornada para edições | credits/listingTransfer/returnForEdits | Marketplaces de transações, proprietário do crédito (proprietário ou comprador do projeto) |
| 48 | Solicitação de transferência de lista de crédito reenviada | credits/listingTransfer/resubmit | Marketplaces de transações, proprietário do crédito (proprietário ou comprador do projeto) |
As organizações podem visualizar a lista de tipos de eventos que podem receber usando o seguinte ponto de extremidade de API:
GET/notifications/eventtypes
Exibir eventos
As organizações podem extrair os eventos que ocorreram, descritos nos tipos de evento acima, para seus ativos associados usando o seguinte ponto de extremidade de API:
GET/notifications/events
As organizações podem filtrar os eventos com base nos seguintes critérios:
Tipos de eventos: com esse filtro, são retornados eventos apenas para os tipos especificados. As organizações precisam fornecer o URI do tipo de evento para esta opção de filtro. O nome da chave do filtro é eventTypeUris.
Intervalo de data e hora específico: as organizações podem especificar a data e hora mínima e máxima para receber apenas os eventos que ocorreram durante o intervalo de tempo especificado. Os nomes das chaves de filtro são minEventDateTimeInUtc e maxEventDateTimeInUtc. A data e a hora devem ser especificadas no formato UTC, e os filtros incluem a data e a hora especificadas.
Último evento pesquisado: as organizações podem especificar seu último evento pesquisado e receber todos os eventos após esse evento usando este filtro. O nome da chave do filtro é lastFetchedEventId. Você precisa especificar o ID do evento para este filtro.
Controle de acesso para eventos
A organização pode visualizar eventos apenas para os ativos que estão associados a eles. Por exemplo, um corpo de validação e verificação pode receber eventos apenas para os créditos que emitiu e não para os créditos emitidos por outro registro, ou um marketplace pode receber eventos apenas para os créditos que estão listados em sua plataforma. Além disso, todas as funções de usuário de uma organização, como administrador, colaborador e leitor, têm permissão para visualizar eventos.
Confira também
Configurar o Serviço de Crédito Ambiental (Versão Preliminar)Glossário do Serviço de Crédito Ambiental (Versão Preliminar)Visão Geral de Referência da API para Serviço de Crédito Ambiental (Versão Preliminar)