Introducción

Bienvenido a la documentación oficial de la HAVI API — la plataforma de infraestructura inmobiliaria que potencia havi.app y el servicio HAVI Score para portales, instituciones financieras y plataformas en toda Latinoamérica.

¿Qué puedes hacer con esta API?

Módulo	Descripción
Agencias	Registra inmobiliarias, sube logos, gestiona su equipo de agentes
Agentes	Crea perfiles de agentes vinculados a agencias con autenticación propia
Propiedades	Publica, busca y asigna inmuebles a agentes con multimedia en S3
HAVI Score	Analiza el perfil crediticio de compradores mediante IA y OCR
Inquiries	Gestiona solicitudes de contacto entre compradores y vendedores

Base URL

Base URL activa: https://api.havi.app

Todos los endpoints son HTTPS. Las peticiones HTTP son redirigidas automáticamente.

Cambiar de ambiente

Usa el toggle Production / Sandbox en la barra de navegación para cambiar de ambiente. Los ejemplos en esta documentación usan https://api.havi.app — sustitúyelo por https://api-sandbox.havi.app cuando trabajes en sandbox.

Versión actual

v1.0.0

Los endpoints del HAVI Score están disponibles bajo /api/v1/.

Formato de respuesta

Todas las respuestas son JSON con la siguiente estructura base:

// Respuesta exitosa
{
  "status": "success",   // o "success: true"
  "data": { ... },
  "message": "Operación exitosa"
}

// Respuesta de error
{
  "status": "error",
  "message": "Descripción del error",
  "error": "CÓDIGO_DE_ERROR"
}

Paginación

Los endpoints que devuelven listas utilizan paginación basada en páginas:

GET /api/properties?page=1&limit=10

La respuesta incluye metadatos de paginación:

{
  "data": {
    "data": [ ... ],
    "meta": {
      "total": 150,
      "perPage": 10,
      "currentPage": 1,
      "lastPage": 15,
      "firstPage": 1
    }
  }
}

Próximos pasos

1. Configura la autenticación — obtén tu Bearer Token
2. Registra una agencia — crea tu primera agencia
3. Añade agentes — asigna agentes a la agencia
4. Publica propiedades — da de alta inmuebles