Este webservice envia uma consulta ao cliente. Os dados básicos são validados, é feita a verificação de spam e o lead é registrado.
| Informações do recurso | |
|---|---|
| Autenticação | Obrigatória |
| Método HTTP | POST |
| Resposta | JSON |
| Versão | 1 |
URL do recurso
https://mapaprop.app/api/action/feed-v1/submit-question
Parâmetros
| Chave | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| agencyId | string | sim | O ID da imobiliária exatamente como fornecido pelo campo agency.id de GET /api/action/feed-v1/get-properties ou GET /api/action/feed-v1/get-delta. Trate-o como uma string opaca; não tente parsear (ver Get Started). |
| propertyId | string | sim | O ID do imóvel gerado pelo sistema, fornecido por GET /api/action/feed-v1/get-properties ou GET /api/action/feed-v1/get-delta. Não é o propertyCode, mas o campo chamado 'id'. |
| portalName | string | sim | O nome do portal que envia a consulta. Ex. Trovit |
| userAgent | string | sim | O string userAgent do navegador. Obrigatório para a verificação de spam. |
| referer | string | sim | O string referer da requisição. Obrigatório para a verificação de spam. |
| ip | string | sim | O IP do usuário que envia a consulta. Obrigatório para a verificação de spam. |
| domain | string | sim | O nome de domínio do portal que envia a consulta. |
| url | string | sim | A URL do anúncio no seu site. Pode ser igual ao referer. |
| urlAlt | string | não | Uma URL alternativa útil para a imobiliária. Por exemplo, uma URL de estatísticas. |
| test | boolean | não | Se enviado como true, a validação é feita mas a consulta não é registrada. |
| name | string | sim | Nome do usuário que envia a consulta. |
| string | ou | Email do usuário que envia a consulta. É necessário enviar email ou telefone. | |
| phone | string | ou | Telefone do usuário que envia a consulta. É necessário enviar email ou telefone. |
| message | string | sim | Texto enviado pelo usuário com a consulta, ou texto gerado automaticamente legível pela imobiliária. |
Exemplo de código
POST /api/action/feed-v1/submit-question HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}
agencyId=ECID00222201EN&propertyId=16928-avC&portalName=Trovit&
userAgent=Mozilla%2F5.0%20%28X11%3B%20Linux%20x86_64%29%20AppleWebKit%2F537.36%20%28KHTML%2C%20like%20Gecko%29%20Chrome%2F32.0.1700.77%20Safari%2F537.36
&referer=http%3A%2F%2Ftrovit.com%2Fad%3Fid%3D111
&ip=85.33.65.69&domain=trovit.com&url=http%3A%2F%2Ftrovit.com%2Fad%3Fid%3D111
&name=John%20Doe&phone=6667117&message=Want%20to%20know%20more%20about%20this
Resposta
A resposta JSON indica se a consulta foi enviada com sucesso. Em caso contrário, informa se ficou em fila de moderação por parecer spam ou se contém campos inválidos.
| Objeto | Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Response | success | boolean | sim | Booleano que indica se o envio foi bem-sucedido |
| error | string | não | Texto indicando o tipo de erro quando success == false |
AÇÃO NECESSÁRIA
Se você receber error=PROPERTY_NOT_FOUND, deve remover o imóvel do seu inventário imediatamente. Isso significa que o cliente parou de publicar esse imóvel ou o excluiu do nosso inventário.
Muitos clientes reclamam que seus imóveis continuam publicados em portais externos.
{
"success": false,
"error": "INVALID_EMAIL"
}