Habitanto para integradores

QR para visitas
programadas

Una integración sencilla para crear invitaciones programadas y compartir el acceso mediante un código QR.

Acceso bajo solicitudVer endpoint

QR en SVG Base64 · Código manual · Vigencia configurable

POST/v1/visit-invitations/qr

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 crear invitaciones programadas y compartir el acceso mediante un código QR.

La respuesta incluye la imagen QR, un código manual, la vigencia y el límite de usos. Antes de autorizar el ingreso, Habitanto valida el condominio, el horario y el estado de la invitación.

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 flujo de invitaciones.

02
↗

Obtén tu credencial

Recibe una API key asociada al condominio autorizado.

03
↗

Programa la visita

Envía los datos del visitante, la fecha y la vigencia.

04
✓

Comparte el acceso

Recibe la imagen QR y el código manual de la invitación.

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/visit-invitations/qr Disponible
URL basehttps://qa-beta.habitanto.com
HeaderX-API-Key: {API_KEY}
Campos del body

Programa una visita para una unidad y define su ventana de uso.

visitor_namestring

Nombre completo del visitante.

Sí
identificationstring

Cédula o documento.

Sí
unit_idUUID

Unidad destino.

Sí
visit_dateYYYY-MM-DD

Día programado.

Sí
start_timeHH:MM

Inicio; por defecto 00:00.

No
end_timeHH:MM

Fin; por defecto 23:59:59.

No
max_usesinteger

De 1 a 100; por defecto 1.

No
Ejemplo requestcURL
curl --location 'https://qa-beta.habitanto.com/v1/visit-invitations/qr' \  --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",    "visit_date": "2026-09-25",    "start_time": "08:30",    "end_time": "18:45",    "max_uses": 2  }'
201 Createdapplication/json
{
  "message": "Código QR generado correctamente.",
  "data": { "invitation_id": "id-de-la-invitacion", "qr_image": "data:image/svg+xml;base64,...", "manual_code": "123456", "max_uses": 2 }
}
Respuestas claras

Respuestas y errores

Códigos esenciales para gestionar cada solicitud.

201

QR generado

La invitación fue creada correctamente.

401

Credencial inválida

API key ausente, inválida o vencida.

422

Datos inválidos

Unidad, fecha, horario o usos no válidos.

502

Fallo de invitaciones

No fue posible generar el código QR.

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.