Solicitud de Webhook
La empresa que quiera utilizar el Webhook deberá proporcionar la siguiente información:
- URL de Callback;
- Authorization Key (si es necesario);
- Logotipo para poner en la imagen del botón de solicitud (opcional);
- Referencia a la tienda (si es necesario);
La empresa que quiera soportar la comunicación a través del recurso webhook de Neemo debe implementar una ruta en su aplicación que recibirá una solicitud HTTP POST, esta ruta (URL) luego debe ser registrada en el sistema de Neemo donde se podrá asociar a las tiendas.
La solicitud HTTP POST tiene un encabezado que contiene parámetros que informan el tipo de cuerpo de la solicitud y un "token" de autorización. A continuación se muestra una tabla con la relación de estos 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 |
La solicitud HTTP POST tiene un cuerpo donde se enviarán parámetros que informan a qué pedido se accede, qué tienda tiene el pedido, un código para identificar la integración del webhook y dos tokens de acceso a la API. A continuación se muestra una tabla con los parámetros presentes en el cuerpo de la solicitud:
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 |
Esta solicitud será solicitada por el cliente a través de su panel o gestor de pedidos pulsando en el botón:
Luego de que el cliente presione el botón, enviaremos la solicitud a la URL registrada, (la cual fue previamente informada).
El servidor de Neemo que realiza esta solicitud HTTP POST funciona con un tiempo de espera de 10 segundos. Pasado este tiempo, si la petición no es contestada, el servidor repetirá la petición hasta que sea contestada con estado 200, con un límite de 3 repeticiones.
A continuación se muestra un ejemplo de una solicitud:
