GET /api/action/mapaprop-chat-ai-v1/featureds

BETA

Retorna as propriedades em destaque configuradas no site do cliente. customerId e websiteId são resolvidos a partir do access token.

Informações do recurso
Autenticação	Obrigatória (Token de API, Bearer)
Método HTTP	GET
Resposta	JSON
Versão	1
Cache	1 hora

URL do recurso

https://mapaprop.app/api/action/mapaprop-chat-ai-v1/featureds

Parâmetros

Chave	Tipo	Obrigatório	Descrição
max	int	não	Quantidade máxima de destaques a retornar. Por padrão `150`

Código de exemplo

GET /api/action/mapaprop-chat-ai-v1/featureds?max=10 HTTP/1.1
Host: mapaprop.app
Content-Type: application/x-www-form-urlencoded
Content-Length: 0
Authorization: Bearer {access_token}

Resposta

Objeto	Campo	Tipo	Obrigatório	Descrição
Response	featureds	Array of Featured	sim	Propriedades em destaque do site
Featured	featuredId	int	sim	ID do registro de destaque
	propertyId	int	sim	ID da propriedade
	code	string	sim	Código da propriedade, com prefixo de conta (ex: `11099-casas236516`)
	seoUrl	string	sim	Rota SEO da propriedade
	title	string	sim	Título da propriedade
	description	string	sim	Descrição da propriedade
	typeDesc	string	sim	Descrição traduzida do tipo de propriedade
	propertyTypeDesc	string	sim	Descrição traduzida do tipo de propriedade (alias de `typeDesc`)
	operationDesc	string	sim	Descrição traduzida da operação
	propertyOperationDesc	string	sim	Descrição traduzida da operação (alias de `operationDesc`)
	showPrice	boolean	sim	Se o cliente decidiu mostrar o preço desta propriedade em destaque
	price	number	sim	Preço da propriedade
	currency	string	sim	Moeda do preço
	occupancy	int	não	Quantidade máxima de ocupantes (aluguel por temporada)
	ambiences	int	não	Quantidade de ambientes
	rooms	int	não	Quantidade de quartos
	bathrooms	int	não	Quantidade de banheiros (somente se estiver declarada)
	buildingArea	int	não	Superfície coberta em m² (somente se estiver declarada)
	landArea	int	não	Superfície do terreno em m² (somente se estiver declarada)
	sold	boolean	não	Presente somente se a propriedade estiver marcada como vendida
	rented	boolean	não	Presente somente se a propriedade estiver marcada como alugada
	suspended	boolean	não	Presente somente se a publicação estiver suspensa
	reserved	boolean	não	Presente somente se a propriedade estiver reservada
	address	string	não	Endereço da propriedade
	addressDesc	string	não	Combinação de estado, município e cidade (conforme disponibilidade)
	zone1	string	não	Nome do estado
	zone2	string	não	Nome do município/bairro
	zone3	string	não	Nome da cidade
	thumbnail	string	sim	URL completa da imagem thumbnail
	customerCountryDesc	string	sim	Nome do país da conta do cliente

Exemplo de resposta

{
    "featureds": [
        {
            "featuredId": 40063,
            "propertyId": 2600144,
            "code": "11099-casas236516",
            "seoUrl": "venta-de-departamento-en-palermo-capital-federal-11099-2600144",
            "title": "Departamento 2 ambientes en Palermo",
            "description": "Excelente departamento a estrenar...",
            "typeDesc": "Departamento",
            "propertyTypeDesc": "Departamento",
            "operationDesc": "Venta",
            "propertyOperationDesc": "Venta",
            "showPrice": true,
            "price": 210000,
            "currency": "USD",
            "ambiences": 2,
            "rooms": 2,
            "addressDesc": "Palermo,Capital Federal",
            "zone1": "Capital Federal",
            "zone2": "Palermo",
            "thumbnail": "https://s3.amazonaws.com/mapaprop-dev-image/photos/11099/2600144/1t.jpg",
            "customerCountryDesc": "Argentina"
        }
    ]
}