A empresa que desejar utilizar Webhook deverá fornecer as seguintes informações:
- URL de Callback;
- Authorization Key (se necessário);
- Logo para colocar de imagem no botão da requisição (opcional);
- Referência para a loja (se necessário);
A empresa que desejar dar suporte a comunicação através do recurso de webhook da Neemo deverá implementar uma rota na sua aplicação que receberá uma requisição HTTP POST, essa rota (URL) deverá então ser cadastrada no sistema da Neemo onde poderá ser associada às lojas.
A requisição HTTP POST possui um cabeçalho que contém parâmetros informando o tipo do corpo da requisição e um “token” de autorização. Abaixo tem-se uma tabela com a relação desses parâmetros:
Cabeçalho da requisição HTTP | |
Parâmetro | Descrição |
Content-type | Tipo do corpo da requisição “application/json” |
Authorization | Token para autorizar a requisição |
A requisição HTTP POST possui um corpo onde será enviado parâmetros que informam qual o pedido acessado, qual a loja que possui o pedido, um código para identificar a integração webhook e dois tokens de acesso à API. Segue abaixo uma tabela com os parâmetros presentes no corpo da requisição:
Corpo da requisição HTTP | |
Parâmetro | Descrição |
ref | Identificador da integração com o Webhook (ID) na base de dados da Neemo |
order_id | Identificador do pedido (ID) da loja na base de dados da Neemo |
account_id | Identificador da loja (ID) na base de dados da Neemo |
account_access_token | Token de acesso a API que identifica a loja |
master_access_token | Token de acesso a API que identifica a franquia |
Essa requisição será solicitada pelo cliente através do seu painel ou gestor de pedidos clicando no botão:
Após o cliente apertar o botão iremos enviar a requisição para a URL cadastrada, (que foi informada anteriormente).
O servidor da Neemo que faz essa requisição HTTP POST trabalha com um tempo limite (timeout) de 10 segundos. Após esse tempo, se a requisição não for respondida, o servidor repetirá a requisição até que ela seja respondida com status 200, com um limite de 3 repetições.
Segue abaixo um exemplo de uma requisição:
