Visión general

El webhook usa heartbeats para indicar presencia. Los servidores envían heartbeats periódicos, que identifican la presencia de un merchant.Al habilitar el webhook, las requests de presencia comienzan en el próximo ciclo de heartbeat (hasta 30 segundos). Existen dos tipos de heartbeat: por aplicación y por merchant, para control detallado de la presencia.

Requests por aplicación

Para las integraciones que no tienen control fino de presencia tenemos la configuración para realizar una única request de heartbeat periódica para la aplicación, haciendo que todos los merchants de la aplicación queden online.En este caso, requests con respuesta 202 Accepted hacen que el mensaje de heartbeat sea generado, y cualquier otra respuesta hace que el heartbeat no sea generado. El response body será ignorado.

En la práctica, esto significa que todos los merchants con scope order de la integración quedarán abiertos en el listado, siempre que cumplan con los otros criterios.

Ejemplo de body de la request

{
    "code":"KEEPALIVE",
    "fullCode":"KEEPALIVE",
    "id":"a38ba215-f949-4b2c-982a-0582a9d0c10e"
}

Ejemplo de request

Consulta el impacto del formato en la firma.

curl --location 'http://localhost:8080/webhook' \
--header 'X-IFood-Signature: 6c0a429606266905349388ebc1eb12b8b98524dddd6b4bdc41c4b67591075b4c' \
--header 'Content-Type: application/json' \
--data '{
    "code":"KEEPALIVE",
    "fullCode":"KEEPALIVE",
    "id":"a38ba215-f949-4b2c-982a-0582a9d0c10e"
}'

Enviamos solo información relevante para la integración y mantenemos compatibilidad con eventos de pedido.

Requests por merchant

Cuando la integración usa control fino de presencia, el sistema envía requests de heartbeat para grupos de merchants. Cada request puede incluir hasta 1000 merchants.La respuesta debe tener status 202 Accepted y listar los merchants online en el cuerpo de la respuesta. El sistema genera heartbeats solo para esos merchants.

Ejemplo de body de la request

{
    "code":"KEEPALIVE",
    "fullCode":"KEEPALIVE",
    "id":"a38ba215-f949-4b2c-982a-0582a9d0c10e",
    "merchantIds": ["cad65e8f-6fc6-438a-b159-e64a902a6b9a", "438a5e8f-6fc6-438a-b159-e64a902a6879"]
}

Response: solo los merchants "online"

{
   "merchantIds": ["cad65e8f-6fc6-438a-b159-e64a902a6b9a"]
}

Ejemplo de request

Consulta el impacto del formato en la firma.

curl --location 'http://localhost:8080/webhook' \
--header 'X-IFood-Signature: dc900bca38c8b6f908ea688a24604fa581921d1211da4211e4f5e139732c2ff1' \
--header 'Content-Type: application/json' \
--data '{
    "code":"KEEPALIVE",
    "fullCode":"KEEPALIVE",
    "id":"a38ba215-f949-4b2c-982a-0582a9d0c10e",
    "merchantIds": ["cad65e8f-6fc6-438a-b159-e64a902a6b9a", "438a5e8f-6fc6-438a-b159-e64a902a6879"]
}'

Enviamos solo información relevante para la integración y mantenemos compatibilidad con eventos de pedido.

¿Esta página fue útil?

Evalúa tu experiencia en el nuevo portal de desarrolladores:

En esta página

Visión general

Requests por aplicación

Requests por merchant

Contenido leído0%