Habitanto para integradores

Sincronización de
visitas externas

Una integración sencilla para registrar la entrada y salida de visitantes desde un sistema externo.

Acceso bajo solicitudVer endpoint

Entrada y salida · Trazabilidad · Fechas con zona horaria

POST/v1/visits

X-API-Key

hbt_test_••••••••••••

Content-Type

application/json
201 CreatedJSON
✓
Consulta seguraInformación autorizada
Simple por diseño

¿Qué es esta API?

Una integración sencilla para registrar la entrada y salida de visitantes desde un sistema externo.

Cada visita queda disponible en Administrativo → Guardianía → Visitas. Al registrar la entrada recibes un identificador que podrás usar posteriormente para registrar la salida.

01Acceso controladoCada credencial está asociada a un condominio.
02Información necesariaLa API utiliza únicamente los datos requeridos para cada operación.
Integración directa

Cómo funciona

De la solicitud de acceso a tu primera operación en cuatro pasos.

01
↗

Solicita acceso

Cuéntanos sobre tu sistema y el condominio que deseas integrar.

02
↗

Obtén tu credencial

Recibe una API key asociada al condominio autorizado.

03
↗

Registra la entrada

Envía los datos del visitante y conserva el identificador recibido.

04
✓

Registra la salida

Usa el identificador de la visita para completar su salida.

Seguridad

Autenticación

Las APIs utilizan una credencial única asociada al condominio autorizado. Inclúyela en cada solicitud mediante el header Authorization o X-API-Key; no necesitas enviar el identificador del condominio.

✓ Guarda la credencial en variables de entorno.✓ Nunca la expongas en aplicaciones frontend.✓ Revoca de inmediato una credencial comprometida.
Headers admitidosUno requerido
X-API-Key: {API_KEY}

O mediante Bearer Token

Authorization: Bearer {API_KEY}
Si no se envía una credencial válida, la API responde 401 Unauthorized.
Referencia esencial

Endpoints disponibles

Todo lo necesario para realizar una integración, en un solo lugar.

POST/v1/visits Disponible
URL basehttps://qa-beta.habitanto.com
HeaderX-API-Key: {API_KEY}
Campos del body

Crea la visita y devuelve el visit_id necesario para registrar su salida posteriormente. También puedes enviar exit_at para registrar la entrada y la salida en una sola solicitud.

visitor_namestring

Nombre completo. Máximo 100 caracteres.

Sí
identificationstring

Cédula o identificación. Máximo 50 caracteres.

Sí
unit_idUUID

Unidad destino del condominio.

Sí
entry_atISO 8601

Entrada incluyendo zona horaria.

Sí
exit_atISO 8601

Opcional. Si se envía, registra también la salida de la visita.

No
reasonstring

Motivo de la visita.

No
registered_bystring

Guardia o sistema que registró.

No
Ejemplo requestcURL
curl --location 'https://qa-beta.habitanto.com/v1/visits' \  --header 'Content-Type: application/json' \  --header 'X-API-Key: {API_KEY}' \  --data '{    "visitor_name": "María Fernanda López",    "identification": "1712345678",    "unit_id": "a06a77e8-434f-4360-b1f0-1cb396d66658",    "entry_at": "2026-09-24T09:00:00-05:00",    "reason": "Visita familiar"  }'
201 Createdapplication/json
{
  "message": "Visita sincronizada correctamente.",
  "data": { "id": "uuid-de-la-visita", "exit_at": null }
}
PATCH/v1/visits/{visit_id}/exit Disponible
URL basehttps://qa-beta.habitanto.com
HeaderX-API-Key: {API_KEY}
Campos del body

Usa data.id devuelto al registrar la entrada para completar la visita.

visit_idUUID

Identificador incluido en la URL.

Sí
exit_atISO 8601

Fecha y hora de salida con zona horaria.

Sí
Ejemplo requestcURL
curl --location --request PATCH \+  'https://qa-beta.habitanto.com/v1/visits/{visit_id}/exit' \  --header 'Content-Type: application/json' \  --header 'X-API-Key: {API_KEY}' \  --data '{ "exit_at": "2026-09-24T11:30:00-05:00" }'
200 OKapplication/json
{
  "message": "Salida de la visita registrada correctamente.",
  "data": { "id": "uuid-de-la-visita", "exit_at": "2026-09-24T11:30:00-05:00" }
}
Respuestas claras

Respuestas y errores

Códigos esenciales para gestionar cada solicitud.

201

Visita creada

La entrada fue sincronizada correctamente.

404

Visita no encontrada

El visit_id no existe al registrar la salida.

422

Datos inválidos

Campo requerido, unidad o fecha no válidos.

502

Fallo de bitácora

No se completó la sincronización necesaria.

Los errores utilizan una respuesta JSON con un mensaje descriptivo y, cuando corresponde, el detalle por campo.

Empieza tu integración

¿Necesitas acceso?

Las credenciales de integración son gestionadas directamente por el equipo de Habitanto.

Comunícate con el equipo de HabitantoTe ayudaremos a solicitar y gestionar el acceso.