Download the PHP package homlity/sdk-homlity without Composer
On this page you can find all versions of the php package homlity/sdk-homlity. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package sdk-homlity
Homlity PHP SDK
Integra inmuebles, clientes, leads, tickets, tareas y WordPress con el ecosistema inmobiliario Homlity.
Propósito del SDK
Homlity conecta, automatiza y optimiza procesos del sector inmobiliario. Este SDK lleva ese objetivo a proyectos PHP: encapsula autenticación, solicitudes HTTP, validaciones y respuestas para que una integración pueda concentrarse en su lógica de negocio y no en reconstruir la comunicación con cada API.
Con el paquete puedes:
- publicar, actualizar, consultar y desactivar inmuebles;
- consultar en vivo el perfil público de la inmobiliaria autenticada;
- buscar inmuebles del tenant autenticado con filtros y paginación;
- consultar clientes y agentes, y verificar clientes por documento;
- crear leads y relacionarlos con un inmueble o cliente cuando el backend lo admite;
- crear, listar y consultar tickets;
- consultar canales de ingreso y categorías de PQR;
- consultar tareas asíncronas y procesar webhooks;
- sincronizar propiedades y consultar analítica en un sitio WordPress con Homlity.
Homlity es una plataforma tecnológica para el sector inmobiliario, no una inmobiliaria. Consulta homlity.com y el portal de Homlity para desarrolladores.
Requisitos e instalación
- PHP 8.1 o superior
- extensiones
curlyjson - Composer
Elige el cliente correcto
El paquete cubre tres superficies. No mezcles credenciales ni URL base entre ellas.
| Flujo | Configuración | Autenticación | Para qué sirve |
|---|---|---|---|
| API de Integradores | new Homlity\Sdk\Config(...) |
apikey + X-API-KEY |
Publicar/listar inmuebles, clientes, agentes, categorías, ubicaciones, tareas y webhooks |
| API tenant | Homlity\Sdk\Config::forTenantApi(...) |
Bearer token | Inmuebles, tickets, verificación de clientes y leads aislados por inmobiliaria |
| Sitio WordPress | Homlity\Sdk\Homlity\Config |
Bearer + firma HMAC en propiedades | Sincronizar/desactivar propiedades, eventos y analítica del plugin |
Inicio rápido: API tenant
El token representa al usuario y a su inmobiliaria. Los DTO del SDK no reciben
id_inmobiliaria; el backend aplica el alcance del tenant autenticado.
Las aplicaciones consumidoras, como Homlity Chat, deben guardar los IDs que devuelven estas APIs. No deben depender de IDs hardcodeados para canales o categorías de PQR.
La guía de recursos tenant contiene todos los filtros, DTO, relaciones, respuestas y contratos pendientes del backend.
Inicio rápido: API de Integradores
Publicar un inmueble:
Consulta parámetros de inmuebles antes de enviar un payload de producción.
Inicio rápido: WordPress
push() y deactivate() firman el cuerpo exacto con HMAC SHA-256 de forma
predeterminada. Consulta la referencia WordPress.
Documentación
- Centro de documentación: propósito, arquitectura y rutas de aprendizaje.
- Referencia completa de clases y métodos: qué hace cada función, parámetros, retornos y ejemplos.
- Mapa de endpoints: método SDK ↔ endpoint HTTP.
- Recursos tenant: inmuebles, tickets, clientes y leads.
- Parámetros de inmuebles de Integradores.
- Tareas y webhooks de Integradores.
- API del plugin WordPress.
- Webhooks firmados del plugin.
- OpenAPI local.
Ejemplos ejecutables
Los scripts leen credenciales desde variables de entorno; no guardes secretos en el repositorio.
| Ejemplo | Flujo |
|---|---|
tenant-workflow.php |
Buscar inmueble → verificar cliente → crear lead → crear ticket |
publish-listing.php |
Publicar inmueble en Integradores |
list-listings.php |
Listar inmuebles en Integradores |
subscribe-webhook.php |
Suscribir un callback |
receive-webhook.php |
Validar y leer una notificación |
homlity-push-property.php |
Sincronizar una propiedad con WordPress |
homlity-deactivate-property.php |
Desactivar una propiedad en WordPress |
homlity-analytics-report.php |
Consultar analítica del plugin |
Errores y seguridad
La API principal mapea respuestas 401, 403, 404, 409, 422, 429 y
5xx a excepciones específicas. El transporte conserva el código HTTP, JSON y
tracking ID, pero evita incluir el cuerpo —que puede contener datos personales—
en el mensaje de error.
Desarrollo
Licencia MIT. Desarrollado por Codwelt S.A.S. para el ecosistema Homlity.