Credenciais de API usadas em integrações para o consumo de catálogo de imóveis da Órulo têm permissões especiais que para acessar apenas com o oruloClientAuth diversos endpoints que seriam de outra forma restritos ao oruloEndUserAuth.

Apenas as informações abaixo continuam restritas aos tokens obtidos através da autenticação oruloEndUserAuth.

Sugerimos que todos esses dados restritos sejam sempre abastecidos em tempo real para o corretor quando ele consulta a ficha do imóvel, ao invés de sincronizados localmente com o restante das informações.

Detalhes de promoções e premiações

As informações aparecem no endpoint /buildings/{buildingId}, sob o objeto opportunity.

client significa uma promoção para o comprador. Se ele comprar uma unidade, ganha algo.

broker significa uma premiação para o corretor. Se ele vende uma ou mais unidades, ganha algo ou concorre a algo.

Se consultado com um token oruloClientAuth, aparece da seguinte forma:

"opportunity": {
    "broker": true,
    "client": true,
    "exchange_units": false
},

Se consultado com o token oruloEndUserAuth, aparece da seguinte forma:

"opportunity": {
    "broker": true,
    "broker_description": "Campanha Cyrela Welcome! Além das margens de negociação, 1% de...",
    "broker_expiration_date": "30/12/2019",
    "client": true,
    "client_description": "Campanha Cyrela Welcome! Além das margens de negociação, seu cliente ainda...",
    "client_max_discount": 7,
    "client_expiration_date": "30/12/2019",
    "exchange_units": false
},

Percentual de comissão

As informações aparecem no endpoint /buildings/{buildingId}, sob o objeto commercial_contacts, com o nome real_estate_agency_commission.

Contatos comerciais do anunciante

O {contactId} do contato comercial é obtido no endpoint /buildings/{buildingId}, sob o objeto commercial_contacts, com o nome id.

Depois disso, deve ser consultado o endpoint /buildings/{buildingId}/commercial_contacts/{contactId} para obter os dados de contato.

Arquivos

Os {fileId} são obtidos no endpoint /buildings/{buildingId}, no objeto files, com o nome de id.

A URI de cada arquivo é obtida em /buildings/{buildingId}/files/{fileId}.