VISTA SOFTWARE E INTERNET

Transcrição

1 RQV_035-Integração dos imóveis no Website ver2_rev00 INTEGRAÇÃO DOS IMÓVEIS NO WEBSITE GESTÃO PARA A QUALIDADE TOTAL VISTA SOFTWARE E INTERNET Integração dos imóveis no WebSite Sistema de Gestão da Qualidade Vista Software e Internet Ltda.

2 RQV_004-Integração dos imóveis no Website_rev00 Sumário 1.Conceito Estrutural Acesso ao Servidor SOAP Métodos e Parâmetros Especificações de Consulta Busca de Imóveis Fotos Listagens para Buscas Origem de dados Dados Estáticos Dados Dinâmicos

3 RQV_035-Integração dos imóveis no Website ver2_rev00 INTEGRAÇÃO DOS IMÓVEIS NO WEBSITE GESTÃO PARA A QUALIDADE TOTAL 1. Conceito estrutural A integração dos sistemas Vista.Office e Vista.Broker com o Website da imobiliária é realizado através de WebService, utilizando o protocolo SOAP, conforme estabelecido pelo W3C. As especificações do protocolo SOAP podem ser encontradas em: 2. Acesso ao servidor SOAP URI: Endereço do SOAP Location: Chave da requisição: O desenvolvedor deve solicitar à equipe técnica da Vista a chave de utilização do SOAP da imobiliária em questão. Esta chave irá identificar a imobiliária para retornar os dados solicitados. 3. Métodos e Parâmetros A requisição deve conter os parâmetros básicos para a interpretação da consulta. Parâmetro: Key String: Deve conter a Chave da Imobiliária, solicitada previamente à equipe técnica da Vista. Esta chave faz a identificação de qual imobiliária devem ser consultados os dados. Parâmetro: module String: É o módulo de consulta. Na integração de websites, deve SEMPRE conter a string imoveis. Sistema de Gestão da Qualidade Vista Software e Internet Ltda.

4 RQV_004-Integração dos imóveis no Website_rev00 Parâmetro: method String: Este parâmetro é o identificador de tipo de consulta. Cada consulta possui uma string específica que deve ser informada neste parâmetro. A especificação detalhada deste parâmetro encontra-se neste documento em 3.1. Especificações de Consultas. Parâmetro: field Array: Neste parâmetro deve-se especificar a lista de campos a serem consultados. Como valores, podem ser especificados rótulos para os campos. Para informações dos nomes de campos, consulte 4. Origem de Dados deste documento. Parâmetro: return String: Determina o tipo de retorno da consulta. Os tipos de retorno estão especificados neste documento nas definições de retorno. Por padrão, o retorno é em formato array Especificações de Consultas Para cada tipo de consulta, deve ser informado o parâmetro method que identifique a solicitação Busca de Imóveis Parâmetro: method = busca_imoveis Este método retorna um ou mais imóveis. Para especificar quais informações dos imóveis devem retornar, devem ser informados os campos no parâmetro field. Os seguintes parâmetros podem ser informados na consulta: Parâmetro: order Array: Podem ser especificadas quais informações devem ser ordenadas, com os valores ASC para ascendente e DESC para descendente. Parâmetro: limit String: Pode ser especificado o limite de resultados, podendo ser um valor numérico simples ou paginação. Para paginação, deve-se utilizar o formato x,y, onde x é o número do registro e y é o limite de registros. Parâmetro: filter Array: Podem ser especificados filtros de pesquisa para as consultas.

5 Exemplos: RQV_035-Integração dos imóveis no Website ver2_rev00 INTEGRAÇÃO DOS IMÓVEIS NO WEBSITE GESTÃO PARA A QUALIDADE TOTAL Exemplo de consulta em php: $array = array 'key' => 'a197a1cbe24bb2895d7ffada57fb856d', 'module' =>'imoveis', 'method' => 'busca_imoveis', 'field' => array 'CODIGO' => 'Codigo', 'CATEGORIA' => 'Categoria', 'VLR_VENDA' => 'Valor', 'CIDADE' => 'Cidade', 'BAIRRO' => 'Bairro', 'DORMITORIO' => 'Dormitorios', 'VAGAS' => 'Numero Vagas', 'IMAGEM_G' => 'Foto', 'URL_FOTO' => 'Url', 'DESCRICAO' => 'Descricao' ; $client = new SoapClientnull, array 'uri' => ' 'location' => ' 'trace' => 'trace' ; $array['order'] = array'vlr_venda' => 'DESC'; $array['limit'] = '0,10'; $res = $client->get$array; Exemplo de um dump do retorno em array php: Array [0] => Array [Codigo] => 875 [Categoria] => Apartamento [Valor] => [Cidade] => São Paulo [Bairro] => Paraíso [Dormitorios] => 1 [Foto] => i_8357_875_6c7f2.jpg [Url] => [Descricao] => [1] => Array [Codigo] => 773 [Categoria] => Apartamento [Valor] => [Cidade] => São Paulo [Bairro] => Vila Mascote [Dormitorios] => 3 Sistema de Gestão da Qualidade Vista Software e Internet Ltda.

6 RQV_004-Integração dos imóveis no Website_rev00 [Foto] => i_8784_773_19b78.jpg [Url] => [Descricao] => Apartamento Novo 110 m² / 3 Dormitórios sendo 1 Suíte / home office / lavabo / Rico em Armários / 2 Vagas de Garagem [total_registros] => 2 Exemplo de retorno em XML: <soap> <registro linha="0"> <Codigo >875</Codigo> <Categoria>Apartamento</Categoria> <Valor>550000</Valor> <Cidade>São Paulo</Cidade> <Bairro>Paraíso</Bairro> <Dormitorios></Dormitorios> <Foto>i_8357_875_6c7f2.jpg</Foto> <Url> <Descricao/> </registro> <registro linha="1"> <Codigo>773</Codigo> <Categoria>Apartamento</Categoria> <Valor>735000</Valor> <Cidade>São Paulo</Cidade> <Bairro>Vila Mascote</Bairro> <Dormitorios>3</Dormitorios> <Foto>i_8784_773_19b78.jpg</Foto> <Url> <Descricao>Apartamento Novo 110 m² / 3 Dormitórios sendo 1 Suíte / home office / lavabo / Rico em Armários / 2 Vagas de Garagem</Descricao> </registro> <total_registros>2</total_registros> </soap> Fotos Parâmetro: method = busca_fotos Este método retorna os registros das fotos dos imóveis. Para especificar quais informações dos imóveis devem retornar, devem ser informados os campos no parâmetro field. Os seguintes parâmetros podem ser informados na consulta:

7 RQV_035-Integração dos imóveis no Website ver2_rev00 INTEGRAÇÃO DOS IMÓVEIS NO WEBSITE GESTÃO PARA A QUALIDADE TOTAL Parâmetro: order Array: Podem ser especificadas quais informações devem ser ordenadas, com os valores ASC para ascendente e DESC para descendente. Parâmetro: filter Array: Podem ser especificados filtros de pesquisa para as consultas. Exemplos: Exemplo de consulta em php: $array = array 'key' => 'a197a1cbe24bb2895d7ffada57fb856d', 'module' =>'imoveis', 'method' => 'busca_fotos', 'field' => array 'CODIGO' => 'Codigo', 'IMAGEM_G' => 'Foto', 'IMAGEM_P' => 'Thumbnail', 'URL_FOTO' => 'Url', 'DESCRICAO' => 'Descricao', 'filter' => array 'CODIGO' => 875, ; $client = new SoapClientnull, array 'uri' => ' 'location' => ' 'trace' => 'trace' ; $res = $client->get$array; Exemplo de dump de retorno em array php: Array [0] => Array [Codigo] => 875 [Foto] => i_8357_875_6c7f2.jpg [Thumbnail] => i_8357_875_6c7f2p.jpg [Url] => [Descricao] => [total_registros] => 1 Sistema de Gestão da Qualidade Vista Software e Internet Ltda.

8 RQV_004-Integração dos imóveis no Website_rev00 Exemplo de retorno em XML: <soap> <registro linha="0"> <Codigo >875</Codigo> <Foto>i_8357_875_6c7f2.jpg</Foto> <Thumbnail>i_8357_875_6c7f2p.jpg</Valor> <Url> <Descricao/> </registro> <total_registros>1</total_registros> </soap> Listagens para Buscas Parâmetro: method = lista_itens_filtro Este método retorna uma lista distinta do conteúdo de um campo para utilização em buscas. Para especificar qual campo deverá ser consultado, deve-se informar no parâmetro field. Os seguintes parâmetros podem ser informados na consulta: Parâmetro: filter Array: Podem ser especificados filtros de pesquisa para as consultas. Exemplos: Exemplo de consulta em php: $array = array 'key' => 'a197a1cbe24bb2895d7ffada57fb856d', 'module' =>'imoveis', 'method' => 'lista_itens_filtro', 'field' => 'BAIRRO', 'filter' => array 'CIDADE' => 'São Paulo', ; $client = new SoapClientnull, array 'uri' => ' 'location' => ' 'trace' => 'trace' ; $res = $client->get$array;

9 RQV_035-Integração dos imóveis no Website ver2_rev00 INTEGRAÇÃO DOS IMÓVEIS NO WEBSITE GESTÃO PARA A QUALIDADE TOTAL Exemplo de dump de retorno em array php: Array [0] => brooklin, [1] => Campo Belo, [2] => Campo Grande, [3] => Casa Verde, [4] => Cerqueira Cezar, [5] => Cidade Ademar, [6] => Jaçana, [7] => Jardim França, [8] => Jardim Marajoara, [9] => Jardim Prudência [total_registros] => 9 Exemplo de retorno em XML: <soap> <registro linha="0">brooklin</registro> <registro linha="1">campo Belo</registro> <registro linha="2">campo Grande</registro> <registro linha="3">casa Verde</registro> <registro linha="4">cerqueira Cezar</registro> <registro linha="5">cidade Ademar</registro> <registro linha="6">jaçana</registro> <registro linha="7">jardim França</registro> <registro linha="8">jardim Marajoara</registro> <registro linha="9">jardim Prudência</registro> <total_registros>9</total_registros> </soap> Sistema de Gestão da Qualidade Vista Software e Internet Ltda.

10 RQV_004-Integração dos imóveis no Website_rev00 4. Origem de Dados Os nomes campos disponíveis para integração com o Website da imobiliária devem ser obtidos através do método listar_origens especificado neste documento em Listagem de Origem de Dados. Esta listagem é dinâmica, sendo distinta entre as imobiliárias. Algumas informações são de origem estática. Esta lista está descrita neste documento em Dados Estáticos Especificações de Origem de Dados Dados Estáticos Os dados de origem estática são acessados através de uma string chave, que é fixo na integração e não é necessário efetuar uma requisição para obter as origens. Cada string obtém um dado específico do imóvel. Origem: IMAGEM_G Informando esta origem, retorna como conteúdo o nome do arquivo da imagem grande do imóvel. Para o caminho completo, é necessário concatenar com a origem URL_FOTO. Origem: IMAGEM_P Informando esta origem, retorna como conteúdo o nome do arquivo da imagem thumbnail do imóvel. Para o caminho completo, é necessário concatenar com a origem URL_FOTO. Origem: URL_FOTO Informando esta origem, retorna a URL que contém o diretório das imagens. Origem: CATEGORIA Esta origem retorna a categoria do imóvel ex: Apartamento. Origem: CODIGO Esta origem retorna o código seqüencial do imóvel. A imobiliária deve ser consultada para que seja certificado de que, em seu procedimento, a mesma não utiliza um código manual para divulgação em mídias.

11 RQV_035-Integração dos imóveis no Website ver2_rev00 INTEGRAÇÃO DOS IMÓVEIS NO WEBSITE GESTÃO PARA A QUALIDADE TOTAL Origem: PLACA Em caso de imobiliárias que utilizam código manual para divulgação em mídias, esta origem irá obter esta informação. Origem: CORRETOR Esta origem obtém os nomes dos corretores que agenciam o imóvel. Os nomes são separados por vírgula. Origem: AGENCIA Esta origem retorna o nome da agência do imóvel Listagem de Origem de Dados Parâmetro: method = listar_origens String: Este método retorna uma lista de origens de dados disponíveis campos com sua respectiva descrição e tipo. Exemplo de consulta em php: $array = array 'key' => 'a197a1cbe24bb2895d7ffada57fb856d', 'module' =>'imoveis', 'method' => listar_origens' ; $client = new SoapClientnull, array 'uri' => ' 'location' => ' 'trace' => 'trace' ; $res = $client->get$array; Exemplo de dump de retorno em array php: Array [0] => array 'field' => LIVING_LAREIRA, 'description' => Lareira, 'type' => Checagem Sim/Nao [1] => array 'field' => APTOS_ANDAR, 'description' => Aptos por Andar, Sistema de Gestão da Qualidade Vista Software e Internet Ltda.

12 RQV_004-Integração dos imóveis no Website_rev00 'type' => Numero inteiro [total_registros] => 2 Exemplo de retorno em XML: <soap> <registro linha="0"> <field>living_lareira</field> <description>lareira</description> <type>checagem Sim/Nao</type> </registro> <registro linha="1"> <field>aptos_andar</field> <description>aptos por Andar</description> <type>numero inteiro</type> </registro> </soap>