Detalhes da imobiliária
Retorna os dados públicos de uma imobiliária (real estate agency): nome, site e identidade visual. Envie o token de acesso como Bearer no cabeçalho Authorization.
GET
/v1/integrations/real-estate-agencies/{id}Parâmetro de caminho
Identifique a imobiliária pelo seu real_estate_agency_id na URL.
| Campo | Tipo | Descrição |
|---|---|---|
idobrigatório | string (uuid) | O real_estate_agency_id da imobiliária. Precisa ser um id autorizado para a sua integração. |
Como descobrir o id da imobiliária
O
{id} precisa ser um real_estate_agency_id presente na claim groups do seu token, no formato /real-estate-agencies/<id>. Você não precisa fixar esses ids do seu lado: gere um token e inspecione as claims na página de autenticação para descobrir quais imobiliárias a sua integração pode consultar.Resposta
O endpoint retorna os dados públicos da imobiliária autorizada.
| Campo | Tipo | Descrição |
|---|---|---|
id | string (uuid) | Identificador da imobiliária. |
name | string | Nome de exibição da imobiliária. |
website | string | Site público da imobiliária. |
customization | object | Identidade visual da imobiliária (logo e cores de marca). |
customization.logo | string | URL do logotipo da imobiliária. |
customization.mainColor | string | Cor principal da marca, em hexadecimal. |
customization.contrastColor | string | Cor de contraste da marca, em hexadecimal. |
Erros
Códigos de erro que o endpoint pode retornar.
| Campo | Tipo | Descrição |
|---|---|---|
401 | Unauthorized | Token ausente, inválido ou expirado. |
403 | Forbidden | A imobiliária não está autorizada para esta integração. |
404 | Not Found | Imobiliária não encontrada. |
500 | Internal Server Error | Erro interno ao processar a requisição. |
503 | Service Unavailable | Serviço de autenticação indisponível no momento. |
Buscar uma imobiliária
Cole o token obtido na página de autenticação e informe o real_estate_agency_id para consultar a imobiliária ao vivo.
Experimente
Cole o token gerado na página de autenticação e o real_estate_agency_id para consultar uma imobiliária. O token vai apenas para o nosso servidor, nunca direto do navegador, e nada fica armazenado.