Este webservice é utilizado para enviar uma consulta geral, sem um imóvel envolvido. São solicitados e validados os dados básicos e é realizada uma verificação antispam.
É o formulário da página de contato do seu site: o visitante que não pergunta por um anúncio específico, mas pela imobiliária. A consulta entra na Inbox de Mapaprop da imobiliária (a conta proprietária do token) como um lead, igual a uma consulta de anúncio. O destinatário é resolvido a partir do token, não é enviado como parâmetro.
A diferença em relação a messages é uma só: aqui não se envia propertyHash. messages exige o identificador de um imóvel publicado, portanto não serve para uma consulta geral.
| 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/contact
Parâmetros
| Key | Type | Required | Descrição |
|---|---|---|---|
| userAgent | string | yes | A string real do userAgent do navegador. Obrigatória para a verificação antispam. |
| referer | string | yes | A string referer da solicitação de envio da consulta. Obrigatória para a verificação antispam. |
| ip | string | yes | O IP do usuário que envia a consulta. Obrigatório para a verificação antispam. |
| url | string | yes | A URL da página a partir da qual o formulário foi enviado. Pode ser igual ao referer. |
| name | string | yes | Nome do usuário que envia a consulta. Mínimo 3 e máximo 100 caracteres. |
| string | or | Email do usuário que envia a consulta. Deve ser enviado email ou telefone. Máximo 100 caracteres. | |
| phone | string | or | Telefone do usuário que envia a consulta. Deve ser enviado email ou telefone. Máximo 100 caracteres. |
| message | string | yes | Texto enviado pelo usuário. Máximo 4000 caracteres. |
| subject | string | no | Assunto do email que a imobiliária recebe. Máximo 200 caracteres. Se não for enviado, o assunto é Nueva consulta general de {name}. |
Email ou telefone: basta um dos dois. Pedir os dois ao visitante faz perder consultas, portanto a API aceita qualquer um dos dois canais de resposta; se nenhum chegar, a resposta é REQUIRED_INPUT com o texto Enter email or phone.
Código de exemplo
POST /api/action/express-v1/contact HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}
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=https%3A%2F%2Fsomeinmo.com%2Fcontacto
&ip=85.33.65.69&url=https%3A%2F%2Fsomeinmo.com%2Fcontacto
&name=John%20Doe&email=john%40example.com&message=Quiero%20tasar%20mi%20departamento
Resposta
A resposta JSON indica se a consulta foi enviada corretamente. Em caso de erro, informa o motivo: campos inválidos ou faltantes.
Se a verificação antispam considerar a consulta suspeita, a resposta também é bem-sucedida e o lead fica na fila de moderação em vez de entrar diretamente na Inbox. É deliberado: não se avisa a quem envia spam que foi detectado.
| Objeto | Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
| Response | success | boolean | yes | Booleano que indica se o envio foi bem-sucedido ou não |
| error | string | no | Texto que indica o tipo de erro se success == false | |
| description | string | no | Detalhe do erro se success == false |
Exemplo de resposta
{
"success": false,
"error": "REQUIRED_INPUT",
"description": "Enter email or phone"
}