Pesquisar imóveis [API]

Este artigo descreve o serviço da API responsável pela pesquisa de imóveis. Este serviço geralmente é consumido pelo site do cliente.

Segurança

Para acessar o serviço de pesquisa, a aplicação deve enviar um token de acesso fornecido pelo administradora da organização.

Endpoint

Para acessar o serviço de pesquisa o sistema deve fazer uma requisição do tipo "POST” no “EndPoint” definido pela “URL Org” da organização

Verbo	POST
Url org	Endereço fornecido pelo administrador. Exemplo: https://snapproperty-developer-edition.na132.force.com
Serviço	/services/apexrest/snap_brok/imovel/pesquisar
Endpoint	https://snapproperty-developer-edition.na132.force.com/services/apexrest/snap_brok/imovel/pesquisar

Parâmetros para pesquisa

Os parâmetros utilizados para pesquisa estão descritos na tabela abaixo.

Parâmetro	Tipo	Descrição	Exemplo
Offset	Número	Utilizado na paginação de registros para definir a posição inicial do primeiro imóvel a ser retornado.	0
RegistrosPagina	Número	Utilizado na paginação de registros para definir a quantidade de imóveis que devem ser retornados.	25
Filtros	Array[String]	Lista de filtros que devem ser considerados na pesquisa de imóveis. Cada filtro deve ser composto por: Operador lógico (ex.: AND, OR) Campo (ex.: snap_brok__Disponivel_locacao__c) Operador para comparação (ex.: =, IN, NOT IN ) Valor (ex.: TRUE)	[ "AND snap_brok__Disponivel_venda__c = true" , "AND snap_brok__Banheiros__c = 1" , "AND snap_brok__area_privativa__c >= 40" , "AND snap_brok__Dormitorios__c >=2" , "AND snap_brok__Situacao__c <> 'Indisponível'", "AND snap_brok__Suites__c >= 1" , "AND snap_brok__Vagas__c >= 1" , "AND snap_brok__Valor_Condominio__c <= 500.00" , "AND snap_brok__Valor_locacao_total__c <= 2000.00" , "AND snap_brok__Valor_IPTU__c > 20", "AND snap_brok__Tipo_uso_3__r.name IN ('Residencial','Comercial')", "AND snap_brok__Tipo_imovel_2__r.name NOT IN ('Box','Clube')", "AND snap_brok__Bairro_2__r.name = 'Bela Vista'", "AND snap_brok__Cidade_2__r.name = 'São Paulo'", "AND snap_brok__condominio__r.name = 'Residencial nova alvorada paulista'", "AND snap_brok__Valor_desejado_aluguel__c >= 1.000" ]
Ordenacao	String	Define a regra para ordenação dos imóveis encontrados.	snap_brok__Valor_locacao_total__c DESC

Retorno da pesquisa

Retorno com sucesso

Na tabela abaixo estão descritos os campos retornados pelo serviço quando a pesquisa é realizada com sucesso.

Campo	Tipo	Descrição	Exemplo
Total	Número	Indica a quantidade total de imóveis encontrados com os filtros aplicados.	90
Mensagem	String	Mensagem do sistema	"Pesquisa realizada com sucesso"
Imoveis	Array[Imovel]	Array com os registros dos imóveis retornados pela pesquisa.	[ { "attributes": { "type": "snap_brok__Imovel__c", "url": "/services/data/v51.0/sobjects/snap_brok__Imovel__c/a050B00000fnHxDQAU" }, "Id": "a050B00000fnHxDQAU", "Name": "Rua T-38 0 Apto 2001", "snap_brok__area_privativa__c": 158.51, "snap_brok__Banheiros__c": 2, "snap_brok__Complemento__c": "Apto 2001", "snap_brok__codigo__c": "I-001299", "snap_brok__Disponivel_venda__c": false, "snap_brok__Dormitorios__c": 2, … } ]
Erro	Boolean	FALSE

Exemplo:

{
    "Total": 90,
    "Mensagem": "Pesquisa realizada com sucesso",
    "Imoveis": [
        {
            "attributes": {
                "type": "snap_brok__Imovel__c",
                "url": "/services/data/v51.0/sobjects/snap_brok__Imovel__c/a050B00000fnHxDQAU"
            },
            "Id": "a050B00000fnHxDQAU",
            "Name": "Rua T-38 0  Apto  2001",
            "snap_brok__area_privativa__c": 158.51,
            "snap_brok__Banheiros__c": 2,
            "snap_brok__Complemento__c": "Apto  2001",
            "snap_brok__codigo__c": "I-001299",
            "snap_brok__Disponivel_venda__c": false,
            "snap_brok__Dormitorios__c": 2,
            "snap_brok__Localizacao__c": null,
            "snap_brok__Logradouro__c": "Rua T-38",
            "snap_brok__Numero__c": "0",
            "snap_brok__Situacao__c": "Disponível",
            "snap_brok__Suites__c": 2,
            "snap_brok__Tipo_uso_3__c": "a4I0B000000RI6uUAG",
            "snap_brok__Tipo_imovel_2__c": "a4H0B000000QdY5UAK",
            "snap_brok__Vagas__c": 2,
            "snap_brok__Valor_Condominio__c": 77000.00,
            "snap_brok__Valor_locacao_total__c": 77000.00,
            "snap_brok__Valor_locacao_por_m2__c": 485.77,
            "snap_brok__Valor_IPTU__c": 9660.00,
            "snap_brok__Fotos_de_im_vel__r": {
                "totalSize": 2,
                "done": true,
                "records": [
                    {
                        "attributes": {
                            "type": "snap_brok__Foto_Imovel__c",
                            "url": "/services/data/v51.0/sobjects/snap_brok__Foto_Imovel__c/a060B00000jrTyeQAE"
                        },
                        "snap_brok__Imovel__c": "a050B00000fnHxDQAU",
                        "Id": "a060B00000jrTyeQAE",
                        "snap_brok__Url_imagem__c": "http://www.essenciamoveis.com.br/blog/wp-content/uploads/2017/01/cozinha-conjugada-com-sala-de-jantar.jpg",
                        "snap_brok__Ordem__c": 1
                    },
                    {
                        "attributes": {
                            "type": "snap_brok__Foto_Imovel__c",
                            "url": "/services/data/v51.0/sobjects/snap_brok__Foto_Imovel__c/a060B00000jrTyfQAE"
                        },
                        "snap_brok__Imovel__c": "a050B00000fnHxDQAU",
                        "Id": "a060B00000jrTyfQAE",
                        "snap_brok__Url_imagem__c": "https://www.adorodecorar.com.br/wp-content/uploads/2015/07/2364-apartamentos-decorados-dicas.jpg",
                        "snap_brok__Ordem__c": 2
                    }
                ]
            },
            "snap_brok__Tipo_uso_3__r": {
                "attributes": {
                    "type": "snap_brok__Tipo_uso__c",
                    "url": "/services/data/v51.0/sobjects/snap_brok__Tipo_uso__c/a4I0B000000RI6uUAG"
                },
                "Id": "a4I0B000000RI6uUAG",
                "Name": "Residencial"
            },
            "snap_brok__Tipo_imovel_2__r": {
                "attributes": {
                    "type": "snap_brok__Tipo_imovel__c",
                    "url": "/services/data/v51.0/sobjects/snap_brok__Tipo_imovel__c/a4H0B000000QdY5UAK"
                },
                "Id": "a4H0B000000QdY5UAK",
                "Name": "Apartamento"
            }
        }
    ],
    "Erro": false
}

Retorno com erro

Campo	Tipo	Descrição	Exemplo
Total	Número		null
Mensagem	String	Mensagem de erro gerada pelo serviço	"Erro na pesquisa de imóveis: Erro na pesquisa de imóveis: unexpected token: '100' - linha: 493 na linha 502"
Imoveis	Array[Imovel]		null
Erro	Boolean	TRUE

Exemplo:

{
    "Total": null,
    "Mensagem": "Erro na pesquisa de imóveis: Erro na pesquisa de imóveis: unexpected token: '100' - linha: 493 na linha 502",
    "Imoveis": null,
    "Erro": true
}

Filtros

Na tabela abaixo estão relacionados os campos que são retornado pelo serviço e que também podem ser utilizados como opções de filtro.

Campo	Descrição	Exemplo
`Name`	Nome do imóvel.
ID	ID interno do imóvel no SnapProperty (não é o código do imóvel).
`snap_brok__codigo__c`	Código gerado pelo sistema para identificar o imóvel.	`snap_brok__codigo__c = 'I-000639'`
`snap_brok__area_privativa__c`	Área privativa do imóvel.	`snap_brok__area_privativa__c` >= 40
`snap_brok__Banheiros__c`	Quantidade de banheiros do imóvel.	`snap_brok__Banheiros__c` = 1
`snap_brok__Disponivel_venda__c`	Indica se o imóvel está disponível para venda. Se `snap_brok__Disponivel_venda__c` = True, então: Disponível para venda Se `snap_brok__Disponivel_venda__c` = False, então: Não disponível para venda	`snap_brok__Disponivel_venda__c` = true
`snap_brok__Dormitorios__c`	Quantidade de dormitórios do imóvel.	`snap_brok__Dormitorios__c` >=2
`snap_brok__Localizacao__Latitude__s`	Identifica as coordenadas (latitude) do endereço do imóvel.	`snap_brok__Localizacao__Latitude__s` = `-23.567124500000000`
`snap_brok__Localizacao__Longitude__s`	Identifica as coordenadas (longitude) do endereço do imóvel.	`snap_brok__Localizacao__Longitude__s` = `-46.649992300000000`
`snap_brok__Logradouro__c`	Nome da rua onde o imóvel está localizado.
`snap_brok__Numero__c`	Número do endereço do imóvel.
`snap_brok__Complemento__c`	Complemento do endereço do imóvel.
`snap_brok__Bairro_2__r.name`	Identifica o bairro onde o imóvel está localizado.	`snap_brok__Bairro_2__r.name` = 'Bela Vista'
`snap_brok__Cidade_2__r.name`	Identifica a cidade onde o imóvel está localizado.	`snap_brok__Cidade_2__r.name` = 'São Paulo'
`snap_brok__Cep_2__r.name`	Indica o CEP do endereço do imóvel.	`AND snap_brok__Cep_2__r.name = '01310-100'`
`snap_brok__Situacao__c`	Indica a situação do imóvel em relação à sua disponibilidade para comercialização.	`snap_brok__Situacao__c = 'Contrato gerado'`.
`snap_brok__Suites__c`	Número de suítes do imóvel.	`snap_brok__Suites__c` = 1
`snap_brok__Tipo_uso_3__r.name`	Indica o tipo de uso do imóvel.	`AND snap_brok__Tipo_uso_3__r.name IN ('Residencial','Comercial')`
`snap_brok__Tipo_imovel_2__r.name`	Indica o tipo do imóvel.	`AND snap_brok__Tipo_imovel_2__r.name NOT IN ('Box','Clube')`
`snap_brok__Vagas__c`	Indica o total de vagas (cobertas e descobertas) do imóvel.	`snap_brok__Vagas__c` = 1
`snap_brok__Valor_Condominio__c`	Valor mensal do condomínio.	`snap_brok__Valor_Condominio__c` = 240.00
`snap_brok__Valor_locacao_total__c`	Valor total da locação (Aluguel + IPTU + Condomínio).	`snap_brok__Valor_locacao_total__c` = 1840.00
`snap_brok__Valor_locacao_por_m2__c`		`snap_brok__Valor_locacao_por_m2__c` >= 39.00
`snap_brok__Valor_IPTU__c`	Valor mensal do IPTU.	`snap_brok__Valor_IPTU__c` > 50
`snap_brok__descricao__c`	Descrição do imóvel.
`snap_brok__Altura_pe_direito__c`	Altura do pé direiro (m²) do imóvel.
`snap_brok__Andar__c`	Número do andar onde o imóvel está localizado.	`snap_brok__Andar__c = 3`
`snap_brok__condominio__r.name`	Identifica o condomínio onde está localizado o imóvel.	`snap_brok__condominio__r.name = 'Residencial nova alvorada paulista'`
`snap_brok__Valor_desejado_aluguel__c`	Indica o valor desejado do aluguel.	`snap_brok__Valor_desejado_aluguel__c` =
`snap_brok__Valor_mensal_IPTU_rateado__c`	Indica o valor mensal do IPTU rateado.	`snap_brok__Valor_desejado_aluguel__c >= 1000.00`
`snap_brok__valor_venda__c`	Valor sugerido pelo locador para venda do imóvel.	`snap_brok__valor_venda__c` > `250000.00`
`snap_brok__Fotos_de_im_vel__r`	Retorna uma lista com as fotos do imóvel
`snap_brok__Imovel__c`	Retorna o código do imóvel vinculado a foto.
`snap_brok__Url_imagem__c`	Retorna link da foto.
`snap_brok__Url_imagem_200px__c`	Retorna link da foto 200px.
`snap_brok__Url_imagem_400px__c`	Retorna link da foto 400px.
`snap_brok__URL_imagem_800px__c`	Retorna link da foto 800px.
`snap_brok__Ordem__c`	Ordem de exibição da foto.