14

Click here to load reader

Teste Breno

Embed Size (px)

DESCRIPTION

Ótima Revista

Citation preview

Page 1: Teste Breno

MANUAL DE INTEGRAÇÃO DE SISTEMA

IMÓVEIS TRIÂNGULO

Com o Sistema de Integração do Imóveis Triângulo, será possível importar os dados de um site ou aplicativo para o site www.imoveistriangulo.com.br, de forma simples e confiável.

Para iniciar o processo de integração é necessário ter em mãos o par de chaves de segurança. Esta informação pode ser acessada através da Área Restrita, no programa Gerar Chave de Segurança do grupo Configurações.

DOCUMENTAÇÃO DE INTEGRAÇÃO

1. Introdução

Toda comunicação realizada através do Sistema de Integração acontece através do envio de dados pelo método POST para o endereço http://imoveistriangulo.com.br/integracao/.

Ao enviar os dados para o endereço de integração, será enviado um retorno no formato JSON com os parâmetros:

Campo de retorno Descrição statusRetorno Informa qual a situação da requisição.

1 => Sucesso 2 =>Erro de dados 3 => Erro de Arquivo 4 => Permissão Negada

Retorno Texto descritivo com o retorno

Exemplo de Retorno no formato JSON:

{" statusRetorno":"1"," Retorno ":"Imóvel 296 Alterado com Sucesso"}

2. Tabelas de Códigos

Alguns atributos utilizados no sistema do Imóveis Triângulo utilizam tabelas auxiliares para definir suas opções. Sendo assim, quando uns destes atributos forem enviados para o Sistema de Integração utilize a Tabela de Código para identificar qual o valor que deverá ser enviado. Segue abaixo as tabelas:

Page 2: Teste Breno

2.1. Tabela de Categorias

A categoria do imóvel corresponde ao grupo que o imóvel pertence (Por Exemplo: Casa, Apartamento, Terreno e etc). Todos os parâmetros que utilizam o atributo categoria utilizam este padrão:

Categoria Descrição

1 Apartamento

2 Área

3 Casa

4 Chácara

5 Cobertura

6 Fazenda

7 Barracão

8 Galpão Industrial

9 Imóvel Comercial

10 Sobrado

11 Terreno

12 Apartamento Mobiliado

13 Casa em Condomínio

14 Cômodo Comercial

15 Terreno em Condomínio

16 Sala

17 Sítio

18 Galpão

2.2. Tabela de Classificações

A Classificação do imóvel define qual o objetivo do anúncio (Vender, Alugar ou Alugar para Temporada). Todos os parâmetros que utilizarem o atributo classificacao utilizam este padrão:

Finalidade Descrição

1 Venda

3 Aluguel

Page 3: Teste Breno

5 Temporada

2.3. Tabela de Cidades

O Imóveis Triangulo atende várias cidades da região, sendo assim a tabela de cidades é utilizada para refinar e organizar os imóveis em uma consulta. Todos os parâmetros que utilizarem o atributo cidade utilizam este padrão:

Cidade Estado Descrição da cidade

37025 MG Água comprida

37073 MG Araguari

37077 MG Araporã

37080 MG Araxá

38072 MG Campina verde

38078 MG Campos altos

38082 MG Canápolis

38091 MG Capinópolis

38110 MG Carmo do paranaíba

38112 MG Carneirinho

38118 MG Cascalho rico

38132 MG Centralina

38147 MG Comendador gomes

38419 MG Douradoquara

38443 MG Estrela do sul

38483 MG Fronteira

38485 MG Frutal

38775 MG Conceição das alagoas

38794 MG Conquista

38807 MG Coromandel

38828 MG Cruzeiro da fortaleza

39321 MG Grupiara

39337 MG Guimarânia

39343 MG Ibiá

39356 MG Indianópolis

Page 4: Teste Breno

39363 MG Ipiaçu

39393 MG Ituiutaba

39395 MG Iturama

39498 MG Matutina

39528 MG Monte alegre de minas

39531 MG Monte carmelo

39564 MG Nova ponte

39896 MG Lagoa formosa

40032 MG Cachoeira dourada

40216 MG Uberaba

40217 MG Uberlândia

40220 MG Uniao de minas

40239 MG Veríssimo

40335 MG Pratinha

40373 MG Rio paranaíba

40384 MG Romaria

40390 MG Sacramento

40520 MG Patos de minas

40522 MG Patrocínio

40537 MG Pedrinópolis

40549 MG Perdizes

40566 MG Pirajuba

40793 MG Serra do salitre

40817 MG Tapira

40826 MG Tiros

41304 MG Santa juliana

41321 MG Santa rosa da serra

41486 MG São francisco de sales

43969 MG Delta

44144 MG Gurinhatã

44145 MG Iraí de minas

44151 MG São gotardo

44210 MG Limeira do oeste

Page 5: Teste Breno

44301 MG Campo florido

44460 MG Abadia dos dourados

44469 MG Arapuá

44713 MG Itapagipe

45237 MG Tupaciguara

45319 MG Planura

45323 MG Prata

45469 MG Santa vitória

2.4. Tabela de Tipos de Logradouros

Na composição do logradouro é necessário informar o Tipo de Logradouro com base na tabela abaixo, utilize este padrão sempre que o atributo tipoLogradouro for utilizado:

tipoLogradouro Descrição tipoLogradouro Descrição

1 Aeroporto 24 Núcleo

2 Alameda 25 Outros

3 Área 26 Parque

4 Avenida 27 Passarela

5 Campo 28 Pátio

6 Chácara 29 Praça

7 Colônia 30 Quadra

8 Condomínio 31 Recanto

9 Conjunto 32 Residencial

10 Distrito 33 Rodovia

11 Esplanada 34 Rua

12 Estação 35 Setor

13 Estrada 36 Sítio

14 Favela 37 Travessa

15 Fazenda 38 Trecho

16 Feira 39 Trevo

17 Jardim 40 Vale

18 Ladeira 41 Vereda

19 Lago 42 Via

Page 6: Teste Breno

20 Lagoa 43 Viaduto

21 Largo 44 Viela

22 Loteamento 45 Vila

23 Morro 46 Sem tipo

2.4. Tabela de Bairros

Na composição do endereço é necessário informar o Bairro com base na tabela abaixo, utilize este padrão sempre que o atributo bairro for utilizado:

bairro Descrição bairro Descrição

3 Abadia 75 Manoel Mendes

4 Jardim Alexandre Campos

76 Jardim Maracanã

5 Alfredo Freire I 77 Margarida Rosa Azevedo

6 Alfredo Freire II 78 Vila Maria Helena

7 Alfredo Freire III 79 Mariita, Chácaras

8 Jardim Alvorada I 80 Maringá

9 Alvorada 81 Condomínio Mário Franco

10 Jardim América 82 Mercês

11 Amoroso Costa 83 Jardim Metrópole

12 Residencial Antônia Cândida

84 Parque do Mirante

13 Antônio Barbosa Sousa 85 Morada das Fontes

14 Vila Arquelau 86 Morada do Sol

15 Beija Flor I 87 Residencial Morada du Park

16 Beija Flor II 88 Jardim Morumbi

17 Beija Flor III 89 Mônica Cristina

18 Beija Flor IV 90 Jardim Nenê Gomes

19 Jardim Bela Vista 91 Nossa Senhora Aparecida

20 Boa Vista 92 Olinda

21 Jardim Boa Vista 93 Oneida Mendes

22 Bom Retiro 94 Cidade Ozanan

23 Chácara Bouganville 95 Pacaembu

Page 7: Teste Breno

24 Jardim Califórnia 96 Palmeiras, Residencial

25 Capelinha do Barreiro 97 Parque das Acácias

26 Cartafina, Silvério 98 Parque das Américas

27 Cássio Rezende 99 Parque Hylea

28 Centro 100 Planalto

29 Chica Ferreira 101 Pontal

30 Cidade Jardim 102 Ponte Alta

31 Cidade Nova 103 Jardim Primavera

32 Jardim Copacabana 104 Princesa do Sertão

33 Costa Teles I 105 Quinta da Boa Esperança

34 Costa Teles II 106 Recreio dos Bandeirantes

35 Damha I - Res. Uberaba 107 Recanto da Terra

36 Damha II - Res. Uberaba 108 Recanto das Torres

37 Deolinda Freire 109 Residencial 2000

38 Distrito Industrial I 110 Jardim Santa Clara

39 Distrito Industrial II 111 Jardim Santa Inês

40 Distrito Industrial III 112 Santa Maria

41 Jardim Dom Eduardo 113 Santa Marta

42 Jardim Eldorado 114 Santos Dumont

43 Jardim Elza Amuí 115 São Benedito

44 Vila Esperança 116 São Bento

45 Jardim Espírito Santo 117 São Cristovão

46 Jardim Esplanada 118 Parque São Geraldo

47 Vila Estado Novo 119 Parque São José

48 Estados Unidos 120 São Sebastião

49 Residencial Estados Unidos

121 Vila São Vicente

50 Estância dos Ipês 122 Serra do Sol

51 Jardim Europa 123 Serra Dourada

52 Europark 124 Sete Colinas

53 Fabrício 125 Jardim Siriema

54 Flamboyant I Resid. Park 126 Tancredo Neves, Residencial

55 Flamboyant II Resid. Park

127 Terra Nova, Condomínio

56 Flamboyant III Resid. Park

128 Tita Rezende

57 Frei Eugênio 129 Jardim Triângulo

Page 8: Teste Breno

58 Gameleiras I - Parque 130 Tutunas

59 Gameleiras II - Parque 131 Jardim Uberaba

60 Grande Horizonte 132 Conjunto Uberaba

61 Guanabara 133 Umuarama

62 Jardim Indianópolis 134 Universitário

63 Jardim Induberaba 135 Chácaras Vale do Sol

64 Irmãos Soares 136 Valim de Melo

65 Jardim Itália 137 Jardim Veneza

66 Jardim das Palmeiras 138 Vila Celeste

67 Jardim do Lago 139 Vila Leandro

68 Jockey Park 140 Vila Militar

69 Josa Bernadino 141 Vila Olímpica

70 José Barbosa 142 Vila Raquel

71 Leblon 143 Villa Real

72 Lourdes 144 Vilagio de Fiori

73 Mangueiras 145 Volta Grande

74 Jardim Manhatan 146 BR-050

147 Rural

3. Tipos e Formatos de Atributos

Para interagir com o Sistema de Integração será necessário utilizar os atributos nos tipos e formatos exigidos pela tabela abaixo:

Atributo Tipo Formato chave String Campo restrito gerado através da Área

Restrita. Este campo único e secreto, ele será utilizado para identificar o proprietário do imóvel. Atenção: Não divulgue esse registro para ninguém.

chaveSenha String Campo restrito gerado através da Área Restrita. Este campo único e secreto, ele será utilizado para identificar o proprietário do imóvel. Atenção: Não divulgue esse registro para ninguém.

codigo String Código utilizado pela imobiliária para

Page 9: Teste Breno

identificar o imóvel. Este campo é necessário para estabelecer a relação de DE – PARA com o sistema de integração. Este campo será utilizado também para identificar quando um imóvel será inserido ou alterado.

condicao Integer Condição do imóvel utilize: 1 => NOVO 2 => USADO

classificacao Integer Utilize a tabela de Classificações para preencher este atributo.

categoria Integer Utilize a tabela de Categorias para preencher este atributo.

nomeNL String Título do Anúncio. Exemplo: Casa Recanto Feliz

valorVenda Double - Opcional

Valor de Venda, caso a classificação utilizada seja Venda. Utilize sempre o ponto (“.”) para separar os decimais, por exemplo: 250.50

valorAluguel Double- Opcional

Valor de Aluguel, caso a classificação utilizada seja Aluguel ou Temporada. Utilize sempre o ponto (“.”) para separar os decimais, por exemplo: 250.50

valorCondominio Double- Opcional

Utilize sempre o ponto (“.”) para separar os decimais, por exemplo: 250.50

areaTotal Double- Opcional

Área total do imóvel. Utilize sempre o ponto (“.”) para separar os decimais, por exemplo: 250.50

areaPrivativa Double- Opcional

Área privativa do imóvel. Utilize sempre o ponto (“.”) para separar os decimais, por exemplo: 250.50

qtdQuartos Integer- Opcional

Quantidade de Quartos do imóvel.

qtdSuites Integer- Opcional

Quantidade de Suítes do imóvel.

qtdBanheiros Integer- Opcional

Quantidade de banheiros do imóvel.

qtdCarros Integer- Opcional

Quantidade de Carros do imóvel.

descricao Text- Opcional

Texto descritivo sobre o imóvel.

cep Integer(8) - Opcional

tipoLogradouro Integer Utilize a tabela de Tipos de Logradouros

Page 10: Teste Breno

para preencher este atributo. logradouro String Logradouro do imóvel, sem a presença do

TIPO, número e complemento, por exemplo: Dr. Fidélis Reis

numero String Número do endereço do imóvel. complemento String-

Opcional Complemento do Endereço do Imóvel.

bairro String Bairro do endereço do imóvel. cidade Integer Utilize a tabela de Cidades para preencher

este atributo. ativo Integer Este campo será utilizado para definir a

visualização do imóvel no site. Utilize os valores: 1 => Ativo 0 => Inativo

lancamento Integer- Opcional

Este campo será utilizado para definir se o imóvel inserido é um lançamento. Utilize os valores: 1 => Ativo 0 => Inativo

contrutoraLancamento String – Opcional

Nome da Construtora responsável pelo Lançamento

linkContrutoraLancamento String – Opcional

Link de site externo do lançamento.

latitudeEnd String – Opicional

Posição geográfica latitudinal do imóvel. O formato deve ser de decimal ATENÇÃO: O não fornecimento deste parâmetro acarretará o não aparecimento no mapa, apenas nas buscas de lista!

longitudeEnd String – Opicional

Posição geográfica longitudinal do imóvel. O formato deve ser decimal. ATENÇÃO: O não fornecimento deste parâmetro acarretará o não aparecimento da busca no mapa, apenas nas buscas de lista!

Page 11: Teste Breno

imagens String Lista das imagens a serem inseridas. A lista deverá estar configurada no padrão: URL|NOME; URL|NOME; Exemplo: http://seusite.com.br/imagens/83.jpg|Sacada; http:// seusite.com.br/ imagens /85.jpg|Sala; http:// seusite.com.br/ imagens /23.jpg|Casa; Atenção aos caracteres separadores: “;” (ponto e Vírgula): Deve separar o item composto por URL e NOME, que por sua vez devem ser separados por: “|” (Barra Vertical).

4 – Ações e Exemplo

O Sistema de Integração conta com as ações: Inserir Imóvel, Alterar Imóvel, Excluir Imóvel e Atualizar Fotos. Para cada ação desta será utilizado o envio de dados pelo método POST para o endereço http://imoveistriangulo.com.br/integracao/. Segue abaixo os detalhes e exemplos de cada ação:

4.1 – Inserir/Alterar o Imóvel

Para inserir um imóvel envie os dados pelo método POST para o endereço http://imoveistriangulo.com.br/integracao/gravar/. Atenção: O campo codigo será utilizado para identificar a ação de Inserir ou Alterar. Caso o codigo informado já tenha sido inserido para a imobiliária, a ação utilizada será a Alteração. Veja o Exemplo Abaixo:

Exemplo de Importação na Linguagem PHP utilizando o método Curl

$ch = curl_init(); $dados = array ( 'chave' => 'e886f026cb50c61cceab3c34c2726fc3', 'chaveSenha' => '01424fa157ae6b20587f3b4eb7095232', 'codigo' => '556', 'condicao' => '1', 'classificacao' => '1', 'categoria' => '1', 'nomeNL' => 'Loteamento Casa do Sol',

Page 12: Teste Breno

'valorVenda' => '250000.00', 'valorAluguel' => '', 'valorCondominio' => '200.50', 'areaTotal' => '250.00', 'areaPrivativa' => '175.20', 'qtdQuartos' => '3', 'qtdSuites' => '1', 'qtdBanheiros' => '2', 'qtdCarros' => '2', 'descricao' => 'Ótima Localização', 'cep' => '38010010', 'tipoLogradouro' => '4', 'logradouro' => 'Doutor Agnaldo Rocha', 'numero' => '699', 'complemento' => 'Casa 3', 'bairro' => 'Centro', 'cidade' => '40216', 'ativo' => '1', 'lancamento' => '0', 'videoYouTube' => 'http://youtu.be/kiEhPlrGKs009w', 'latitudeEnd' => '-13.7501587221', 'longitudeEnd' => '-47.93253949999996', 'imagens' => 'http://seusite.com/imagens/83.jpg|Sacada;http://seusite.com/arquivos/85.jpg|Varanda;http://seusite.com/arquivos/23.jpg|Corredor' ); curl_setopt($ch, LOPT_URL, 'http://imoveistriangulo.com.br/integracao/gravar/'); curl_setopt($ch, CURLOPT_HEADER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $dados); curl_exec($ch); curl_close($ch);

Retorno em JSON

{"statusRetorno":"1","Retorno":"Imóvel Inserido com Sucesso"}

4.2 - Consultar existência do Imóvel

Para consultar a existência do imóvel envie pelo método POST o atributo codigo para o

endereço http://imoveistriangulo.com.br/integracao/consultar/. Veja o Exemplo Abaixo:

Exemplo de Importação na Linguagem PHP utilizando o método Curl

$ch = curl_init(); $dados = array ( 'chave' => 'e886f026cb50c61cceab3c34c2726fc3',

Page 13: Teste Breno

'chaveSenha' => '01424fa157ae6b20587f3b4eb7095232', 'codigo' => '556' ); curl_setopt($ch, LOPT_URL, 'http://imoveistriangulo.com.br/integracao/consultar/'); curl_setopt($ch, CURLOPT_HEADER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $dados); curl_exec($ch); curl_close($ch);

Retorno em JSON

{"statusRetorno":"1","Retorno":"Imóvel Encontrado"}

4.3 - Excluir Imóvel

Para excluir um imóvel envie pelo método POST o atributo codigo para o endereço

http://imoveistriangulo.com.br/integracao/excluir/. Veja o Exemplo Abaixo:

Exemplo de Importação na Linguagem PHP utilizando o método Curl

$ch = curl_init(); $dados = array ( 'chave' => 'e886f026cb50c61cceab3c34c2726fc3', 'chaveSenha' => '01424fa157ae6b20587f3b4eb7095232', 'codigo' => '556' ); curl_setopt($ch, LOPT_URL, 'http://imoveistriangulo.com.br/integracao/excluir/'); curl_setopt($ch, CURLOPT_HEADER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $dados); curl_exec($ch); curl_close($ch);

Retorno em JSON

{"statusRetorno":"1","Retorno":"Imóvel Excluido"}

Page 14: Teste Breno

4.3 – Atualizar Imagens

Para somente atualizar as imagens de um imóvel envie pelo método POST os atributos codigo

e imagens para o endereço http://imoveistriangulo.com.br/integracao/ImagensAtualizar/.

Veja o Exemplo Abaixo:

Exemplo de Importação na Linguagem PHP utilizando o método Curl

$ch = curl_init(); $dados = array ( 'chave' => 'e886f026cb50c61cceab3c34c2726fc3', 'chaveSenha' => '01424fa157ae6b20587f3b4eb7095232', 'codigo' => '556', 'imagens' => 'http://seusite.com/imagens/83.jpg|Sacada;http://seusite.com/arquivos/85.jpg|Varanda;http://seusite.com/arquivos/23.jpg|Corredor' ); curl_setopt($ch, LOPT_URL, 'http://imoveistriangulo.com.br/integracao/ImagensAtualizar/'); curl_setopt($ch, CURLOPT_HEADER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $dados); curl_exec($ch); curl_close($ch);

Retorno em JSON

{"statusRetorno":"1","Retorno":"Imagens Atualizadas"}