API de Pases de Acceso

Documentación para desarrolladores

Integra NILO con tus aplicaciones usando nuestra API REST. Consulta pases de acceso expirados de forma segura y en tiempo real.

Inicio Rápido

1️⃣ Obtén tu Bearer Token

Solicita un token de acceso desde el panel de administración de NILO en la sección API Keys

2️⃣ Realiza tu primera petición

Usa el token en el header de autorización:

Authorization: Bearer tu_token_aqui

3️⃣ Procesa la respuesta

Recibirás un array JSON con los pases de acceso expirados y sus detalles

Endpoint

GET/api/external/v1/access-passes

Descripción

Obtiene todos los pases de acceso expirados asociados a tu ubicación (location). Incluye pases que ya salieron (checkout) o que expiraron sin hacer check-in.

Headers

Authorization

Requerido. Bearer token de autenticación

Bearer mb_xK9pL2mN8qR5tY7wZ3cV1bA4sD6fG8hJ0

Respuesta Exitosa (200)

Retorna **directamente un array JSON** con los pases de acceso expirados y sus detalles formateados:

[
  {
    "nombre": "Juan Pérez",
    "apellido": "Pérez",
    "tipo_de_visitante": "Visitante",
    "invitado_por": "María González",
    "placa": "ABC-123",
    "lugar_de_estacionamiento": "Planta Baja - A-15",
    "acompanantes": "Ana López; Pedro Gómez",
    "fecha_entrada": "15/02/2024 10:00",
    "fecha_salida": "15/02/2024 18:00",
    "check_in": "15/02/2024 10:05",
    "check_out": "15/02/2024 17:58",
    "tipo_de_acceso": "Pase Único",
    "metodo_de_ingreso": "Vehicular",
    "documentos": "2 documento(s)",
    "estado": "Aceptado",
    "empresa_proveedora": null,
    "creado_en": "14/02/2024 15:30",
    "recurrente": false,
    "propiedad_nombre": "Departamento 501"
  },
  // ... más registros
]

Campos Principales

nombre

Nombre completo del visitante (incluye (Recurrente) si aplica)

apellido

Apellido del visitante

tipo_de_visitante

Visitante, Delivery, Proveedor, No registrado

invitado_por

Nombre del usuario que creó el pase

placa

Placa del vehículo (si aplica)

lugar_de_estacionamiento

Piso y número del estacionamiento

acompanantes

Lista de acompañantes separados por ;

fecha_entrada

Fecha/hora programada de entrada (formato local)

fecha_salida

Fecha/hora programada de salida (formato local)

check_in

Fecha/hora real de check-in

check_out

Fecha/hora real de check-out

tipo_de_acceso

Pase Único o Pase Recurrente

metodo_de_ingreso

Vehicular o Peatonal

documentos

Cantidad de documentos adjuntos o '--'

estado

Pendiente, Aceptado, Rechazado

empresa_proveedora

Nombre de la empresa proveedora (si aplica)

creado_en

Fecha/hora de creación del pase

recurrente

true si es un pase recurrente

propiedad_nombre

Nombre de la propiedad/departamento

Respuestas de Error

401Unauthorized

{ "message": "Unauthorized" }

Token inválido o expirado

401API Key Expired

{ "message": "API Key expired" }

El token ha expirado

Ejemplos de Código

cURL

curl -X GET "https://app.nilo.mx/api/external/v1/access-passes" \
  -H "Authorization: Bearer tu_token_aqui"

JavaScript (Fetch)

fetch('https://app.nilo.mx/api/external/v1/access-passes', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer tu_token_aqui'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

Python (requests)

import requests

url = "https://app.nilo.mx/api/external/v1/access-passes"
headers = {
    "Authorization": "Bearer tu_token_aqui"
}

response = requests.get(url, headers=headers)
data = response.json()
print(data)

PowerBI (M Query)

let
    url = "https://app.nilo.mx/api/external/v1/access-passes",
    token = "tu_token_aqui",
    headers = [
        #"Authorization" = "Bearer " & token
    ],
    response = Json.Document(Web.Contents(url, [Headers=headers]))
in
    response

Probador de API

Prueba tu Bearer Token directamente desde aquí

Bearer Token

💡 Mejores Prácticas

🔒 Seguridad del Token

Nunca expongas tu Bearer Token en el código del frontend. Úsalo solo en el backend o en herramientas como PowerBI.

⚡ Rate Limiting

No realices más de 100 peticiones por hora. Implementa caché local cuando sea posible.

🔄 Manejo de Errores

Siempre implementa retry logic con backoff exponencial para errores 5xx.

📊 Datos Sensibles

Los campos como identityDocument están encriptados. Trata estos datos con confidencialidad.

💬

¿Necesitas ayuda?

Si tienes preguntas o necesitas asistencia técnica, nuestro equipo está listo para ayudarte

📧soporte@nilo.mx

Tiempo de respuesta: 24-48 horas hábiles