3. Modelos de anúncios da API

En esta página

Esta seção detalha as estruturas de dados e os endpoints da API que ajudarão você a obter os valores e catálogos necessários para construí-los corretamente.

Modelo de anúncios de Classificados

Um anúncio classificado representa uma propriedade individual (ex.: uma casa).

Campo	Descrição	Obrigatório / Sugerido
codigoAviso	Seu identificador único para o anúncio.	Solicitado
titulo	Título do anúncio (máx. 80 caracteres).	Solicitado
descripcion	Descrição detalhada da propriedade (mín. 50 caracteres).	Solicitado
publicador	Objeto com a informação de contato da imobiliária.	Solicitado
publicacion	Objeto que define o plano de publicação a ser utilizado.	Solicitado
tipoDePropiedad	Objeto que define o tipo e subtipo da propriedade usando IDs.	Solicitado
localizacion	Objeto com a informação da localização da propriedade.	Solicitado
precios	Array de objetos, cada um definindo uma operação e seu preço.	Solicitado
características	Array de objetos com os atributos da propriedade.	Solicitado
multimedia	Objeto que contém arrays para imagens, planos, vídeos, etc.	Solicitado
planos	Incluir ao menos um plano em multimedia.planos é sugerido para evitar o warning WARN-0207.	Sugerido
Características	Incluir SUPERFICIE_TOTAL, MEDIO_BANO e GARAGE é sugerido para evitar warnings.	Sugerido

Modelo de imóvel novo e anúncios de unidade

Um imóvel novo é um anúncio que agrupa vários anúncios chamados unidades(por exemplo, um edifício com apartamentos). O modelo de imóvel novo compartilha os campos de um anúncio classificado e adiciona o seguinte:

Campo	Descrição	Obrigatório
unidades	Matriz contendo as notificações para cada unidade. A matriz completa deve sempre ser enviada ao fazer uma modificação.	Solicitado
etapaDesarrollo	ID que indica a fase do projeto (ex.: "Pré-venda").	Solicitado
fechaEntrega	Data estimada em que o empreendimento será concluído.	Opcional
urlLogo	URL da construtora ou logotipo do projeto.	Opcional

Modelo de unidade

Importante: o codigoAviso de cada unidade deve ser único em todo o sistema.

Importante: el codigoAviso de cada unidad debe ser único en todo el sistema.
Recomendação: recomenda-se enviar todos os campos completos para cada unidade, mesmo se compartilhar dados com o anúncio de imóvel novo (como a localizacion) para assegurar a correta indexação.

Endpoints de catálogo e suporte

Localizações

As localizações estão organizadas em uma hierarquia de árvore. Para obter a idUbicacion final (ex.: uma cidade ou bairro), você tem que navegar do nível superior até o inferior realizando chamadas consecutivas.

Obter nível superior: para obter a lista de localizações do primeiro nível (ex.: Estados/Províncias) use:

GET /v1/ubicaciones

Obter seguintes níveis: pegue o id da localização desejada do passo anterior e use-o para consultar o seguinte nível com

**GET /v1/ubicaciones/{id}.**

Repetir: repita o passo 2 com os novos IDs obtidos até chegar ao nível mais baixo requerido para o anúncio.

Outros catálogos

Propriedades e características:

GET /v1/tipopropiedades e GET /v1/tipopropiedades/desarrollos

GET /v1/tipopropiedades/{id}/subtipos

GET /v1/tipopropiedades/{id}/caracteristicas

Publicação e operações:
Multimedia e imóvel novos:

Informação de campos

Use estes endpoints para obter metadados e descrições detalhadas de cada campo dos modelos, como complemento a esta documentação.

GET /v1/informacion/aviso/{campo}

GET /v1/informacion/desarrollo/{campo}