Este webservice é usado para enviar uma consulta ao cliente. Os dados básicos são solicitados e validados e também é realizada uma verificação antispam.
A consulta entra no Inbox do Mapaprop da imobiliária (a conta dona do token) como um lead, assim como uma consulta enviada pelo próprio site dela. O destinatário é resolvido a partir do token, não é enviado como parâmetro.
| Informações do recurso | |
|---|---|
| Autenticação | Obrigatória (Token de API, Bearer) |
| Scope | express-base |
| HTTP Method | POST |
| Response | JSON |
| Version | 1 |
URL do recurso
https://mapaprop.app/api/action/express-v1/messages
Parâmetros
| Key | Type | Required | Descrição |
|---|---|---|---|
| propertyHash | string | yes | O hash ID do imóvel. Obtenha os IDs nos serviços GET /api/action/express-v1/properties ou GET /api/action/express-v1/properties/{propertyHash} |
| userAgent | string | yes | O string real do userAgent do browser. Obrigatório para verificação antispam |
| referer | string | yes | O string referer da requisição de envio da consulta. Obrigatório para verificação antispam. |
| ip | string | yes | O IP do usuário que envia a consulta. Obrigatório para verificação antispam. |
| url | string | yes | A URL do anúncio no seu site. Pode ser igual ao referer. |
| name | string | yes | Nome do usuário que envia a consulta. |
| string | or | E-mail do usuário que envia a consulta. E-mail ou telefone deve ser informado. | |
| phone | string | or | Telefone do usuário que envia a consulta. E-mail ou telefone deve ser informado. |
| message | string | yes | Texto enviado pelo usuário sobre a consulta ou um texto gerado automaticamente legível para a agência |
Código de exemplo
POST /api/action/express-v1/messages HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}
propertyHash=32ojflsdfjasld-avC&
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=someinmo.com&url=http%3A%2F%2Fsomeinmo.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 de erro, informa o motivo: a consulta está na fila de moderação por parecer spam ou possui campos inválidos.
| Objeto | Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Response | success | boolean | yes | Booleano indicando se o envio foi bem-sucedido ou não |
| error | string | no | Texto indicando o tipo de erro se success == false |
Exemplo de resposta
{
"success": false,
"error": "INVALID_EMAIL"
}