API Reference

Imoback Public API

🔗Base URLhttps://app.imoback.com.br

🔒AuthBearer Token

📦FormatoJSON / UTF-8

Sobre a API

A Imoback API oferece acesso estruturado a registros temporais do ecossistema imobiliário. Parceiros integrados podem consultar categorias de eventos associadas a um identificador de referência, de forma segura, rastréavel e autenticada por token.

🔒

Acesso controlado

Todas as requisições exigem token exclusivo por parceiro.

📋

Registros categorizados

Eventos agrupados em categorias padronizadas e estáveis.

🔗

Integração simples

REST + JSON, compatível com qualquer stack moderna.

Documentação Completa — Área Restrita

Esta página apresenta uma visão pública e resumida. A documentação completa — incluindo todos os endpoints, webhooks, parâmetros avançados e exemplos de integração — está disponível no portal privado para parceiros.

contato@imoback.com (11) 99510-6368

Autenticação

Todas as rotas autenticadas exigem o header Authorization com um Bearer token válido fornecido pelo administrador Imoback.

Header HTTP

Authorization: Bearer imobk_sua_chave_aqui

ACTIVE

Token válido e em uso.

INACTIVE

Desativado temporariamente pelo admin.

REVOKED

Revogado permanentemente.

Erros comuns de autenticação

401

Token ausente ou header malformado

{"error":"Autenticação necessária."}

401

Token inválido

{"error":"Token não encontrado"}

401

Token revogado

{"error":"Token revogado"}

401

Token expirado

{"error":"Token expirado"}

Inquilinos

GET/api/v1/tenants/{tenant_id}/timeline

Consulta de registros temporais estruturados do ecossistema imobiliário. Retorna eventos categorizados associados ao identificador de referência do inquilino na plataforma.

Autenticação obrigatória

Inclua o header Authorization: Bearer <token> em todas as requisições.

Parâmetros

tenant_idstringpathobrigatório

Identificador de referência do inquilino na plataforma.

Exemplo: tnt_01HXYZ

Authorizationstringheaderobrigatório

Bearer token de autenticação fornecido pelo administrador Imoback.

Exemplo: Bearer imobk_abc123...

Respostas

JSON

{
  "tenant_id": "tnt_01HXYZ",
  "reference_id": "ref_8c2b1d7a3f9e",
  "total": 3,
  "records": [
    {
      "id": "evt_01HXYZ",
      "category": "PAYMENT_EVENT",
      "recorded_at": "2024-11-05T10:30:00.000Z",
      "reference": {
        "contract_id": "ctr_01HXYZ"
      }
    }
  ]
}

Testar agora

Token de Autenticação *

tenant_id *

Código de Exemplo

cURL

curl -X GET "https://app.imoback.com.br/api/v1/tenants/tnt_01HXYZ/timeline" \
  -H "Authorization: Bearer imobk_seu_token_aqui" \
  -H "Content-Type: application/json"

Categorias de Evento

O campo category em cada registro retorna uma das seguintes categorias padronizadas:

Categoria	Descrição
`PAYMENT_EVENT`	Registro relacionado a cobranças e pagamentos do período de locação.
`CONTRACT_EVENT`	Registro relacionado ao ciclo de vida de um contrato de locação.
`PROPERTY_EVENT`	Registro relacionado ao estado ou devolução de um imóvel.
`LEGAL_EVENT`	Registro relacionado a procedimentos legais ou acordos formais.

💡 Detalhes internos de cada categoria (subcategorias, metadados e filtros avançados) estão disponíveis apenas na documentação do portal privado.

Referência de Erros

Todos os erros retornam um objeto JSON com o campo error.

Status	Descrição	Como resolver
200	OK Requisição bem-sucedida.	—
400	Bad Request Parâmetros inválidos ou ausentes.	Verifique os parâmetros da requisição.
401	Unauthorized Token ausente, inválido ou revogado.	Verifique seu Bearer token.
404	Not Found Recurso não encontrado.	Confirme o identificador informado.
500	Server Error Erro interno do servidor.	Tente novamente. Se persistir, contate o suporte.