API Imoblist

A API da Imoblist é baseada no padrão RESTful com uma variante chamada BREAD (Browse, Read, Edit, Add, Delete), simplificando o gerenciamento de dados.

Ela permite a integração com recursos como imóveis, contas, leads, usuários e clientes.

Estrutura das Rotas

https://app.imoblist.com/{action}/{method}/{token}

• ACTION: entidade ou funcionalidade (ex: Realestate, Lead, Account)
• METHOD: operação a ser realizada (Browse, Read, Edit, Add, Delete)
• TOKEN: token de validação fornecido pela equipe Imoblist

Autenticação

Requisições para rotas restritas exigem login via POST /auth/login. O payload pode conter e-mail ou telefone, e senha.

{
  "email": "[email protected]",
  "phone": "1234567890",
  "password": "mypassword"
}

Token JWT é retornado em caso de sucesso e deve ser enviado no header como:

Authorization: Bearer {token}

Resposta de sucesso

{
  "success": true,
  "message": "Authentication successful.",
  "data": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

Resposta de erro

{
  "success": false,
  "error": "These credentials do not match our records."
}

Códigos de Status HTTP

Código	Descrição
200	OK - Solicitação bem-sucedida
201	Criado - Registro criado com sucesso
204	Sem Conteúdo - Nenhum dado retornado
400	Solicitação inválida
401	Não autorizado
403	Acesso negado
404	Recurso não encontrado
500	Erro interno do servidor

Token

O token de validação é exclusivo por cliente e fornecido sob demanda. Todas as requisições devem incluir o token na URL ou no header.

Logs de uso são registrados e monitorados para maior segurança.

Filtros

É possível aplicar filtros nas requisições usando JSON:

{
  "campo1": "valor1",
  "campo2": {
    "clause": "orWhere",
    "operator": "=",
    "value": "valor2"
  },
  "campo3": {
    "clause": "whereBetween",
    "value": ["2023-01-01", "2023-12-31"]
  }
}

---

Se desejar adicionar os métodos (Browse, Read, etc) ou entidades (como Realestate, Lead), posso incluir essas seções também.