Cim Imob API - Imóveis para portais

URL de acesso

Através deste recurso será possível listar todos os imóveis relacionados com o aplicativo externo ou portal de imóveis.

Solicite a URL de acesso para a equipe de suporte ou para o cliente que está habilitando a integração com o Cim Imob.

GET [base_url]/apps/:external_application_id/properties?last_update=2023-04-14T16:00:00

:external_application_id	Path Variables	ID do aplicativo externo	Obrigatório
last_update	Query Params	Data da última atualização do imóvel	Opcional
page	Query Params	Página	Opcional

O sistema carrega no máximo 200 registros. Para trocar a página utilize o parâmetro ?page=2

Para escolher a data da última atualização utilize o parâmetro ?last_update=2023-01-21T00:00:00

Exemplo de URL

https://cmsapi.sistema.cim.br/apps/:external_application_id/properties?page=2?last_update=2023-01-21T00:00:00

Resposta

A URL de acesso irá retornar uma lista (array) de imóveis, conforme o modelo de dados abaixo:

No final deste artigo, você poderá visualizar um exemplo de resposta em JSON:

Dados de um imóvel

id	number	Identificação do imóvel no CMS (único em todo o sistema)
created_at	string	Data que o registro foi criado no sistema
updated_at	string	Data da última atualização
account_id	number	Identificador único do cliente no CMS
document_type	string	Tipo do documento matricula: Matrícula do imóvel iptu: Número IPTU
document_number	string	Número do documento
type	string	Veja a tabela de tipos de imóveis (property_types)
code	string	Código do imóvel para o cliente
name	string	Nome do imóvel
url	string	URL do imóvel
resume	string	Resumo do imóvel
description	string	Descrição do imóvel
bedrooms	number	Número de quartos
bathrooms	number	Número de banheiros
half_bathrooms	number	Número de lavabos
suites	number	Número de suítes
maximum_occupancy	number	Ocupação máxima do imóvel
maximum_children_occupancy	number	Ocupação máxima de crianças do imóvel
minimum_main_guest_age	number	Idade mínimo do locatário
parking_spaces	number	Número de vagas de estacionamento / garagem
kitchens	number	Número de cozinhas
living_room	number	Número de salas
floors	number	Quantidade de andares
floor	number	Andar do imóvel
elevators	number	Número de elevadores
relevance	number	Relevância do imóvel no sistema, sendo: 10 muito relevante - 0 pouco relavante
use_custom_features	boolean	Habilitar parâmetros personalizados. caso seja verdadeiro, todos os parâmetros com custom_ poderão ser preenchidos
custom_bedrooms	string?	Número de quartospersonalizado
custom_bathrooms	string?	Número de banheiros personalizado
custom_half_bathrooms	string?	Número de lavabos personalizado
custom_suites	string?	Número de suítes personalizado
custom_parking_spaces	string?	Número de vagas de estacionamento / garagem personalizado
custom_kitchens	string?	Número de cozinhas personalizado
custom_living_room	string?	Número de salas personalizado
custom_floors	string?	Número de andares personalizado
custom_floor	string?	Andar do imóvel personalizado
custom_elevators	string?	Número de elevadores personalizado
custom_total_area	string?	Área total personalizada
custom_private_area	string?	Área privativa personalizada
custom_building_area	string?	Área construída personalizada
smoking_allowed	boolean	Permitido fumar. true= permitido false= proibido
family_friendly	boolean	Amigável para familias. true= amigável false= não amigável
pets_allowed	boolean	Aceita animais de estimação true= sim false= não
parties_events_allowed	boolean	Aceita festas e eventos true= sim false= não
bedrooms_informations	object	Informações sobre os quartos
airbnb_options	object	Informações para AirBnB
year_built	number	Ano de construção do imóvel
for_rent	boolean	Imóvel para locação
for_daily_rent	boolean	Imóvel para temporada
for_sale	boolean	Imóvel para venda
average_sale_value	number	Valor médio de venda
average_rent_amount	number	Valor médio de locação
average_daily_value	number	Valor médio de diária
latitude	string	Latitude no Google Maps
longitude	string	Longitude no Google Maps
google_maps	string	Endereço no Google Maps
address_postal_code	string	CEP
address_street	string	Rua
address_number	string	Número
address_complement	string	Complemento
total_area	number	Área total
private_area	number	Área privativa
building_area	number	Área construída
rating	number	Nota de avaliação do imóvel
other_informations	object	Outras informações
exclusive	boolean	Imóvel exclusivo true= sim false= não
archived	boolean	Imóvel arquivado true= sim false= não
active	boolean	Imóvel ativo true= sim false= não
minimum_rent_days	number	Número mínimo de diárias
show_address	boolean	Exibir endereço no site? true= sim false= não
country	object	País
state	object	Estado
city	object	Cidade
neighborhood	object	Bairro
photos	photo[]	Fotos do imóvel
prices	price[]	Tabela de preços do imóvel
video	video[]	Vídeos do imóvel

Tipos de imóveis (property_types)

Os imóveis possuem nomes fixos, segue abaixo uma tabela de referência, onde o código será o que será retornado pela API

Código	Descrição
apartamento	Apartamento
casa	Casa
casa-de-condominio	Casa de condomínio
casa-geminada	Casa geminada
casa-de-vila	Casa de vila
chacara	Chácara
cobertura	Cobertura
flat	Flat
kitnet	Kitnet
studio	Studio
terreno	Terreno
sobrado	Sobrado
armazem	Armazém
box	Box
consultorio	Consultório
deposito	Depósito
fazenda	Fazenda
galpao	Galpão
comercial	Comercial
loja-comercial	Loja comercial
ponto-comercial	Ponto comercial
predio	Prédio
office	Escritório
salao	Salão
sitio	Sítio

Fotos do imóvel (photos)

O objeto photos é uma lista (array) de objetos com os seguintes dados:

id	number	Identificação da foto no CMS (único em todo o sistema)
name	string	Nome da imagem
extension	string	Extensão da imagem
size	string	Tamanho da imagem
width	string	Largura da imagem
height	string	Altura da imagem
download_url	string	Link para download da imagem
group	plants \| photos	photos - foto do imóvel plants - planta baixa do imóvel
order	number	Ordem da imagem

Foto (photo)

id	number	Identificação da foto no CMS (único em todo o sistema)
name	string	Nome da imagem
extension	string	Extensão da imagem
size	string	Tamanho da imagem
width	string	Largura da imagem
height	string	Altura da imagem
download_url	string	Link para download da imagem

Vídeo (videos)

id	number	Identificação do vídeo no CMS (único em todo o sistema)
order	number	Ordem do vídeo
name	string	Nome da vídeo
source	string	Plataforma onde o vídeo está hospedado. youtube ou vimeo
source_url	string	Link do vídeo
active	boolean	true: ativo false: inativo

Preços do imóvel - prices

Atributos

id	number	Identificação da tabela de preço no CMS (único em todo o sistema)
property_id	number	ID do imóvel
price_period_id	number	ID do período de preço (diária)
type	string	Tipo do preço (consultar tabela Type)
type_options	array	Opções do preço
description	string	Descrição de identificação do preço
value	number	Valor
percentage_value	number	Taxa percentual

Type

Os imóveis podem conter vários preços. Os preços são organizados de acordo com o parametro type.

sales	Preço de venda
daily_rent	Preço da diária padrão
rent	Preço de locação

Endereço

Country

id	number	Identificação do país no CMS (único em todo o sistema)
created_at	datetime	Data que o registro foi criado no sistema
updated_at	datetime	Data da última atualização
user_id	number	ID do usuário que criou o registro
code	string	Código do país
name	string	Nome do país
active	boolean	true: ativo false: inativo

State

id	number	Identificação do estado no CMS (único em todo o sistema)
created_at	datetime	Data que o registro foi criado no sistema
updated_at	datetime	Data da última atualização
user_id	number	ID do usuário que criou o registro
country_id	number	ID do país
code	string	Código do estado
name	string	Nome do estado
active	boolean	true: ativo false: inativo

City

id	number	Identificação da cidade no CMS (único em todo o sistema)
created_at	datetime	Data que o registro foi criado no sistema
updated_at	datetime	Data da última atualização
user_id	number	ID do usuário que criou o registro
country_id	number	ID do país
state_id	number	ID do estado
name	string	Nome da cidade
active	boolean	true: ativo false: inativo

Neighborhood

id	number	Identificação do bairro no CMS (único em todo o sistema)
created_at	datetime	Data que o registro foi criado no sistema
updated_at	datetime	Data da última atualização
user_id	number	ID do usuário que criou o registro
country_id	number	ID do país
state_id	number	ID do estado
city_id	number	ID da cidade
name	string	Nome do bairro
comments	string	Comentários / observações
active	boolean	true: ativo false: inativo

Exemplo de resposta em JSON

Veja abaixo um exemplo de resposta em JSON

{
    "properties": [
        {
            "id": 31,
            "created_at": "2022-01-06T18:28:16.000000Z",
            "updated_at": "2023-04-25T17:41:43.000000Z",
            "document_type": "matricula",
            "document_number": "123",
            "type": "apartamento",
            "code": "DEMO001",
            "name": "Apartamento mobiliado no centro ",
            "url": "apartamento-mobiliado-no-centro-demo001",
            "resume": "Este é apenas um exemplo de imóvel",
            "description": "<p>Você encontrou a casa dos seus sonhos! Imóvel para locação, com 2 dormitórios, varanda, cozinha americana planejada e área de serviço. Este é o imóvel ideal para você passas suas férias com sua família. Possui vaga de garagem coberta, piscina, salão de festas e segurança 24h.</p>\n<p>O imóvel está localiza em região nobre beira mar.  A região oferece diversas opções de serviços e lazer, como escolas, padarias, supermercado (a 2 min), shopping (a 5 min).</p>\n<p>*Todo o conteúdo deste site é meramente demonstrativo.</p>\n<p>**Imagens: Fonte Google</p>",
            "bedrooms": 3,
            "bathrooms": 4,
            "half_bathrooms": 1,
            "suites": 3,
            "maximum_occupancy": 6,
            "maximum_children_occupancy": 0,
            "minimum_main_guest_age": 18,
            "parking_spaces": 3,
            "kitchens": 1,
            "living_room": 2,
            "floors": 15,
            "floor": 0,
            "elevators": 4,
            "relevance": 5,
            "use_custom_features": false,
            "custom_bedrooms": null,
            "custom_bathrooms": null,
            "custom_half_bathrooms": null,
            "custom_suites": null,
            "custom_parking_spaces": null,
            "custom_kitchens": null,
            "custom_living_room": null,
            "custom_floors": null,
            "custom_floor": null,
            "custom_elevators": null,
            "custom_total_area": null,
            "custom_private_area": null,
            "custom_building_area": null,
            "smoking_allowed": false,
            "family_friendly": true,
            "pets_allowed": false,
            "parties_events_allowed": false,
            "bedrooms_informations": null,
            "airbnb_options": null,
            "year_built": 2019,
            "for_rent": true,
            "for_daily_rent": true,
            "for_sale": true,
            "average_sale_value": null,
            "average_rent_amount": null,
            "average_daily_value": null,
            "latitude": "-27.216235",
            "longitude": "-49.644076",
            "google_maps": "-27.216235,-49.644076",
            "address_postal_code": "89160000",
            "address_street": "Alameda Aristiliano Ramos",
            "address_number": "123",
            "address_complement": null,
            "total_area": "256",
            "private_area": "123",
            "building_area": "256",
            "rating": null,
            "other_informations": null,
            "exclusive": true,
            "archived": false,
            "active": true,
            "minimum_rent_days": 2,
            "show_address": true,
            "country": {
                "id": 1,
                "created_at": "2021-05-24T21:48:28.000000Z",
                "updated_at": "2021-05-24T21:48:28.000000Z",
                "user_id": 1,
                "code": "br",
                "name": "Brasil",
                "active": true
            },
            "state": {
                "id": 24,
                "created_at": "2021-05-24T21:48:28.000000Z",
                "updated_at": "2021-05-24T21:48:28.000000Z",
                "user_id": 1,
                "country_id": 1,
                "code": "SC",
                "name": "Santa Catarina",
                "active": true
            },
            "city": {
                "id": 4571,
                "created_at": "2021-05-24T21:48:28.000000Z",
                "updated_at": "2021-05-24T21:48:28.000000Z",
                "user_id": 1,
                "country_id": 1,
                "state_id": 24,
                "name": "Rio do Sul",
                "active": true
            },
            "neighborhood": {
                "id": 24,
                "created_at": "2022-11-04T14:39:44.000000Z",
                "updated_at": "2022-11-04T14:39:44.000000Z",
                "user_id": 9,
                "country_id": 1,
                "state_id": 24,
                "city_id": 4571,
                "name": "Centro",
                "comments": null,
                "active": true
            },
            "prices": [
                {
                    "id": 35,
                    "property_id": 31,
                    "price_period_id": null,
                    "type": "daily_rent",
                    "type_options": null,
                    "description": "Valor padrão para temporada",
                    "value": "500",
                    "percentage_value": "0"
                },
                {
                    "id": 970,
                    "property_id": 31,
                    "price_period_id": null,
                    "type": "sales",
                    "type_options": null,
                    "description": "Venda",
                    "value": "3500000",
                    "percentage_value": "0"
                },
                {
                    "id": 6792,
                    "property_id": 31,
                    "price_period_id": null,
                    "type": "rent",
                    "type_options": null,
                    "description": "Aluguel Mensal",
                    "value": "2000",
                    "percentage_value": "0"
                }
            ],
            "photo": {
                "id": 20820,
                "name": "Cozinha - frente.jpeg",
                "extension": "jpeg",
                "size": "272858",
                "width": "1920",
                "height": "1280",
                "download_url": "https://cmsapi.sistema.cim.br/file/SYPtQNQOpCMMX6opRobkPZWE/download"
            },
            "photos": [
                {
                    "id": 9496,
                    "name": "Planta-Baixa-de-Casas-4.jpeg",
                    "extension": "jpeg",
                    "size": "395005",
                    "width": "2000",
                    "height": "1366",
                    "download_url": "https://cmsapi.sistema.cim.br/file/E76TQndtE56fW6oeUhwNwoBZ/download",
                    "group": "plants",
                    "order": 0
                },
                {
                    "id": 20821,
                    "name": "Quarto 2.jpeg",
                    "extension": "jpeg",
                    "size": "352817",
                    "width": "1920",
                    "height": "1280",
                    "download_url": "https://cmsapi.sistema.cim.br/file/hylfgzPzOd15OGBfVWI5PKuG/download",
                    "group": "photos",
                    "order": 1
                },
                {
                    "id": 20825,
                    "name": "Sala de estar.jpeg",
                    "extension": "jpeg",
                    "size": "549024",
                    "width": "1920",
                    "height": "1406",
                    "download_url": "https://cmsapi.sistema.cim.br/file/p90N8TZQ5avomL1nEdBLe1i2/download",
                    "group": "photos",
                    "order": 0
                },
                {
                    "id": 20820,
                    "name": "Cozinha - frente.jpeg",
                    "extension": "jpeg",
                    "size": "272858",
                    "width": "1920",
                    "height": "1280",
                    "download_url": "https://cmsapi.sistema.cim.br/file/SYPtQNQOpCMMX6opRobkPZWE/download",
                    "group": "photos",
                    "order": 2
                },
                {
                    "id": 20815,
                    "name": "Cozinha - vista escada.jpeg",
                    "extension": "jpeg",
                    "size": "92468",
                    "width": "720",
                    "height": "1080",
                    "download_url": "https://cmsapi.sistema.cim.br/file/O9cdlpvHvYwwWGgu9mmRujSy/download",
                    "group": "photos",
                    "order": 3
                }
            ],
            "videos": [
                {
                    "id": 5,
                    "order": 1,
                    "name": "Exemplo de vídeo",
                    "source": "youtube",
                    "source_url": "https://www.youtube.com/watch?v=utGWeIrR7Ws",
                    "active": true
                }
            ]
        }
    ],
    "page": 1
}