Pular para o conteúdo principal

Notificações

O NDD Elog utiliza webhook para realizar o envio de notificações de cada etapa do processamento da viagem.

Atenção

Os dados devem ser enviados para a NDD para fins de configuração do webhook de notificações.

Como o webhook funciona no NDD Elog?

Para cada etapa do processamento das informações da viagem, o NDD Elog irá gerar notificações para acompanhamento do status.

Tipos de notificação que o NDD Elog envia

TypeDescrição
1CIOT (Código Identificador da Operação de Transporte)
2Vale-pedágio obrigatório
3MDF-e (Manifesto Eletrônico de Documentos Fiscais)
4Confirmação de entrega
5Ocorrências da viagem
6Imagem do comprovante de entrega
7Pagamento
8Conciliação do CT-e

O que eu preciso para receber as notificações?

Para integrar a API do NDD Elog e receber notificações importantes, como ocorrências da viagem e emissão de documentos fiscais, será necessário fornecer os dados de autorização e o endpoint POST, conforme abaixo:

Atenção

Os dados devem ser enviados para a NDD para fins de configuração do webhook de notificações.

Autorização

  • Disponibilizar para a NDD os dados de autorização para envio das notificações para a sua API.
CampoDescrição
URL do endpointEndpoint para gerar o token de autorização.
client_idIdentificador único para autenticação.
client_secretChave secreta para autenticação.

Endpoint de envio das notificações

  • Disponibilizar um endpoint POST para onde as notificações serão enviadas que seja capaz de processar os dados abaixo:
CampoDescrição
TypeTipo de notificação enviada.
IdIdentificador único do evento ou operação associado à notificação.
StatusStatus da operação. Pode ser 1 (Authorized) ou 2 (Failure).
MessageTexto descritivo detalhando o resultado do evento ou operação.

Exemplo de envio de notificação

  • Método: POST
  • URL: https://api.cliente.com.br/webhook/notifications

Cabeçalhos:

Content-Type: application/json
Authorization: Bearer <nosso_token_de_acesso>

Corpo

{
"Type": 1,
"Id": "8e57687f-9afe-419b-800b-49567673a67c",
"Status": 1,
"Message": "CIOT gerado com sucesso"
}

Resposta esperada (em caso de sucesso):

HTTP/1.1 200 OK

Resposta esperada (em caso de erro):

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
"error": "Invalid payload format"
}

Próximos passos

Cadastrar os dados iniciais para a integração com o NDD Elog.