Pular para o conteúdo principal

Monitoramento ESG

O que você irá aprender com esse artigo?
  • Introdução ao Webhook de Monitoramento ESG
  • Pré-requisitos para criar Webhook de Monitoramento ESG
  • Benefícios do Webhook
  • Configuração do Webhook

Introdução ao Webhook de Monitoramento ESG​

Este serviço é projetado para fornecer notificações automáticas sobre mudanças de elegibilidade e compliance nos cadastros de produtores e fazendas, sem a necessidade de realizar consultas repetidas à nossa API. Utilizar este webhook ajuda a otimizar recursos e manter seu sistema atualizado com as informações mais recentes.

Pré-requisitos para criar Webhook de Monitoramento ESG​

Antes de começar a usar o Webhook de Monitoramento ESG, é essencial que você cadastre a base de dados de produtores e fazendas que deseja monitorar. Este cadastro inicial deve ser feito através de nossas APIs de cadastro. Após completar este passo, você poderá configurar e utilizar o webhook para monitoramento contínuo.

Cadastro​

Benefícios do Webhook​

  • Atualizações em Tempo Real: Receba notificações imediatas assim que ocorrer uma mudança de status.
  • Redução de Cargas de Consultas: Diminui a necessidade de chamadas frequentes à API, reduzindo o overhead e melhorando a performance do seu sistema.
  • Personalização de Eventos: Configure para receber apenas os tipos de eventos que são relevantes para sua operação.

Configuração do Webhook​

Para começar a usar o Webhook de Monitoramento ESG, siga os passos abaixo:

  1. Registrar o Webhook:

  • Acesse a seção 'Webhooks' no menu lateral.

  • Clique em Criar Webhook.

    • Siga as orientações fornecidas para criar um novo webhook.

      • Preencha os seguintes campos obrigatórios:

      • Evento do Webhook (webhook_event): Escolha um dos eventos válidos, como CHANGE_PRODUCER_STATUS_ESG, CHANGE_FARM_STATUS_ESG, etc.

      • URL: Forneça a URL do endpoint que receberá as notificações, por exemplo, https://api.cliente.com/api/v1/receive.

      • Autenticação Básica (opcional): Se necessário, forneça as credenciais para autenticação básica.

        {
          "webhook_event": "CHANGE_FARM_STATUS_ESG",
          "url": "https://api.cliente.com/api/v1/receive",
          "basic_authentication": "usuário:senha" // Se necessário
        }
  1. Cadastro Produtor/Proprietário:

  • Acesse a seção 'API > Produtores' no menu lateral.

  • Clique em Cadastrar Companhia Produtora e siga as orientações fornecidas.

    • Após cadastrar a companhia produtora, você receberá uma resposta com um ID. Exemplo de resposta:

      {
          "id": "string"
      }
  1. Cadastro Propriedade/Fazenda:

  • Acesse a seção 'API > Fazendas' no menu lateral.

  • Clique em Criar uma nova Fazenda e siga as orientações fornecidas.

    • Após cadastrar a nova fazenda, você receberá uma resposta com um ID. Exemplo de resposta:

      {
          "id": "string"
      }
  1. Exemplo de Notificação Recebida:
  • O cadastro do webhook responde 201 sem corpo. O JSON abaixo não é a resposta do cadastro: é o payload que a Merx envia ao endpoint que você cadastrou, quando o status ESG muda. Exemplo para o evento CHANGE_FARM_STATUS_ESG:
{
  "car": "MT-5107925-7515B28AEE9240ACAB464D8DF624D470",
  "old_status": "NAO_CONFORME",
  "new_status": "CONFORME"
}