Habitanto para integradores

Sincronización de
accesos externos

Una integración sencilla para registrar entradas y salidas detectadas por cámaras, lectores, torniquetes u otros dispositivos.

Acceso bajo solicitudVer endpoint

Residentes y autorizados · Dispositivos externos · Bitácora centralizada

POST/v1/accesses

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 entradas y salidas detectadas por cámaras, lectores, torniquetes u otros dispositivos.

Cada evento queda disponible en Administrativo → Accesos → Bitácora. La API conserva la fecha, la hora y la zona horaria enviadas por el sistema de origen.

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 qué cámaras, lectores o dispositivos deseas conectar.

02
↗

Obtén tu credencial

Recibe una API key asociada al condominio autorizado.

03
↗

Envía cada evento

Indica la persona, el tipo de acceso y el momento en que ocurrió.

04
✓

Consulta la bitácora

El acceso queda registrado y disponible en Habitanto.

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

Endpoint disponible

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

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

Usa access_type para indicar si el evento es una Entrada o una Salida.

identificationstring

Identificación del residente o autorizado.

Sí
access_typestring

Solo Entrada o Salida.

Sí
occurred_atISO 8601

Momento real con zona horaria.

Sí
access_pointstring

Nombre o ubicación del dispositivo.

No
unit_idUUID

Unidad relacionada.

No
access_methodstring

Biométrico, tarjeta, QR, facial, NFC, etc.

No
Ejemplo requestcURL
curl --location 'https://qa-beta.habitanto.com/v1/accesses' \  --header 'Content-Type: application/json' \  --header 'X-API-Key: {API_KEY}' \  --data '{    "identification": "2300551948",    "access_type": "Entrada",    "occurred_at": "2026-09-24T08:30:00-05:00",    "access_point": "Acceso 01",    "access_method": "biométrico"  }'
201 Createdapplication/json
{
  "message": "Acceso sincronizado correctamente.",
  "data": { "identification": "2300551948", "access_type": "Entrada" }
}

Consideraciones

  • La identificación debe pertenecer a un residente o persona autorizada.
  • Si se envía unit_id, debe pertenecer al condominio autenticado.
  • Debe existir al menos un dispositivo activo con dirección MAC configurada.
Respuestas claras

Respuestas y errores

Códigos esenciales para gestionar cada solicitud.

201

Acceso registrado

El evento se sincronizó correctamente.

401

Credencial inválida

API key ausente, inválida o vencida.

422

Registro inválido

Persona, unidad, tipo o dispositivo no válidos.

502

Fallo de bitácora

No fue posible registrar el acceso.

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.