6. Mostrar localização no mapa
6. Como ler o XML do resultado?
9. Mostrar localização no mapa
Quando ações são realizadas em anúncios e contatos já integrados no Grupo QuintoAndar através do Open, os callbacks permitem que os integradores recebam notificações sobre elas.
A configuração dos callbacks pode ser realizada de duas formas: uma através do suporte e outra de forma autônoma com o endpoint:
**PUT /v1/configuracion/callbacks.**
Para ambas as configurações, a mesma informação deve ser fornecida:
Configuração através de suporte: deve-se enviar um e-mail para [email protected] com a informação já mencionada.
Configuração através do endpoint: este recebe um objeto com os campos mencionados. Cabe destacar que a URL é obrigatória e deve começar com http:// ou https://.
A key da autorização é enviada no header da request POST no callback. Por exemplo, para aplicar Basic Authorization de HTTP. Se for Basic Authorization deve-se enviar o token completo, ou seja, com a palavra "Basic" incluída.
Ejemplo:
Basic b3BlbjpjYWxsYmFja3M=
Para verificar se a configuração está correta, em qualquer um dos dois casos, pode-se utilizar o endpoint
**GET /v1/configuracion/callbacks**
o qual devolve o mesmo objeto que foi enviado no PUT, com a informação que foi configurada.
Uma vez que o serviço de callback tenha sido configurado, deve-se assinar todos os eventos dos quais você quer obter notificações. Para isso, deve-se fazer uso do seguinte endpoint:
**PUT /v1/configuracion/callbacks/{evento}**
Os eventos disponíveis são os seguintes:
Também terão à disposição um endpoint que lhes permitirá cancelar a assinatura de todos os eventos dos quais não desejam receber notificações:
**DELETE /v1/configuracion/callbacks/{evento}**
Se não se assinar a nenhum evento de callbacks por default, as notificações sobre suas propriedades não chegarão.
Todo callback será bem-sucedido no momento de ser chamado enquanto NÃO receber como response um código 4xx ou 5xx (pode ser qualquer um dos possíveis status 400 ou qualquer um dos possíveis 500), ou seja, que todos os 2xx ou 3xx (novamente podem ser qualquer um dos possíveis 200 ou qualquer um dos possíveis 300) são aceitos. Enquanto o sistema de callbacks puder chegar ao endpoint, a response será bem-sucedida.
Será esperada response com um máximo de 1.5 segundos. Se não for recebida response nesse tempo, nosso sistema interpreta que houve um timeout e, portanto, um erro. Neste caso, será re-tentado realizar o callback como qualquer processo de erro, até que o callback chegue ao destino ou passem 72 horas desde a criação do callback. Depois das 72 horas, o status do callback passa a VENCIDO.
Sugestão: é boa prática validar que um callback não foi entregue ao cliente verificando o ID do evento.
Os eventos que são notificados através de callbacks são:
Segundo o tipo de integração, os eventos são notificados através de callbacks ou não. As integrações de Leitura e Escrita recebem notificação de todos os eventos. Em contrapartida, as de Solo leitura só recebem notificações de leads, ou seja, a consulta de telefone e a da mensagem através do portal.
Quando se consultam leads: AVISO_ESTADO_PUBLICACION notificará o usuário se um anúncio mudou o estado de sua publicação, ou seja, quando o mesmo passar de online a offline ou vice-versa. Em contrapartida, AVISO_ACTIVIDAD, além de cumprir com a anterior funcionalidade, informará ao usuário se o anúncio consultado foi modificado.
Anteriormente se mostrou a lista de eventos que competem tanto aos anúncios quanto aos imóvel novos, mas neste ponto tentaremos dar uma explicação um pouco mais detalhada, fazendo referência aos tipos de evento que desencadeia cada evento.
O envio de informação do sistema de callbacks é por região/idioma. Na request ao callback configurado será enviada esta informação através do body. O body depende dos eventos e da região em que se encontra o integrador ou a linguagem configurada.
Na seção de body callbacks, pode-se observar o body das possíveis respostas.
Mensagem de InteressadoMensagem de um possível cliente.