8. Integración de sólo lectura
4. Estructura para desarrollos
6. ¿Cómo leer el XML de resultado?
Cuando se realizan acciones en avisos y contactos ya integradas en Grupo QuintoAndar a través de Open las callbacks permiten que los integradores reciban notificaciones sobre ellas.
La configuración de las callbacks se puede realizar de dos formas, una a través de soporte y otra de forma autónoma con el endpoint:
**PUT /v1/configuracion/callbacks.**
Para ambas configuraciones se debe brindar la misma información:
Configuración a través de soporte: se debe enviar un mail a [email protected] con la información ya mencionada.
Configuración a través del endpoint: este recibe un objeto con los campos mencionados. Cabe destacar que la URL es obligatoria y debe comenzar con http:// o https://.
El key de la autorización se envía en el header de la request POST en el callback. Por ejemplo para aplicar Basic Authorization de HTTP. Si es Basic Authorization debe enviar todo el token completo, es decir con la palabra Basic incluida.
Ejemplo:
Basic b3BlbjpjYWxsYmFja3M=
Para verificar si la configuración es correcta, en cualquiera de los dos casos, se puede utilizar el endpoint GET /v1/configuracion/callbacks, el cual devuelve el mismo objeto que fue enviado en el PUT, con la información que fue configurada.
Una vez se haya configurado el servicio de callback se debe suscribir a todos los eventos de los cuales querés obtener notificaciones, para esto debe hacer uso del siguiente endpoint:
**PUT /v1/configuracion/callbacks/{evento}**
Los eventos disponibles son los siguientes:
También tendrán a disposición un endpoint que les va a permitir desuscribirse de todos los eventos de los cuales no desean recibir notificaciones:
**DELETE /v1/configuracion/callbacks/{evento}**
Si no se suscribe a ningún evento de callbacks por defecto no le llegaran los notificaciones sobre sus propiedades
Toda callback será exitosa al momento de llamarse mientras NO reciba como response un código 4xx o 5xx (puede ser cualquiera de los posibles status 400 o cualquiera de los posibles 500), es decir que todos los 2xx o 3xx (nuevamente pueden ser cualquiera de los posibles 200 o cualquiera de los posibles 300) son aceptados. Mientras el sistema de callbacks pueda llegar al endpoint, la respuesta será exitosa.
Se esperará respuesta como máximo de 1.5 segundos. Si no se recibe respuesta en ese tiempo, nuestro sistema interpreta que hubo un timeout y, por lo tanto, un error. En este caso se volverá a reintentar realizar la callback como cualquier proceso de error, hasta que la callback llegue a destino o pasen 72 hs desde la creación de la callback. Después de las 72 hs el estado de la callback pasa a VENCIDO.
Sugerencia: es buena práctica validar que una callback no fue entregada al cliente verificando el ID del evento.
Los eventos que se notifican a través de callbacks son: