Primeros pasos
Para recibir webhooks necesita un endpoint HTTPS público y una suscripción registrada por IDBI. Al registrarla, IDBI le entrega el secreto con el que verificará la firma de cada envío.
Ruta rápida
Sección titulada «Ruta rápida»-
Prepare su endpoint.
Publique una URL con HTTPS que acepte
POSTconContent-Type: application/jsony responda con un código2xx. Revise los requisitos. -
Solicite la integración a IDBI.
Las suscripciones las registra IDBI; usted no se registra por su cuenta. Consulte qué debe indicar.
-
Reciba el secreto.
IDBI se lo entrega al registrar la suscripción; después no se puede volver a consultar. Guárdelo como variable de entorno o en un gestor de secretos.
-
Implemente la verificación de la firma.
Siga Autenticación y firma. Verifique siempre sobre el cuerpo crudo de la petición.
-
Pruebe con el vector de prueba.
Compruebe que su código reproduce la firma del vector de prueba antes de recibir envíos reales.
-
Salga a producción.
Complete el checklist.
Requisitos del endpoint
Sección titulada «Requisitos del endpoint»| Requisito | Detalle |
|---|---|
| Protocolo | HTTPS. No se aceptan URLs http://. |
| Accesibilidad | URL pública, alcanzable desde internet. Debe resolverse por DNS a una dirección IP pública: no se aceptan direcciones privadas ni reservadas, como localhost. |
| Método y formato | POST con cuerpo JSON (Content-Type: application/json). |
| Respuesta | Código 2xx dentro del tiempo de espera de su suscripción: 30 segundos por defecto, configurable entre 1 y 60 segundos. |
| Redirecciones | No las use. IDPOS puede seguirlas, pero no garantiza que se conserven el método POST ni el cuerpo. Registre la URL final. |
Cómo se solicita la integración
Sección titulada «Cómo se solicita la integración»Las suscripciones las registra IDBI; usted no puede crearlas por su cuenta. Solicite la integración a IDBI con estos datos:
| Dato | Descripción |
|---|---|
| URL del endpoint | La URL pública HTTPS donde recibirá los envíos. No se aceptan direcciones privadas ni reservadas. |
| Tiendas | Las tiendas de IDPOS cuyos eventos desea recibir. |
| Eventos | Los eventos que desea recibir. |
Cada suscripción pertenece a una sola tienda y tiene su propio secreto. Si necesita recibir los eventos de varias tiendas, IDBI registra una suscripción por tienda, cada una con su secreto. Si necesita varias URLs para una misma tienda, cada una se registra como una suscripción distinta.
Qué recibe de IDBI
Sección titulada «Qué recibe de IDBI»| Elemento | Descripción |
|---|---|
| Secreto de la suscripción | Cadena con la que se calcula la firma HMAC-SHA256 de cada envío. IDPOS la genera al registrar la suscripción y solo la muestra en ese momento. |
Checklist de salida a producción
Sección titulada «Checklist de salida a producción»- El endpoint es público, usa HTTPS y no redirige.
- El secreto está almacenado fuera del código fuente.
- La firma se verifica sobre el cuerpo crudo, con comparación en tiempo constante.
- Se rechazan los envíos cuyo
X-Webhook-Timestampdifiere en más de 300 segundos de la hora de su servidor. - El endpoint responde
2xxde inmediato y procesa el evento en segundo plano. - Los eventos duplicados se descartan, después de verificar la firma, usando el
event_iddel cuerpo y, como segunda clave,event_typejunto condata.id. - La integración no depende del orden de llegada de los eventos.
- La integración ignora los campos que no reconoce.
- Reproduce el vector de prueba de la firma.
Siguiente paso
Sección titulada «Siguiente paso»Continúe con Autenticación y firma o conozca los eventos.