Saltar al contenido principal

Consultar la información de un administrador

[ GET ]

Visión general​

Obtén el detalle de un administrador para validar permisos, confirmar sus datos de contacto o preparar auditorías. La operación es de solo lectura y no genera cambios en la cuenta.

  • URL: https://sync.airbagtech.io/manager/{MANAGER_ID}
  • Uso recomendado: validaciones previas a escalar privilegios o depurar registros.

Autenticación​

Incluye el encabezado Authorization: apikey {API_KEY}. Las claves API se solicitan al equipo de soporte de Airbag Tech y se asignan a contactos autorizados dentro de la organización.

Parámetro de ruta​

ParámetroTipoRequeridoDescripción
MANAGER_IDStringSíIdentificador del administrador que se desea consultar. Acepta el ID que tu empresa usó al crearlo o el airbagId.

Ejemplo de solicitud​

curl --location -g 'https://sync.airbagtech.io/manager/ADM-001' \
--header 'Authorization: apikey ${API_KEY}'

Respuestas​

✅ Respuesta exitosa (200 OK)​

Devuelve la ficha completa del administrador con todos sus datos.

{
"status": true,
"manager": {
"authRole": "admin",
"created": "2024-02-05T00:19:14.555Z",
"email": "[email protected]",
"fullName": "Ana Martínez López",
"groups": [],
"lastName": "Martínez López",
"name": "Ana",
"phone": "+525512345678",
"gender": "female",
"status": "active",
"coins": 0,
"airbagId": "Kp9qLmRsT2uVwXyZaBcD",
"company": "Transportes Ejemplo",
"id": "Kp9qLmRsT2uVwXyZaBcD"
}
}

Descripción de campos de respuesta​

CampoTipoDescripción
statusBooleanIndica si la operación fue exitosa.
managerObjectObjeto con los datos completos del administrador.

Campos dentro de manager​

CampoTipoDescripción
airbagIdStringIdentificador interno único en la plataforma Airbag. Útil para operaciones internas y referencias cruzadas.
idStringIdentificador del administrador. Coincide con airbagId cuando no se proporcionó un ID personalizado al crearlo; en caso contrario, es el ID definido por tu empresa.
companyStringNombre de la organización a la que pertenece el administrador.
fullNameStringNombre completo del administrador (name + lastName).
nameStringNombre de pila del administrador.
lastNameStringApellido del administrador.
emailStringCorreo electrónico corporativo. Canal principal de comunicación y autenticación.
phoneStringNúmero de teléfono con código de país (formato +525555555555).
genderStringGénero del administrador. Valores: male, female, other. Es un campo opcional: la clave está ausente en la respuesta cuando no se informó al crear la cuenta.
authRoleStringRol de permisos asignado. Valores: admin (acceso total) o group-limited (acceso restringido a los grupos listados en groups).
groupsArray<String>IDs de los grupos a los que tiene acceso. Suele estar vacío ([]) cuando authRole es admin.
statusStringEstado de la cuenta. Valores: active o inactive.
coinsNumberSaldo de monedas acumulado por el administrador. Generalmente 0 salvo que la empresa otorgue monedas a su equipo administrativo.
createdStringFecha y hora de creación de la cuenta en formato ISO 8601 (UTC).

Los campos opcionales que no fueron informados no viajan en el JSON: la clave se omite en lugar de llegar como null. Comprueba que exista antes de leerla.

❌ Administrador no encontrado (400 Bad Request)​

Se devuelve cuando el ID proporcionado no corresponde a ningún administrador registrado.

{
"status": false,
"message": "Error: Manager not found",
"errorId": "sentry_error_id_123"
}

Respuestas y buenas prácticas​

  • 200 OK: devuelve la ficha completa del administrador, incluyendo rol y datos de contacto.
  • 400 Bad Request: confirma que el identificador corresponda a una cuenta activa.

Recuerda validar que el rol y el grupo asignados sigan vigentes antes de utilizar estos datos en procesos automatizados.