API Site Parceiro - Documentação Oficial

Integre facilmente com a API do Gestor Imobiliária para acessar dados de imóveis públicos.

---

🌐 Base URL

https://api-site-parceiro.gestorimob.com.br

🔒 Autenticação

Para consumir a API, é necessário obter um ClientID e um SecretID junto à Imobiliária. Solicite suas credenciais no painel de Chaves de API do Gestor Imobiliária.

1. Obtenha seu ClientID e SecretID

Entre em contato com a Imobiliária para receber suas credenciais de acesso.

2. Gere o Access Token

Faça uma requisição POST para o endpoint:

POST /accesstoken

Exemplo de Requisição

curl --request POST \
  --url https://api-site-parceiro.gestorimob.com.br/accesstoken \
  --data '{
    "clientID":"ab4432e6-1f5d-4a06-b4c5-09893c374b16",
    "secretID":"59882a7c-7774-4eb7-b5a0-87d1f70e68c6"
  }'

Exemplo de Resposta

{
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJhcGktc2l0ZS1wYXJjZWlybyIsImF1ZCI6ImFwaS1zaXRlLXBhcmNlaXJvIiwiaWF0IjoxNzU3NTIyNDc4LCJuYmYiOjE3NTc1MjI0NzgsImV4cCI6MTc1NzUyMjc3OCwiY2xpZW50SUQiOiJhYjQ0MzJlNi0xZjVkLTRhMDYtYjRjNS0wOTg5M2MzNzRiMTYifQ.Z_2dovre-7GkVFTRtsW72h-zZv3xKVkLE7QMgaJQapU",
  "token_type": "Bearer",
  "expires_in": 1757522778
}

3. Use o Access Token

Inclua o token no header Authorization de todas as requisições:

Authorization: Bearer {access_token}

---

📚 Endpoints Principais

Listar Imóveis Públicos

• Endpoint:

  GET /imoveis
  

• Descrição: Retorna a lista de imóveis públicos disponíveis com paginação.
• Headers:
  • Authorization: Bearer {access_token}
  • Content-Type: application/json
• Parâmetros Opcionais:
  • page: Número da página (padrão: 1)
  • per_page: Itens por página (padrão: 10)

Exemplo de Requisição

curl --request GET \
  --url "https://api-site-parceiro.gestorimob.com.br/imoveis" \
  --header "Authorization: Bearer {access_token}" \
  --header "Content-Type: application/json"

Exemplo de Resposta

{
  "status": "success",
  "data": {
    "imoveis": [
      {
        "codigo": "14786",
        "tipo": {
          "codigo": "4",
          "nome": "Apartamento",
          "descricao": "Apartamentos",
          "acaoCodigo": "2"
        },
        "acao": {
          "codigo": "2",
          "nome": "Vende-se",
          "descricao": "Vende-se imóveis"
        },
        "valor": 500000,
        "valorFormatado": "500.000,00",
        "descricao": "Vende-se aparatmento com linda vista ara cidade - Próximo a escola",
        "enderecoCompleto": "Rua Felicio, 10, Ap 801, Centro, Marau/Rio Grande do Sul, 99150-000",
        "linkImagemPrincipal": "https://img.sis.gestorimob.com.br/1/imoveis/thumb/741921764852918759.webp",
        "detalhes": []
      }
    ],
    "_links": {
      "self": {
        "href": "http://localhost:8080/imoveis?page=1&per_page=10",
        "title": "Listagem de imóveis - página 1",
        "type": "application/json"
      },
      "next": {
        "href": "http://localhost:8080/imoveis?page=2&per_page=10",
        "title": "Próxima página",
        "type": "application/json"
      },
      "prev": null
    }
  },
  "meta": {
    "timestamp": "2025-09-10T16:41:35Z",
    "total": 28,
    "page": 1,
    "per_page": 10,
    "total_pages": 3
  }
}

---

Detalhes de um Imóvel

• Endpoint:

  GET /imoveis?id={id}
  

• Descrição: Retorna informações detalhadas de um imóvel específico, incluindo todas as imagens.
• Headers:
  • Authorization: Bearer {access_token}
  • Content-Type: application/json
• Parâmetros:
  • id: ID do imóvel desejado (obrigatório)

Exemplo de Requisição

curl --request GET \
  --url "https://api-site-parceiro.gestorimob.com.br/imoveis?id=14786" \
  --header "Authorization: Bearer {access_token}" \
  --header "Content-Type: application/json"

Exemplo de Resposta

{
  "status": "success",
  "data": {
    "imovel": {
      "codigo": "14786",
      "tipo": {
        "codigo": "4",
        "nome": "Apartamento",
        "descricao": "Apartamentos"
      },
      "acao": {
        "codigo": "2",
        "nome": "Vende-se",
        "descricao": "Vende-se imóveis"
      },
      "valor": 500000,
      "valorFormatado": "500.000,00",
      "descricao": "Vende-se aparatmento com linda vista ara cidade - Próximo a escola",
      "enderecoCompleto": "",
      "enderecoCEP": "99150-000",
      "enderecoLogradouro": "Rua Felicio",
      "linkImagemPrincipal": "https://img.sis.gestorimob.com.br/1/imoveis/thumb/741921764852918759.webp",
      "detalhes": [],
      "publicarNoSite": false,
      "imagens": [
        {
          "ordem": 1757446529,
          "link": "https://img.sis.gestorimob.com.br/1/imoveis/741921764852918759.webp",
          "legenda": ""
        }
      ]
    },
    "_links": {
      "self": {
        "href": "http://localhost:8080/imovel?id=14786",
        "title": "Informação do imóvel",
        "type": "application/json"
      }
    }
  },
  "meta": {
    "timestamp": "2025-09-10T16:41:55Z"
  }
}

---

🚀 Boas Práticas

• Sempre utilize HTTPS para garantir a segurança dos dados.
• O token de acesso possui validade. Solicite um novo token quando necessário.
• Não compartilhe seu ClientID e SecretID publicamente.
• A API retorna respostas paginadas para listagens. Use os parâmetros page e per_page para navegar pelos resultados.
• Utilize os links na resposta (_links) para navegação entre páginas.

---

📋 Estrutura de Resposta

Resposta Padrão

Todas as respostas seguem o padrão:

{
  "status": "success|error",
  "data": {
    // dados específicos do endpoint
  },
  "meta": {
    "timestamp": "2025-09-10T16:41:35Z",
    // metadados adicionais como paginação
  }
}

Paginação

Para endpoints que retornam listas, a resposta inclui:

• meta.total: Total de registros
• meta.page: Página atual
• meta.per_page: Itens por página
• meta.total_pages: Total de páginas
• _links: Links para navegação (self, next, prev)

---

💬 Suporte

Em caso de dúvidas, entre em contato com a Imobiliária responsável ou abra uma issue neste repositório.

---

Feito com ❤️ para facilitar sua integração!