INTRODUÇÃO

Esta API possibilita a integração do SMART Imobiliário com o SITE e LANDING PAGES do cliente através consultas em tempo Real. 

A API é de linguagem muito simples e de fácil entendimento para programadores e designers e utiliza a tecnologia JSON.

Para acessar todos os métodos você deve sempre informar o seu token de acesso (parâmetro token).

token: o token é uma chave secreta de acesso à API e deve ser solicitada ao nosso suporte. Este token nunca deve ser exposto ao usuário final. Se você for utilizar nossa API através de Javascript, faça requisições JS à sua aplicação e da sua aplicação (server-side), faça as requisições à nossa API. Este cuidado irá garantir maior segurança das suas informações.

O funcionamento é bastante simples e toda a comunicação é feita através de métodos  descritos mais adiante.  Cada consulta receberá alguns parâmetros de filtro que retornarão alguns atributos da entidade desejada: Imóveis, imagens, empreendimentos…

Este documento está organizado por entidades que poderão ser consultadas pela nossa API com seus atributos retornados como resposta (o que cada entidade tem de informação para ser apresentada), seguidos dos possíveis parâmetros de consulta e os possíveis métodos de consulta.

Exemplo:

Entidade: Imóvel

Atributos retornados: nome do edifício, nome da cidade, nome do bairro, área privativa…

Parâmetros de Consulta: intervalo de área, intervalo de preço…

Métodos de Consulta: Obter Imóveis, Obter total de Imóveis…

A API PERMITE A CONSULTA DAS SEGUINTES ENTIDADES:

  • IMÓVEL: Imóveis avulsos para venda e aluguel, temporada, com todas as sua informações, imagens, vídeos, etc.
  • EMPREENDIMENTO: Empreendimentos imobiliários com seus Tipos, Unidades Disponíveis, Estágio da Obra, com todas as sua informações, imagens, vídeos, etc.
  • LOCALIZAÇÃO: Consulta de estados, cidades e bairros
  • EMPRESA: Dados da empresa, como nome, telefones para contato, e-mail, configurações do site (logomarca, cores, etc).

ENTIDADES CONSULTADAS

IMÓVEL

Atributos do imóvel

ATRIBUTO TIPO DESCRIÇÃO
codigoImovel String Código do Imóvel
codigoReferenciaImovel String Código Referência do Imóvel, geralmente igual ao código
dataCadastroImovel Date Data de cadastro do imóvel
exemplo: “Nov 10, 2015 1:49:18 PM”
nomeImovel String Nome do Imóvel
preco BigDecimal Preço do imóvel (venda e aluguel mensal) ex: 275700.5000 para 275.700,50
temporada char ‘0’ normal
‘1’ imóvel de temporada
precoTemporada BigDecimal Preço da diária se o imóvel for de temporada ex: 250.5000 para 250,50
endereco String Logradouro do imóvel
localizacao String Ponto de referência
numero String Número para completar o logradouro
complemento String Complemento do endereço
nomeBairro String Nome do Bairro
nomeCidade String Nome da Cidade
siglaEstado String Sigla do Estado
areautil Double Área privativa
unidade2 String Unidade de medida da Área privativa
iptu BigDecimal Valor do IPTU
vlrparcelaiptu BigDecimal Valor da parcela do IPTU
condominio BigDecimal Valor do Condomínio
nquartos String Número de quartos
nsuites Integer Número de Suítes (baseado no número de quartos acima)
ngaragens String Número de vagas de garagem
nelevadores String Número de elevadores
aptoAndar String Número de unidades por andar
nandares String Número de andares
nsalas Integer Número de salas
nambientes Integer Numero de ambientes

Ex: 1 sala para 2 ambientes

nbanheirossociais Integer Número de banheiros sociais
fotodestaque Short Número da foto destaque
Ex: se 2 a foto será _02.jpg
Ex: se 11 a foto será _11.jpg
fotoImovel1 String Nome da foto 1
fotoImovel2 String Nome da foto 2
fotoImovel3 String Nome da foto 3
fotoImovel4 String Nome da foto 4
fotoImovel5 String Nome da foto 5
fotoImovel6 String Nome da foto 6
fotoImovel7 String Nome da foto 7
fotoImovel8 String Nome da foto 8
fotoImovel9 String Nome da foto 9
fotoImovel10 String Nome da foto 10
fotoImovel11 String Nome da foto 11
fotoImovel12 String Nome da foto 12
fotoImovel13 String Nome da foto 13
fotoImovel14 String Nome da foto 14
fotoImovel15 String Nome da foto 15
fotoImovel16 String Nome da foto 16
fotoImovel17 String Nome da foto 17
fotoImovel18 String Nome da foto 18
fotoImovel19 String Nome da foto 19
fotoImovel20 String Nome da foto 20
fotoImovel21 String Nome da foto 21
fotoImovel22 String Nome da foto 22
fotoImovel23 String Nome da foto 23
fotoImovel24 String Nome da foto 24
fotoImovel25 String Nome da foto 25
fotoImovel26 String Nome da foto 26
fotoImovel27 String Nome da foto 27
fotoImovel28 String Nome da foto 28
fotoImovel29 String Nome da foto 29
fotoImovel30 String Nome da foto 30
descricaoFotoImovel1 String Descrição da foto 1
descricaoFotoImovel2 String Descrição da foto 2
descricaoFotoImovel3 String Descrição da foto 3
descricaoFotoImovel4 String Descrição da foto 4
descricaoFotoImovel5 String Descrição da foto 5
descricaoFotoImovel6 String Descrição da foto 6
descricaoFotoImovel7 String Descrição da foto 7
descricaoFotoImovel8 String Descrição da foto 8
descricaoFotoImovel9 String Descrição da foto 9
descricaoFotoImovel10 String Descrição da foto 10
descricaoFotoImovel11 String Descrição da foto 11
descricaoFotoImovel12 String Descrição da foto 12
descricaoFotoImovel13 String Descrição da foto 13
descricaoFotoImovel14 String Descrição da foto 14
descricaoFotoImovel15 String Descrição da foto 15
descricaoFotoImovel16 String Descrição da foto 16
descricaoFotoImovel17 String Descrição da foto 17
descricaoFotoImovel18 String Descrição da foto 18
descricaoFotoImovel19 String Descrição da foto 19
descricaoFotoImovel20 String Descrição da foto 20
descricaoFotoImovel21 String Descrição da foto 21
descricaoFotoImovel22 String Descrição da foto 22
descricaoFotoImovel23 String Descrição da foto 23
descricaoFotoImovel24 String Descrição da foto 24
descricaoFotoImovel25 String Descrição da foto 25
descricaoFotoImovel26 String Descrição da foto 26
descricaoFotoImovel27 String Descrição da foto 27
descricaoFotoImovel28 String Descrição da foto 28
descricaoFotoImovel29 String Descrição da foto 29
descricaoFotoImovel30 String Descrição da foto 30
descricao String Descrição do Imóvel
expoimovel char ‘1’ – Mostrar no expoimovel.com
‘0’ – se não
siteimob char ‘1’ – Mostrar no site da empresa
‘0’ – se não
endMostrarInternet char ‘1’ – Mostrar endereço na internet
‘0’ – se não
nomeMostrarInternet char ‘1’ – Mostrar nome na internet
‘0’ – se não
tipoImovel String Descrição do tipo do imóvel
“1” – Apartamento
“2” – Casa
“3” – Loja
“4” – Terreno/Loteamento
“5” – Galpão/Prédio Comercial
“6” – Sala Comercial
“7” – Rural
“8” – Flat/Studio
“9” – Hotel/Pousada
“10” – Restaurante/ Lanchonete
idTipoImovel String Id do tipo do imóvel
“1” – Apartamento
“2” – Casa
“3” – Loja
“4” – Terreno/Loteamento
“5” – Galpão/Prédio Comercial
“6” – Sala Comercial
“7” – Rural
“8” – Flat/Studio
“9” – Hotel/Pousada
“10” – Restaurante/ Lanchonete
tipoOperacao Character ‘V’ – Disponível para Venda

‘L’ – Disponível para Aluguel

descricaoTipoOperacao String ‘V’ – Disponível para Venda

‘L’ – Disponível para Aluguel

codEdificio String Código do emprendimento
idEmpreendimento Long ID do emprendimento
construtora Integer Código da construtora
empresaId Integer ID da Empresa do Imóvel
empresaLogomarca String Logomarca da Empresa do Imóvel
empresaRazaoSocial String Razão Social da Empresa do Imóvel
empresaNomeFantasia String Nome Fantasia da Empresa do Imóvel
temInterfone char ‘1’ – Tem Interfone
‘0’ – não tem
temAntenaColetiva char ‘1’ – Tem Antena Coletiva
‘0’ – não tem
temPiscina char ‘1’ – tem Piscina
‘0’ – não tem
temPlayground char ‘1’ – tem Playground
‘0’ – não tem
temGerador char ‘1’ – tem Gerador
‘0’ – não tem
temQuadraEsportiva char ‘1’ – tem Quadra Esportiva
‘0’ – não tem
temSauna char ‘1’ – tem Sauna
‘0’ – não tem
temSalaGinastica char ‘1’ – tem Sala de Ginastica
‘0’ – não tem
temPocoArtesiano char ‘1’ – tem Poço Artesiano
‘0’ – não tem
temPistaCooper char ‘1’ – tem Pista de Cooper
‘0’ – não tem
temSalaoFestas char ‘1’ – tem Salão de Festas
‘0’ – não tem
temCentralGas char ‘1’ – tem Central de Gás
‘0’ – não tem
temPortaoEletronico char ‘1’ – tem Portão Eletrônico
‘0’ – não tem
temChurrasqueira char ‘1’ – tem Churrasqueira
‘0’ – não tem
temGuarita char ‘1’ – tem Guarita
‘0’ – não tem
temSistemaSeguranca char ‘1’ – tem Sistema de Segurança
‘0’ – não tem
temPilotis char ‘1’ – tem Pilotis
‘0’ – não tem
temArmarioQuarto char ‘1’ – tem Armário no Quarto
‘0’ – não tem
temBoxBanheiro char ‘1’ – tem Box no Banheiro
‘0’ – não tem
temDepEmpregada char ‘1’ – tem Dependência de Empregada
‘0’ – não tem
temDepPrivativo char ‘1’ – tem Depósito Privativo
‘0’ – não tem
temEstacionamento char ‘1’ – tem Estacionamento
‘0’ – não tem
temInternet char ‘1’ – tem Internet
‘0’ – não tem
mobiliado char ‘1’ – É mobiliado
‘0’ – não tem
temTvCabo char ‘1’ – tem Tv a Cabo
‘0’ – não tem
temVaranda char ‘1’ – tem Varanda
‘0’ – não tem
temTabelaPrecos char ‘1’ – tem Tabela Preços
‘0’ – não tem
temAreaServico char ‘1’ – tem Área de Serviço
‘0’ – não tem
temCloset char ‘1’ – tem Closet
‘0’ – não tem
temCopa char ‘1’ – tem Copa
‘0’ – não tem
temCorredor char ‘1’ – tem Corredor
‘0’ – não tem
temCozinha char ‘1’ – tem Cozinha
‘0’ – não tem
temDespensa char ‘1’ – tem Despensa
‘0’ – não tem
temEscritorio char ‘1’ – tem Escritório
‘0’ – não tem
temHidro char ‘1’ – tem Hidromassagem
‘0’ – não tem
temLavabo char ‘1’ – tem Lavabo
‘0’ – não tem
temMezanino char ‘1’ – tem Mezanino
‘0’ – não tem
temPergolado char ‘1’ – tem Pergolado
‘0’ – não tem
temQuartoReversivel char ‘1’ – tem Quarto Reversível
‘0’ – não tem
temSalaEstar char ‘1’ – tem Sala de Estar
‘0’ – não tem
temSalaIntima char ‘1’ – tem Sala Íntima
‘0’ – não tem
temSalaJantar char ‘1’ – tem Sala de Jantar
‘0’ – não tem
temSalaVisita char ‘1’ – tem Sala de Visita
‘0’ – não tem
temTelefone char ‘1’ – tem Telefone
‘0’ – não tem
temCanil char ‘1’ – tem Canil
‘0’ – não tem
temJardimExterno char ‘1’ – tem Jardim Externo
‘0’ – não tem
temJardimInterno char ‘1’ – tem Jardim Interno
‘0’ – não tem
temLavanderia char ‘1’ – tem Lavanderia
‘0’ – não tem
nascente char ‘1’ – nascente
‘0’ – não tem
poente char ‘1’ – poente
‘0’ – não tem
ruaCalcada char ‘1’ – tem Rua Calçada
‘0’ – não tem
temWcServico char ‘1’ – tem banheiro de
erviço
‘0’ – não tem
temBar char ‘1’ – tem Bar
‘0’ – não tem
temSalaConvivencia char ‘1’ – tem Sala Convivência
‘0’ – não tem
temCozinhaAmericana char ‘1’ – tem Cozinha Americana
‘0’ – não tem
temArmarioCozinha char ‘1’ – tem Armário na Cozinha
‘0’ – não tem
temCeramica char ‘1’ – tem Cerâmica
‘0’ – não tem
cercado char ‘1’ – é cercado
‘0’ – não tem
conjugada char ‘1’ – é conjugada
‘0’ – não tem
temDocumentacao char ‘1’ – tem Documentação
‘0’ – não tem
temEscritura char ‘1’ – tem Escritura
‘0’ – não tem
temEsquadrilha char ‘1’ – tem Esquadrilha
‘0’ – não tem
gradeado char ‘1’ – é gradeado
‘0’ – não tem
isolado char ‘1’ – é isolado
‘0’ – não tem
murado char ‘1’ – é murado
‘0’ – não tem
temPiso char ‘1’ – tem Piso
‘0’ – não tem
temQuartoDeposito char ‘1’ – tem Quarto Depósito
‘0’ – não tem
quitado char ‘1’ – é quitado
‘0’ – não tem
temRodaTeto char ‘1’ – tem Roda Teto
‘0’ – não tem
sol char ‘1’ – sol
‘0’ – não tem
sombra char ‘1’ – sombra
‘0’ – não tem
vistaRio char ‘1’ – tem Vista para Rio
‘0’ – não tem
vistaLagoa char ‘1’ – tem Vista para Lagoa
‘0’ – não tem
vistaMata char ‘1’ – tem Vista para mata
‘0’ – não tem
vistaMar char ‘1’ – tem Vista para o Mar
‘0’ – não tem
beiraMar char ‘1’ – é Beira mar
‘0’ – não tem
caixaDagua char ‘1’ – tem Caixa D’água
‘0’ – não tem
esquina char ‘1’ – é de esquina
‘0’ – não tem
salaoJogos char ‘1’ – tem Salão de Jogos
‘0’ – não tem
sisterna char ‘1’ – tem Cisterna
‘0’ – não tem
lajeado char ‘1’ – é lajeado
‘0’ – não tem
temMuroAlto char ‘1’ – tem Muro Alto
‘0’ – não tem
temQuintal char ‘1’ – tem Quintal
‘0’ – não tem
temTerraco char ‘1’ – tem Terraço
‘0’ – não tem
temEstacionamentoVisitantes char ‘1’ – tem Estacionamento de Visitantes
‘0’ – não tem
saneado char ‘1’ – é saneado
‘0’ – não tem
temBusinessCenter char ‘1’ – tem Business Center
‘0’ – não tem
temCentralFaxRecados char ‘1’ – tem Central de Fax e Recados
‘0’ – não tem
temCoffeeShop char ‘1’ – tem Coffee Shop
‘0’ – não tem
temHomeOffice char ‘1’ – tem Home Office
‘0’ – não tem
temLimpezaUnidades char ‘1’ – tem Limpeza de Unidades
‘0’ – não tem
temManutencaoUnidades char ‘1’ – tem Manutenção das Unidades
‘0’ – não tem
temSalaConvencoes char ‘1’ – tem Sala Convenções
‘0’ – não tem
temEspacoGourmet char ‘1’ – tem Espaço Gourmet
‘0’ – não tem
temColetaLavanderia char ‘1’ – tem Coleta Lavanderia
‘0’ – não tem
temRestaurante char ‘1’ – tem Restaurante
‘0’ – não tem
temPatioDescarga char ‘1’ – tem Pátio de Descarga
‘0’ – não tem
temTelaNaVaranda char ‘1’ – tem Tela Na Varanda
‘0’ – não tem
temArmariosProjetados char ‘1’ – tem Armários Projetados
‘0’ – não tem
temElevadorInteligente char ‘1’ – tem Elevador Inteligente
‘0’ – não tem
temArcondicionadoCentral char ‘1’ – tem Ar condicionado Central
‘0’ – não tem
temArcondicionadoSplit char ‘1’ – tem Ar condicionado Split
‘0’ – não tem
temBicicletario char ‘1’ – tem Bicicletário
‘0’ – não tem
temElevadorPanoramico char ‘1’ – tem Elevador Panorâmico
‘0’ – não tem
temArcondicionadoParede char ‘1’ – tem Ar condicionado Parede
‘0’ – não tem
temCercaEletrica char ‘1’ – tem Cerca Elétrica
‘0’ – não tem
temTerracoEmL char ‘1’ – tem Terraço Em L
‘0’ – não tem
temGaragemCoberta char ‘1’ – tem Garagem Coberta
‘0’ – não tem
temEdicula char ‘1’ – tem Edícula
‘0’ – não tem
temPisoElevado char ‘1’ – tem Piso Elevado
‘0’ – não tem
temDepositoSubsolo char ‘1’ – tem Deposito Subsolo
‘0’ – não tem
temLuzEletrica char ‘1’ – tem Luz Elétrica
‘0’ – não tem
temAguaEncanada char ‘1’ – tem Água Encanada
‘0’ – não tem
temVistaAberta char ‘1’ – tem Vista Aberta
‘0’ – não tem
foreiro char ‘1’ – tem foreiro
‘0’ – não tem
podefinanciar char ‘1’ – Pode Financiar
‘0’ – não tem
destaque char ‘1’ – é Destaque
‘0’ – não tem
destaquebanner char ‘1’ – é Destaque no Banner do Site
‘0’ – não tem
cobertura char ‘1’ – é Cobertura
‘0’ – não tem
condominioFechado char ‘1’ – é condomínio Fechado
‘0’ – não tem
temHidrometroIndividual char ‘1’ – tem Hidrômetro Individual
‘0’ – não tem
temPortaria24h char ‘1’ – tem Portaria 24h
‘0’ – não tem
litoral char ‘1’ – é Litoral
‘0’ – não tem
Popular char ‘1’ – é Popular
‘0’ – não tem
distanciaCidade Double Distancia da cidade em km
frente Double Medição da frente em metros (m)
esquerda Double Medição da esquerda em metros (m)
fundo Double Medição do fundo em metros (m)
direita Double Medição da direita em metros (m)
peDireito Double Medição do pé direito em metros (m)
dataEntrega Date Data de entrega para empreendimentos
tipoTerreno Integer Se idTipoImovel for “4”
tipoTerreno:
0 – Praia
1 – Campo
2 – Urbano
Se idTipoImovel for “7”
tipoTerreno:
0 – Chácara
1 – Fazenda
2 – Granja
3 – Haras
4 – Sítio
topografia Integer topografia:
0 – Plano
1 – Aclive
2 – Declive
urlCustom String Usado para url amigável, contém o tipo do imóvel, o status, bairro, cidade e estado.
Ex: apartamentos-comprar-vender-madalena-recife-pernambuco
estagioObra Short 1 – Planta
2 – Fundação
3 – Estrutura
4 – Estrutura Concluída
5 – Fase Acabamento
6 – Pronto
situacaoEmpreendimento Short 0 – Pré-Lançamento
1 – Lançamento
2 – Unidades Disponíveis
3 – Totalmente Vendido
urlDetalhe String URL do Detalhe do imóvel (URL amigável – SITE)
Ex: imovel/apartamentos-comprar-vender-madalena-recife-pernambuco/COD_IMOVEL
urlFichaPublica String URL do Detalhe do imóvel (SMART)
Ex: https://app.smart.youdigital.com.br/imovel/detalheImovel?codigoImovel=COD_IMOVEL&idE=ID_EMPRESA&full=1
urlImpressao String URL de Impressão do imóvel (SMART)
Ex: https://app.smart.youdigital.com.br/imovel/ imprimirImovel?codigoImovel=COD_IMOVEL&idE=ID_EMPRESA
urlFotoDestaque String URL de foto destaque do imóvel
salaPersonalizado String Texto com dados sobre salas e ambientes
Ex: 1 sala para 2 ambientes
fotoImovelList Lista de Foto Imovel Lista com fotos do imóvel (nome, descrição, destaque e url)
caracteristicasImovelList Lista de String Lista com todas as características do imóvel
caracteristicasEmpreendimentoList Lista de String Lista com todas as características do empreendimento (se pertencer a um empreendimento)


Atributos de Foto Imovel

nome String Nome do arquivo da imagem
descricao String Descrição do marco da obra
destaque Integer 0 – não destaque
1 – destaque
url String url da imagem [1024 x 768] pixels
urlThumbnail String url da imagem [230 x 175] pixels
urlThumbnailMiddleHD String url da imagem [640 x 360] pixels

Parâmetros do filtro para pesquisa de IMÓVEIS

O filtro é uma String no formato JSON podendo conter os seguintes atributos:

ATRIBUTO TIPO OBRIGATÓRIO DESCRIÇÃO
token String Sim Token de Integração da Empresa.

[Deve ser solicitado a Youdigital pelo usuário administrador da empresa]

quantidadeImoveis Integer Sim Número máximo de imóveis a serem retornados.
tipoImovel String Não Atributo do imóvel idTipoImovel separado por “;”

Ex: “1;2” para apartamento e casa, se não informado serão pesquisados todos os tipos.

idEstado Integer Não Id do Estado [consultar lista de estados].
idCidade Integer Não Id da Cidade [consultar lista de cidades pelo id do estado].
idBairros Integer[] Não Id dos Bairros [consultar lista de bairros pelo id da Cidade].

Ex: “idBairros”:[297,298]

statusImovelStr String Não Atributo do imóvel tipoOperacao separado por “;”

Ex: “V” para disponíveis para Venda, se não informado serão pesquisados todos os status.

empreendimento Boolean Não true ou false
false – exclui os imóveis de empreendimentos.
true – inclui os imóveis de empreendimentos.
novos Boolean Não true ou false
false – exclui os imóveis novos.
true – inclui os imóveis novos.
usados Boolean Não true ou false
false – exclui os imóveis usados.
true – inclui os imóveis usados.
paginado Boolean Não true ou false
true – Identifica a ação de paginação.
startpag Integer Não (padrão)
Sim (se paginado for true)
Offset para paginação.
Inicia-se em 0.
pagAtual Integer Não (padrão)
Sim (se paginado for true)
Indicador da página.
qtdTotal Não Total obtido na primeira pesquisa. Quando enviado no filtro melhora o desempenho.
precoMinimo String Não Preço Mínimo
Ex: “10000” para 10.000,00
precoMaximo String Não Preço Máximo
Ex: “750000” para 750.000,00
areaPrivativaMinimo String Não Área privativa Mínima
Ex: “40” para 40,00 m
areaPrivativaMaximo String Não Área privativa Máxima
Ex: “150” para 150,00 m
quartosMinimo String Não Número de Quartos Mínimo
Ex: “2”
quartosMaximo String Não Número de Quartos Máximo
Ex: “4”
garagensMinimo String Não Número de Garagens Mínimo
Ex: “1”
garagensMaximo String Não Número de Garagens Máximo
Ex: “2”
logradouro String Não Logradouro do imóvel
nomeDoImovel String Não Nome do imóvel
temporada Boolean Não true ou false
true – Para obter Imóveis de temporada
litoral Boolean Não true ou false
true – Para obter Imóveis de litoral
mobiliado Boolean Não true ou false
true – Para obter Imóveis mobiliados
popular Boolean Não true ou false
true – Para obter Imóveis populares
podeSerFinanciado Boolean Não true ou false
true – Para obter Imóveis que podem ser financiados
estagioObra Short Não 1 – Planta
2 – Fundação
3 – Estrutura
4 – Estrutura Concluída
5 – Fase Acabamento
6 – Pronto
situacaoEmpreendimento Short Não 0 – Pré-Lançamento
1 – Lançamento
2 – Unidades Disponíveis
3 – Totalmente Vendido
estagioObraStr String Não 1 – Planta
2 – Fundação
3 – Estrutura
4 – Estrutura Concluída
5 – Fase Acabamento
6 – Pronto
Ex: “estagioObraStr”:”1;2;3”
Para imóveis com estágio da obra na planta, fundação ou estrutura
situacaoEmpreendimentoStr String Não 0 – Pré-Lançamento
1 – Lançamento
2 – Unidades Disponíveis
3 – Totalmente Vendido
Ex: “situacaoEmpreendimentoStr”:”0;1”
Para imóveis com a situação de pré-lançamento ou lançamento
tipoContrato String Não “A” – Avulso
“AZ” – Autorizado
“L” – Lançamento
“O” – Opcionado
Usado para imóveis que não são de empreendimentos
destaqueNoSite Boolean Não Utilizado para obter imóveis marcados para destaque no site.
destaqueNoBanner Boolean Não Utilizado para obter imóveis marcados para aparecer no banner.
redeImobiliaria Integer Não Utilizado para obter imóveis marcados para uma rede específica.
[VER LISTA DE REDES/PORTAIS]
ordenacao String Não BAIRRO_AZ – Bairro de A a Z.
BAIRRO_ZA – Bairro de Z a A.
AMIN – Menor Área
AMAX – Maior Área
QMIN – Menos Quartos
QMAX – Mais Quartos
PMIN – Menor Preço
PMax – Maior Preço
Se não informada, a ordenação será efetuada por data de cadastro.
temFoto Character Não “s” para imóveis com foto
“n” para imóveis sem foto
termo String Não Termo para consulta [código, nome, logradouro, tipo do imóvel, bairro, cidade, estado]

Exemplos de filtros para consulta de IMÓVEIS

Filtro Destaques no Banner
{
“tipoImovel”:”1;2;3;4;5;6;7;8;9;10″,
“token”:”aaXxhasg623jasd32″,
“quantidadeImoveis”:5,
“idEstado”:1,
“statusImovelStr”:”V;L”,
“destaqueNoBanner”:true,
“novos”:true,
“usados”:true,
“paginado”:false,
“temFoto”:”s”
}
Filtro Destaques no Site
{
“tipoImovel”:”1;2;3;4;5;6;7;8;9;10″,
“token”:” aaXxhasg623jasd32″,
“quantidadeImoveis”:1,
“idEstado”:1,
“statusImovelStr”:”V;L”,
“destaqueNoSite”:true,
“novos”:true,
“usados”:true,
“paginado”:false,
“temFoto”:”s”
}
Filtro Vendas
{
“tipoImovel”:”1;2;3;4;5;6;7;8;9;10″,
“token”:”aaXxhasg623jasd32″,
“quantidadeImoveis”:2,
“idEstado”:1,
“statusImovelStr”:”V”,
“novos”:true,
“usados”:true,
“paginado”:false,
“temFoto”:”s”
}
Filtro Aluguel
{
“tipoImovel”:”1;2;3;4;5;6;7;8;9;10″,
“token”:”aaXxhasg623jasd32″,
“quantidadeImoveis”:2,
“idEstado”:1,
“statusImovelStr”:”L”,
“novos”:true,
“usados”:true,
“paginado”:false,
“temFoto”:”s”
}

Lista de REDES E PORTAIS onde cada imóvel pode estar publicado

CÓDIGO DA REDE NOME DA REDE
3 ADEMI Imóveis
5 SECOVI-PE
7 Rede Brasil de Imóveis
11 Salão Imobiliário de Pernambuco
13 Soma
15 Portal Imobiliário de Pernambuco
16 Lugar Certo
18 Viva Real Portal Imobiliário
19 Geral Imóveis
20 OLX
22 Chave Fácil
23 ZAP Imóveis
24 Web Terreno
25 Classificados JC
26 Tiqueimóveis
27 Imovelweb
29 Tribuna do Norte

Métodos para consulta de Imóveis

Método – Obter Imóvel

URL: http://app.smart.youdigital.com.br/sites/v1/imovel/CODIGO_IMOVEL/TOKEN

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
CODIGO_IMOVEL Sim Código do imóvel
TOKEN Sim Token de Integração da empresa.
[O token deverá ser solicitado a Youdigital pelo responsável da empresa]

Retorno:

Sempre será retornado um JSON com uma mensagem e o imóvel requisitado ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{
“mensagem”: “sucesso”, “imovel”:
{
“código”: “IMV_001”,
…outros atributos
}
}
{
“mensagem”: “aqui a mensagem de erro.
}

Método – Obter total de Imóveis 


URL: 
http://app.smart.youdigital.com.br/sites/v1/imovel/totalImoveisFiltro?filtro={FILTRO}

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
FILTRO Sim Filtro para pesquisa dos imóveis em formato JSON.

(ver Parâmetros do filtro para pesquisa acima)

Retorno:

Sempre será retornado um JSON com uma mensagem e o total requisitado ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{
“mensagem”: “sucesso”,“total”: 25
}
{
“mensagem”: “aqui a mensagem de erro.”
}

Obter Lista de Imóveis por Filtro

URL: http://app.smart.youdigital.com.br/sites/v1/imovel/listarImoveisFiltro?filtro={FILTRO}

Método de Envio:  GET

Header:  Content-Type: application/x-www-form-urlencoded

Parâmetros: 

Nome Obrigatório Descrição
FILTRO Sim Filtro para pesquisa dos imóveis em formato JSON (ver atributos do Filtro acima)

Retorno: 

Sempre será retornado um JSON com uma mensagem e os imoveis requisitados ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{
“mensagem”: “sucesso”, “imoveis”: [
{
“codigoImovel”:”RE009″,
…outros atributos…
},
{
“codigoImovel”:”RE010″,
…outros atributos…
},
]
}
{
“mensagem”: “aqui a mensagem de erro.”
}

Obter Lista de Imóveis por Códigos

URL:  http://app.smart.youdigital.com.br/sites/v1/imovel/listarImoveisLista?codigos=CODIGOS&token=TOKEN

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
CODIGOS Sim String com os códigos dos imóveis a serem pesquisados, separados por “;”.

Ex: codigos=IMV_001;CS_02

TOKEN Sim Token de Integração da empresa.

[O token deverá ser solicitado a Youdigital pelo responsável da empresa]

Retorno:

Sempre será retornado um JSON com uma mensagem e os imóveis requisitados ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{

“mensagem”: “sucesso”,

“imoveis”: [

{

“codigoImovel”:”IMV_001″,

…outros atributos…

},

{

“codigoImovel”:”CS_02″,

…outros atributos…

},

]

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

                                    

Método – Obter Imóveis Sugeridos (Imóveis Semelhantes)

URL: http://app.smart.youdigital.com.br/sites/v1/imovel/imoveisSugeridos/CODIGO/TOKEN

http://app.smart.youdigital.com.br/sites/v1/imovel/imoveisSugeridos/CODIGO/LIMITE/TOKEN

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
CODIGO Sim Código do Imóvel referência para a pesquisa de imóveis semelhantes.
LIMITE Sim Limite de imóveis a serem retornados. Usado na segunda url.
TOKEN Sim Token de Integração da empresa.

[O token deverá ser solicitado a Youdigital pelo responsável da empresa]

Retorno:

Sempre será retornado um JSON com uma mensagem e os imóveis requisitados ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{

“mensagem”: “sucesso”,

“imoveis”: [

{

“codigoImovel”:”IMV_001″,

…outros atributos…

},

{

“codigoImovel”:”CS_02″,

…outros atributos…

},

]

}

  {

“mensagem”: “aqui a mensagem de erro.”

}

EMPREENDIMENTOS

Atributos do Empreendimento

ATRIBUTO TIPO DESCRIÇÃO
idEmpreendimento Long id do Empreendimento
codigo String Código Referência do Empreendimento
nome String Nome do Empreendimento
categoria String Categoria do Empreendimento

“0” – Residencial

“1” – Comercial

datacadastro Date Data de cadastro do Empreendimento

exemplo: “Nov 10, 2015 1:49:18 PM”

endereco String Logradouro do Empreendimento
numero String Número para completar o endereço
nomeBairro String Nome do Bairro
nomeCidade String Nome da Cidade
siglaEstado String Sigla do Estado
smartEmpreendimento Integer 1 – Se For um Smart Empreendimento

0 – se não

estagioObra Short 1 – Planta

2 – Fundação

3 – Estrutura

4 – Estrutura Concluída

5 – Fase Acabamento

6 – Pronto

situacaoEmpreendimento Short 0 – Pré-Lançamento

1 – Lançamento

2 – Unidades Disponíveis

3 – Totalmente Vendido

dataEntrega Date Data de entrega para empreendimentos
totalBlocos Integer Total de Blocos
totalUnidades Integer Total de Unidades
unidadesAndar Integer Unidades por Andar
numPavimentos Integer Números de Pavimentos
numElevadores Integer Números de Elevadores
menorPrecoUnidades BigDecimal Menor preço das unidades
fotoDestaqueEmpreendimento String Nome da Foto Destaque
previsaoEntrega Date Data de previsão de entrega

exemplo: “Nov 10, 2015 1:49:18 PM”

pontoReferencia String Ponto de referência
diferenciais String Diferenciais
memorial String Memorial
urlHotsite String Url do hotsite
urlVideo String Url do vídeo
caracAntenaColetiva char ‘1’ – Tem Antena Coletiva

‘0’ – se não

caracArCondicCentral char ‘1’ – Tem Ar Condicionado Central

‘0’ – se não

caracArCondicParede char ‘1’ – Tem Ar Condicionado Parede

‘0’ – se não

caracArCondicSplit char ‘1’ – Tem Ar Condicionado Split

‘0’ – se não

caracBar char ‘1’ – Tem Bar

‘0’ – se não

caracBeiraMar char ‘1’ – Tem Beira Mar

‘0’ – se não

caracBicicletario char ‘1’ – Tem Bicicletário

‘0’ – se não

caracCaixaDagua char ‘1’ – Tem Caixa D’agua

‘0’ – se não

caracCanil char ‘1’ – Tem Canil

‘0’ – se não

caracCentralGas char ‘1’ – Tem Central Gás

‘0’ – se não

caracCercaEletrica char ‘1’ – Tem Cerca Elétrica

‘0’ – se não

caracChurrasqueira char ‘1’ – Tem Churrasqueira

‘0’ – se não

caracCisterna char ‘1’ – Tem Cisterna

‘0’ – se não

caracDepositoPrivado char ‘1’ – Tem Deposito Privado

‘0’ – se não

caracElevIntelig char ‘1’ – Tem Elevador Inteligente

‘0’ – se não

caracElevPanoram char ‘1’ – Tem Elevador Panorâmico

‘0’ – se não

caracEsquina char ‘1’ – Tem Esquina

‘0’ – se não

caracEstacionamento char ‘1’ – Tem Estacionamento

‘0’ – se não

caracGerador char ‘1’ – Tem Gerador

‘0’ – se não

caracGuarita char ‘1’ – Tem Guarita

‘0’ – se não

caracInterfone char ‘1’ – Tem Interfone

‘0’ – se não

caracInternet char ‘1’ – Tem Internet

‘0’ – se não

caracJardimExt char ‘1’ – Tem Jardim Externo

‘0’ – se não

caracJardimInt char ‘1’ – Tem Jardim Interno

‘0’ – se não

caracLavanderia char ‘1’ – Tem Lavanderia

‘0’ – se não

caracPilotis char ‘1’ – Tem Pilotis

‘0’ – se não

caracPiscina char ‘1’ – Tem Piscina

‘0’ – se não

caracPistaCooper char ‘1’ – Tem Pista de Cooper

‘0’ – se não

caracPlayground char ‘1’ – Tem Playground

‘0’ – se não

caracPocoArtesiano char ‘1’ – Tem Poço Artesiano

‘0’ – se não

caracPortaoEletronico char ‘1’ – Tem Portão Eletrônico

‘0’ – se não

caracQuadraPoliesp char ‘1’ – Tem Quadra Poliesportiva

‘0’ – se não

caracRuaCalcada char ‘1’ – Tem Rua Calçada

‘0’ – se não

caracSalaConvivencia char ‘1’ – Tem Sala Convivência

‘0’ – se não

caracSalaGinastica char ‘1’ – Tem Sala Ginástica

‘0’ – se não

caracSalaoFestas char ‘1’ – Tem Salão de Festas

‘0’ – se não

caracSalaoJogos char ‘1’ – Tem Salão de Jogos

‘0’ – se não

caracSauna char ‘1’ – Tem Sauna

‘0’ – se não

caracSistemaSeguranca char ‘1’ – Tem Sistema de Segurança

‘0’ – se não

caracTvCabo char ‘1’ – Tem Tv a Cabo

‘0’ – se não

caracEdicula char ‘1’ – Tem Edícula

‘0’ – se não

caracGaragemCoberta char ‘1’ – Tem Garagem Coberta

‘0’ – se não

caracGradeado char ‘1’ – É Gradeado

‘0’ – se não

caracLajeado char ‘1’ – É Lajeado

‘0’ – se não

caracMuroAlto char ‘1’ – Tem Muro Alto

‘0’ – se não

caracQuintal char ‘1’ – Tem Quintal

‘0’ – se não

caracEstacionamentoVisit char ‘1’ – Tem Estacionamento Visitante

‘0’ – se não

caracPisoElevado char ‘1’ – Tem Piso Elevado

‘0’ – se não

caracBusinessCenter char ‘1’ – Tem Business Center

‘0’ – se não

caracCentralFaxRec char ‘1’ – Tem Central Fax Recado

‘0’ – se não

caracCoffeeShop char ‘1’ – Tem Coffee Shop

‘0’ – se não

caracColetaLavanderia char ‘1’ – Tem Coleta Lavanderia

‘0’ – se não

caracEspacoGourmet char ‘1’ – Tem Espaço Gourmet

‘0’ – se não

caracHomeOffice char ‘1’ – Tem Home Office

‘0’ – se não

caracLimpezaUnidades char ‘1’ – Tem Limpeza Unidades

‘0’ – se não

caracManutencaoUnidades char ‘1’ – Tem Manutenção das Unidades

‘0’ – se não

caracRestaurante char ‘1’ – Tem Restaurante

‘0’ – se não

caracSalaConvencoes char ‘1’ – Tem Sala de Convenções

‘0’ – se não

caracPortaria24h char ‘1’ – Tem Portaria 24h

‘0’ – se não

caracTopografia char ‘1’ – Tem Topografia

‘0’ – se não

caracLitoral char ‘1’ – É no Litoral

‘0’ – se não

caracPopular char ‘1’ – É Popular

‘0’ – se não

outrasCaracteristicas String Outras características separadas por “;”

Ex: “arquiterura moderna;duplex”

fotosEmpreendimentoList Lista de Fotos do Empreendimento Lista com as Fotos do Empreendimento
tiposImovel Lista de Imovel Lista com os Tipos de Imóveis do Empreendimento
listaCaracteristicas Lista de String Lista com todas as características do Empreendimento
videos Lista de Video Lista com os vídeos do Empreendimento
tabelas Lista de Tabela de Preço do Empreendimento Lista de Tabelas de preço do empreendimento.
O parâmetro “tipoTabela” define se é uma arquivo ou não.
arquivos Lista de Arquivo do Empreendimento Lista de Arquivos do empreendimento para download
nomeCustom String Nome do empreendimento em caixa baixa, sem acentuação e sem espaços. (Para uso de url amigável)
Ex: edifício-maria-amelia
urlDetalhe String URL do Detalhe do Empreendimento (URL amigável)
Ex: empreendimento/apartamentos-comprar-vender-madalena-recife-pernambuco/ID_EMPREENDIMENTO
urlFichaPublica String URL do Detalhe do imóvel (SMART)
Ex: https://app.smart.youdigital.com.br/empreendimento/detalhe?idEmpreendimento=ID_EMPREENDIMENTO&idE=ID_EMPRESA
urlImpressao String URL de Impressão do imóvel (SMART)
Ex: https://app.smart.youdigital.com.br/empreendimento/detalhe?idEmpreendimento= ID_EMPREENDIMENTO&idE=ID_EMPRESA
precoPersonalizado String Texto com dados sobre o preço
Ex: A partir de R$ 200.000,00
quartoPersonalizado String Texto com dados sobre quantidade de quartos
Ex: 1 ou 2
suitePersonalizado String Texto com dados sobre quantidade de suítes
Ex: 1 ou 2
areaPersonalizada String Texto com dados sobre área
Ex: 35,22 a 45
vagaPersonalizada String Texto com dados sobre vagas de garagem
Ex: 1 ou 3
menorPrecoTipo BigDecimal Menor preço
maiorPrecoTipo BigDecimal Maior preço
urlFotoBanner String Url do banner do empreendimento
urlFotoDestaque String Url da Foto Destaque

Atributos de Tabela de Preço do Empreendimento

ATRIBUTO TIPO DESCRIÇÃO
dataCadastro Date Data de cadastro
ex: “Nov 10, 2015 1:49:18 PM”
dataAtualizacao Date Data de atualização
ex: “Nov 20, 2016 10:05:22 AM”
tipoTabela Integer 0 – tabela gerada
2 – arquivo para download
nomeTabela String Título da Tabela de Preço
descricao String Descrição da Tabela
url String URL da tabela

Atributos de Arquivo do Empreendimento

ATRIBUTO TIPO DESCRIÇÃO
cadastradoEm Date Data de cadastro
ex: “Nov 10, 2015 1:49:18 PM”
atualizadoEm Date Data de atualização
ex: “Nov 20, 2016 10:05:22 AM”
nome String Título do arquivo
descricao String Descrição do arquivo
url String URL do arquivo

Atributos de Video

ATRIBUTO TIPO DESCRIÇÃO
descricao String Descrição do Vídeo
url String URL do Vídeo (youtube)

Atributos de Fotos do Empreendimento

ATRIBUTO TIPO DESCRIÇÃO
id Long id da Imagem
nome String Nome da Imagem
descricao String Descrição da Imagem
destaque int 0 – não destaque

1 – destaque

url String url da imagem [1024 x 768] pixels
urlThumbnail String url da imagem [230 x 175] pixels
urlThumbnailMiddleHD String url da imagem [640 x 360] pixels

 

Atributos de Andamento da Obra

ATRIBUTO TIPO DESCRIÇÃO
estFundacao Integer Percentual de 0 a 100 da Fundação
estEstrutura Integer Percentual de 0 a 100 da Estrutura
estAlvenaria Integer Percentual de 0 a 100 da Alvenaria
estInstalacoes Integer Percentual de 0 a 100 das Instalações
estAcabamentoInterno Integer Percentual de 0 a 100 do Acabamento Interno
estAcabamentoExterno Integer Percentual de 0 a 100 do Acabamento Externo
iniciouObra Boolean true ou false

true – Identifica

Entregue Boolean true ou false

true – Indica empreendimento entregue

previsaoEntrega String Data da previsão de entrega

ex: 04/1987

dataAtualizacao Date Data de previsão de entrega

exemplo: “Dec 5, 2016” (05/12/2016)

marcoEstagioObraList Lista de Marco da Obra Lista com os Marcos da Obra

Atributos de Marco da Obra

ATRIBUTO TIPO DESCRIÇÃO
descricao String Descrição do marco da obra
dataMarcoObra Date Data de cadastro do marco da obra

exemplo: “Dec 4, 2016” (04/12/2016)

dataAtualizacao Date Data de previsão de entrega

exemplo: “Dec 5, 2016” (05/12/2016)

imagemMarcoObraList Lista de Imagem do Marco da Obra Lista com as Imagens do Marco da Obra

Atributos de Imagem do Marco da Obra

ATRIBUTO TIPO DESCRIÇÃO
nomeArquivo String Nome do arquivo da imagem
destaque Boolean true ou false

true – Indica que é a foto destaque

descricao String Descrição da Imagem

Parâmetros do filtro para pesquisa de Empreendimentos

 O filtro é uma String no formato JSON podendo conter os seguintes atributos:

ATRIBUTO TIPO OBRIGATÓRIO DESCRIÇÃO
token String Sim Token de Integração da Empresa.

[Deve ser solicitado a Youdigital pelo usuário administrador da empresa]

quantidade Integer Sim Número máximo de empreendimentos a serem retornados.
nome String Não Nome do Empreendimento
idEstado Integer Não Id do Estado [consultar lista de estados].
idCidade Integer Não Id da Cidade [consultar lista de cidades pelo id do estado].
idBairros Integer[] Não Id dos Bairros [consultar lista de bairros pelo id da Cidade].

Ex: “idBairros”:[297,298]

paginado Boolean Não true ou false

true – Identifica a ação de paginação.

startpag Integer Não (padrão)

Sim (se paginado for true)

Offset para paginação.

Inicia-se em 0.

pagAtual Integer Não (padrão)

Sim (se paginado for true)

Indicador da página.
qtdTotal Integer Não Total obtido na primeira pesquisa. Quando enviado no filtro melhora o desempenho.
precoMinimo String Não Preço Mínimo

Ex: “10000” para 10.000,00

precoMaximo String Não Preço Máximo

Ex: “750000” para 750.000,00

quartosMinimo String Não Número de Quartos Mínimo

Ex: “2”

quartosMaximo String Não Número de Quartos Máximo

Ex: “4”

areaPrivativaMinimo String Não Área privativa Mínima

Ex: “40” para 40,00 m

areaPrivativaMaximo String Não Área privativa Máxima

Ex: “72” para 72,00 m

garagensMinimo Integer Não Número de Garagens Mínimo

Ex: “1”

garagensMaximo Integer Não Número de Garagens Máximo

Ex: “2”

litoral Boolean Não true ou false

true – Para obter Imóveis de litoral

popular Boolean Não true ou false

true – Para obter Imóveis popular

temTabelaPreco Boolean Não true ou false

true – Para obter Imóveis que têm tabela de preço

temUnidadesDisponiveis Boolean Não true ou false

true – Para empreendimentos com unidades disponíveis

destaque Boolean Não true ou false

true – Para empreendimentos marcados como destaque para o site

destaquebanner Boolean Não true ou false

true – Para empreendimentos marcados como destaque para o banner do site

estagioObra Short Não 1 – Planta

2 – Fundação

3 – Estrutura

4 – Estrutura Concluída

5 – Fase Acabamento

6 – Pronto

situacaoEmpreendimento Short Não 0 – Pré-Lançamento

1 – Lançamento

2 – Unidades Disponíveis

3 – Totalmente Vendido

estagioObraStr String Não 1 – Planta
2 – Fundação
3 – Estrutura
4 – Estrutura Concluída
5 – Fase Acabamento
6 – ProntoEx: “estagioObraStr”:”1;2;3”
Para imóveis com estágio da obra na planta, fundação ou estrutura
situacaoEmpreendimentoStr String Não 0 – Pré-Lançamento
1 – Lançamento
2 – Unidades Disponíveis
3 – Totalmente VendidoEx: “situacaoEmpreendimentoStr”:”0;1”
Para imóveis com a situação de pré-lançamento ou lançamento
termo String Não Termo para consulta [código, nome, logradouro, diferenciais, bairro, cidade, estado]

 

Métodos para Empreendimentos

Método – Obter Empreendimento

URL: http://app.smart.youdigital.com.br/sites/v1/empreendimento/ID/TOKEN

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
ID Sim ID do Empreendimento
TOKEN Sim Token de Integração da empresa.

[O token deverá ser solicitado a Youdigital pelo responsável da empresa]

 Retorno:

Sempre será retornado um JSON com uma mensagem e o empreendimento requisitado ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{

“mensagem”: “sucesso”,

“empreendimento”: {

“id”: 2610,

…outros atributos

}

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Obter Total de Empreendimentos por Filtro

URL: http://app.smart.youdigital.com.br/sites/v1/empreendimento/totalEmpreendimentosFiltro?filtro={FILTRO_EMPRENDIMENTO}

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
FILTRO_EMPREENDIMENTO Sim Filtro para pesquisa dos empreendimentos em formato JSON

Retorno:

Sempre será retornado um JSON com uma mensagem e o total requisitado ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{

“mensagem”: “sucesso”,

“total”: 25

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Método – Obter Lista de Empreendimentos por Filtro

URL: http://app.smart.youdigital.com.br/sites/v1/empreendimento/listarEmpreendimentosFiltro?filtro={FILTRO_EMPRENDIMENTO}

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
FILTRO_EMPRENDIMENTO Sim Filtro para pesquisa dos imóveis em formato JSON (ver atributos do Filtro acima)

Retorno:

Sempre será retornado um JSON com uma mensagem e os empreendimentos requisitados ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{

“mensagem”: “sucesso”,

“empreendimentos”: [

{

“id”:2601,

…outros atributos…

},

{

“id”:2602,

…outros atributos…

}

]

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Obter Lista de Empreendimentos por Lista de ID

URL: http://app.smart.youdigital.com.br/sites/v1/empreendimento/listarEmpreendimentosLista?listaId=LISTAID&token=TOKEN

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
LISTAID Sim String com os ids dos empreendimentos a serem pesquisados, separados por “;”.

Ex: listaId=2601;2602

TOKEN Sim Token de Integração da empresa.

[O token deverá ser solicitado a Youdigital pelo responsável da empresa]

Retorno:

Sempre será retornado um JSON com uma mensagem e os empreendimentos requisitados ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{

“mensagem”: “sucesso”,

“empreendimentos”: [

{

“id”:2601,

…outros atributos…

},

{

“id”:2602,

…outros atributos…

}

]

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

 

Método – Obter Andamento da Obra do Empreendimento

URL:

http://app.smart.youdigital.com.br/sites/v1/empreendimento/andamentoObra/ID/TOKEN

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
ID Sim ID do Empreendimento
TOKEN Sim Token de Integração da empresa.

[O token deverá ser solicitado a Youdigital pelo responsável da empresa]

Retorno:

Sempre será retornado um JSON com uma mensagem e o andamento da obra requisitado ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
                              {

“mensagem”: “sucesso”,

“andamentoObra”: {

“estFundacao”: 85,

“estAlvenaria”: 30,

“estInstalacoes”: 0,

“estAcabamentoInterno”: 0,

“estAcabamentoExterno”: 0,

“iniciouObra”: true,

“entregue”: false,

“estEstrutura”: 65,

“previsaoEntrega”: “06/2016”,

“dataAtualizacao”: “Ago 2, 2016”,

“marcoEstagioObraList”: [{

“descricao”: “Marco da obra de Agosto 2016”,

“dataMarcoObra”: “Ago 1, 2016”,

“dataAtualizacao”: “Ago 2, 2016”,

“imagemMarcoObraList”: [{

“nomeArquivo”:                               “M_15_8867588466048735034.jpg”,

“destaque”: false,

“descricao”: “”

}, {

“nomeArquivo”:                               “M_15_3452012735125727883.jpg”,

“destaque”: false,

“descricao”: “”

}]

},[{

“descricao”: “Marco da obra de Novembro 2016”,

“dataMarcoObra”: “Nov 1, 2016”,

“dataAtualizacao”: ” Nov 2, 2016″,

“imagemMarcoObraList”: [{

“nomeArquivo”:                               “M_15_8867588466048735066.jpg”,

“destaque”: true,

“descricao”: “fundações 1”

}, {

“nomeArquivo”:                               “M_15_3452012735125725185.jpg”,

“destaque”: false,

“descricao”: ” fundações  2″

}]

}]

}

}

{

“mensagem”: “aqui a mensagem de erro.”

}

           

LOCALIZAÇÃO

Métodos para Localização

Método – Obter Estados do Brasil

URL: http://app.smart.youdigital.com.br/sites/v1/localizacao/estados

Método de Envio: GET

Header: 

Content-Type: application/x-www-form-urlencoded

Retorno:

Sempre será retornado um JSON com uma mensagem e os estados requisitados ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
                             {

“mensagem”: “sucesso”,

“estados”: [

{

“codigo”:1,

“nome”:”Pernambuco”,

“uf”:”PE”

},

{

“codigo”:2,

“nome”:”Rio Grande do Sul”,

“uf”:”RS”

},…

]

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Método – Obter Estado

URL: http://app.smart.youdigital.com.br/sites/v1/localizacao/estado/CODIGO_ESTADO

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
CODIGO_ESTADO Sim Código do Estado

 Retorno:

Sempre será retornado um JSON com uma mensagem e o estado requisitado ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
                             {

“mensagem”: “sucesso”,

“estado”: {

“codigo”:1,

“nome”:“Pernambuco”,

“uf”: “PE”

}

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Método – Obter Cidades por Estado

URL:  http://app.smart.youdigital.com.br/sites/v1/localizacao/cidades/CODIGO_ESTADO

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
CODIGO_ESTADO Sim Código do Estado

Retorno:

Sempre será retornado um JSON com uma mensagem e as cidades requisitadas ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
                             {

“mensagem”: “sucesso”,

“cidades”: [

{

“codigo”:133,

“cidade”:”Recife”

},

{

“codigo”:134,

“nome”:”Riaço das Almas”

},…

]

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Método – Obter Cidade

URL: http://app.smart.youdigital.com.br/sites/v1/localizacao/cidade/CODIGO_CIDADE

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
CODIGO_CIDADE Sim Código da Cidade

 Retorno:

Sempre será retornado um JSON com uma mensagem e a cidade requisitada ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
                             {

“mensagem”: “sucesso”,

“cidade”: {

“codigo”:133,

“cidade”:“Recife”

}

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Método – Obter Bairros por Cidade

URL: http://app.smart.youdigital.com.br/sites/v1/localizacao/bairros/CODIGO_CIDADE

Método de Envio: GET

Parâmetros:

Nome Obrigatório Descrição
CODIGO_CIDADE Sim Código da Cidade

Header: Content-Type: application/x-www-form-urlencoded

Retorno: 

Sempre será retornado um JSON com uma mensagem e os bairros requisitados ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
                             {

“mensagem”: “sucesso”,

“bairros”: [

{

“codigo”:239,

“bairro”:”Aflitos”

},

{

“codigo”:240,

“bairro”:”Afogados”

},…

]

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Método – Obter Bairro

URL: http://app.smart.youdigital.com.br/sites/v1/localizacao/bairro/CODIGO_BAIRRO

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
CODIGO_BAIRRO Sim Código do Bairro

 Retorno:

Sempre será retornado um JSON com uma mensagem e o bairro requisitado ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
                             {

“mensagem”: “sucesso”,

“bairro”: {

“codigo”:240,

“bairro”:“Afogados”

}

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

EMPRESA

Atributos de Empresa

ATRIBUTO TIPO DESCRIÇÃO
id Integer ID da empresa no sistema
empresarazaosocial String Razão Social
empresanomefantasia String Nome Fantasia
empresanomeresponsavel String Nome do responsável
email String E-mail da empresa
homepage String Homepage da empresa
tel1 String Telefone principal
endereco String Logradouro
bairro Integer código do bairro da empresa no sistema
cidade Integer código da cidade da empresa no sistema
uf Integer código do estado da empresa no sistema
cep String cep da empresa
urlLogomarca String URL da logomarca

Métodos para Empresa

Método – Obter Empresa

URL: http://app.smart.youdigital.com.br/sites/v1/empresa/TOKEN

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
TOKEN Sim Token de Integração da Empresa

 Retorno:

Sempre será retornado um JSON com uma mensagem e a empresa requisitada ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
{

“mensagem”: “sucesso”,

“empresa”: {

“id”: 1,

“empresanomefantasia”:“Nome”

…outros atributos

}

}

                             {

“mensagem”: “aqui a mensagem de erro.”

}

Método – Obter Configuração do Site

URL: http://app.smart.youdigital.com.br/sites/v1/empresa/configuracaoSite/TOKEN

Método de Envio: GET

Header: Content-Type: application/x-www-form-urlencoded

Parâmetros:

Nome Obrigatório Descrição
TOKEN Sim Token de Integração da empresa.

[O token deverá ser solicitado a Youdigital pelo responsável da empresa]

 Retorno:

Sempre será retornado um JSON com uma mensagem e a configuração do site requisitada ou apenas a mensagem se houver erro.

Os status sempre seguirão o padrão definido HTTP STATUS.

          Exemplo Sucesso Exemplo Erro
 {

“mensagem”: “sucesso”,

“configuracaoSite”: {

“corFundo”:“4B3BD”,

“corFonte”:“FFFFFF”

…outros atributos

}

}

{

“mensagem”: “aqui a mensagem de erro.”

}

Anúncios