Ir al contenido

Primera llamada

La API de NotiAuto es REST sobre HTTPS y devuelve JSON. Todo vive bajo:

https://api.notiauto.co/v1

/health es el único endpoint que no pide autenticación. Úsalo para verificar conectividad antes de pelear con las credenciales:

Ventana de terminal
curl https://api.notiauto.co/v1/health
{
"success": true,
"service": "NotiAuto API",
"version": "v1",
"timestamp": "2026-07-28T15:04:05.000000Z",
"dependencies": {
"database": "ok",
"runt": "ok",
"simit": "ok",
"whatsper": "ok"
}
}

Devuelve 503 si alguna dependencia externa no responde, y en ese caso el campo correspondiente dentro de dependencies dice down. Un 503 acá significa que los endpoints que dependen de esa pieza van a fallar: si runt está down, las consultas RUNT no van a funcionar aunque tu key sea válida.

En el panel, sección API. Al crear la key eliges:

  • Nombre — para identificarla después; no afecta permisos.
  • Scopes — qué puede leer. Marca solo lo que la integración necesita.
  • Expiración — opcional.

La key se muestra una sola vez, al momento de crearla. NotiAuto guarda un hash, no la key, así que no hay forma de recuperarla luego: si la pierdes, hay que crear otra.

La key va en el header X-API-Key:

Ventana de terminal
curl https://api.notiauto.co/v1/vehicles \
-H "X-API-Key: TU_API_KEY"

También se acepta como Bearer token, si tu cliente HTTP lo tiene más a mano:

Ventana de terminal
curl https://api.notiauto.co/v1/vehicles \
-H "Authorization: Bearer TU_API_KEY"

Respuesta:

{
"success": true,
"data": {
"current_page": 1,
"data": [
{
"id": 12,
"plate": "ABC123",
"marca": "CHEVROLET",
"linea": "NPR",
"modelo": "2020",
"soat": {
"is_valid": true,
"expiration_date": "2027-01-15",
"entidad_expide": "SEGUROS DEL ESTADO"
},
"rtm": { "is_valid": true, "expiration_date": "2026-11-30" },
"active_infractions": 1,
"total_infractions": 3
}
]
},
"meta": { "current_page": 1, "total": 42, "per_page": 20, "last_page": 3 }
}
Quiero Endpoint Scope
Mis vehículos GET /vehicles vehicles.read
Un vehículo por placa GET /vehicles/{plate} vehicles.read
Mis conductores y sus licencias GET /drivers drivers.read
Mis comparendos GET /infractions infractions.read
Qué se me vence pronto GET /expirations vehicles.read
Consultar un vehículo en el RUNT POST /consults/vehicle consults.vehicle
Consultar licencias en el RUNT POST /consults/license consults.license

Los cinco primeros leen tus datos: solo devuelven lo que pertenece a la organización dueña de la key. Los dos últimos consultan al RUNT en vivo y funcionan con cualquier placa o documento, estén o no en tu flota.

Siguiente paso: Autenticación y scopes para entender los permisos, o la Referencia para el detalle de cada endpoint.