Usuarios API #

Este tipo de usuario está diseñado para hacer que sistemas externos se conecten de forma segura y automática a una plataforma o aplicación, con permisos específicos para consultar, enviar o modificar información mediante solicitudes programadas.

IMPORTANTE: El alta, la modificación y la desactivación de un usuario API las realiza Algebraix; ningún administrador ni operador de tu colegio ve las pestañas Agregar usuario API, Modificar, Desactivar o Reactivar, y no hay permiso que las habilite. Lo que sí puedes hacer desde tu colegio es consultar los usuarios API dados de alta y el detalle de cada uno. Si necesitas un usuario API nuevo, un cambio de contraseña o de endpoints, o dar de baja una integración, solicítalo a Algebraix.

1. En tu “Panel de control” selecciona Usuarios API.
2. Da clic en Agregar usuario API.
3. Se mostrará el formulario para que llenes la siguiente información:
   • Nombre: El nombre de la persona que darás de alta como usuario API.
   • Apellido paterno: El apellido paterno de la persona que darás de alta como usuario API.
   • Apellido materno: El apellido materno de la persona que darás de alta como usuario API.
   • Nombre de usuario: Puedes agregar un nombre de usuario y revisar si está disponible dando clic en el ícono “Revisar disponibilidad” .
   • Si deseas que el sistema genere el “Nombre de usuario” da clic en el ícono “Generar nombre de usuario” .
   • Correo electrónico: Agrega el correo electrónico del usuario.
   • Fecha de nacimiento: Ingresa la fecha de nacimiento del usuario API.
   • Contraseña: De manera predeterminada ya está generada la contraseña y no podrás editarla. Da clic en el ícono “Copiar al portapapeles” para copiarla y poder compartirla con el usuario.
   • Si es necesario generar una nueva contraseña, da clic en el ícono “Contraseña nueva” .
   • Direcciones IPv4 y CIDR: Agrega una dirección IP con CIDR.
   • Direcciones IPv6 y CIDR: Agrega una dirección IP con CIDR.
4. En la parte media se muestran los Endpoints para que selecciones aquellos a los que tendrá acceso este usuario.
5. En la tabla Endpoints internos selecciona los endpoints a los que darás acceso a este usuario.
6. En el apartado Permisos por grupo. puedes seleccionar:
   • Acceso a todos los grupos (actuales y futuros): Esto le dará acceso a todos los grupos del colegio incluidos aquellos que lleguen a darse de alta después de la creación de este usuario.
   • Grupos: Despliega el “Campus”, la “Sección”, el “Grado” y selecciona el o los grupos a los que darás acceso a esta usuario.
7. Para guardar da clic en Aceptar.

1. Desde tu “Panel de control” selecciona Usuarios API.
2. Haz clic en el nombre del operador en donde quieres realizar la modificación.
3. Da clic en Modificar.
4. Se habilita el formulario para que realices la modificación correspondiente.
   • En el formulario puedes generar una contraseña nueva en caso de ser necesario. Da clic en el ícono “Contraseña nueva” .
   • Aparecerá un mensaje indicando que esta acción generará un nuevo token, para continuar da clic en Actualizar.
5. Para guardar los cambios da clic en Aceptar.

IMPORTANTE: Configurar los webhooks —las URLs a las que la plataforma envía en automático un aviso por cada cambio en cargos, pagos, descuentos, becas o usuarios— es exclusivo del administrador principal de la plataforma; ningún administrador ni operador de tu colegio ve esta pantalla, y no hay permiso que la habilite. Si necesitas configurar o modificar un webhook, solicítalo a Algebraix.

IMPORTANTE: Consultar y reintentar las colas de webhooks pendientes es exclusivo del administrador principal de la plataforma; ningún administrador ni operador de tu colegio ve esta pantalla, y no hay permiso que la habilite. Si un envío a tu sistema externo sigue fallando después de varios intentos, repórtalo a Algebraix.

La pestaña Prechecks muestra las validaciones que la plataforma corre sobre los datos del colegio antes de que se sincronicen con Mattilda, la plataforma de pagos: agrupa en ocho tablas los registros con datos duplicados, incompletos, inválidos o mal capturados, para que los corrijas antes de que lleguen a Mattilda.

1. Desde tu Panel de control selecciona Usuarios API.
2. Da clic en la pestaña Prechecks.
3. Cada una de las ocho pestañas de arriba trae, junto a su nombre, un contador con el total de registros que encontró; mientras carga se muestra un ícono de carga en su lugar.
4. Arriba a la derecha, el botón de exportar a Excel descarga un archivo con una hoja por cada una de las ocho pestañas, con todos los registros sin filtrar.
5. Cada tabla trae su propio campo Filtrar, que acota los renglones visibles conforme escribes, y se pagina de 50 en 50 registros.
6. En las columnas de estatus (CURP, correo electrónico, celular, datos fiscales) el color de la etiqueta indica el problema encontrado: verde es que el dato está completo, rojo que falta, amarillo que está duplicado con otro registro, morado que faltan datos fiscales completos y naranja que el dato es genérico, por ejemplo un correo o un RFC de plantilla.
7. Cuando un alumno o un padre de familia tiene un dato marcado como duplicado, aparece el icono de Buscar junto a su renglón; da clic para ver con quién se duplica cada dato, en una ventana emergente.

Lista a los estudiantes que tienen más de un padre o más de una madre registrados como titulares, con Nombre del estudiante, Sección, Grado y Grupo; en # Padres y # Madres ves cuántos tiene cada quien, y en Padres y Madres la lista de nombres, cada uno con un enlace a su ficha.

Lista a los estudiantes con algún dato faltante, inválido o duplicado para la sincronización.

1. Nombre del estudiante, Sección, Grado y Grupo.
2. Sup. propia: un icono de palomita indica que el estudiante tiene su propia supervisión de facturación asignada; una tacha, que no la tiene.
3. CURP, Correo electrónico y Celular, cada uno con su estatus.
4. RFC, Régimen fiscal, Uso CFDI y Datos fiscales, con el estatus de este último.
5. Da clic en el Nombre del estudiante para abrir su ficha.

Lista a los padres de familia —y a los profesores marcados como tutores— con algún dato faltante, inválido o duplicado.

1. Activo, con un icono de palomita o de tacha.
2. Nombre del padre, con un icono de persona junto al nombre si en realidad es un profesor tutor.
3. Hijos, la lista de sus hijos asociados, con el grupo de cada uno.
4. Correo electrónico y Celular, cada uno con su estatus, y RFC, Régimen fiscal, Uso CFDI y Datos fiscales.
5. Da clic en el nombre para abrir la ficha del padre de familia o del profesor, según corresponda.

Estas dos pestañas muestran a estudiantes y a padres de familia —o profesores tutores— cuyos datos traen espacios de más, al principio, al final o en medio del texto, en alguno de sus campos; eso puede provocar que el dato no se reconozca como igual al llegar a Mattilda.

1. Espacios alumnos muestra Matrícula, Nombre del estudiante, Sección, Grado, Grupo, Nombre, Apellido paterno, Apellido materno, Correo electrónico y Nombre o razón social.
2. Espacios padres muestra Nombre del padre, Nombre, Apellido 1, Apellido 2, Correo electrónico y Nombre o razón social.
3. En ambas, la columna Campo con espacios enlista cuál o cuáles de esos campos traen el espacio de más.

Lista, mezclados en una sola tabla, a los estudiantes, padres de familia y profesores cuyo correo electrónico no tiene una forma válida, con Tipo —Estudiante, Padre de familia o Profesor—, Nombre, Sección, Grado, Grupo y Correo electrónico. Da clic en el nombre para abrir la ficha correspondiente.

Lista a los estudiantes que tienen sus propios datos de facturación —RFC, Régimen fiscal, Uso CFDI y Nombre o razón social— pero no tienen ningún padre de familia asignado como responsable de esa facturación. Muestra también Matrícula, Nombre del estudiante, Sección, Grado y Grupo.

Lista a los estudiantes que no tienen ningún padre de familia marcado como el titular principal, con Nombre del estudiante, Sección, Grado, Grupo y Padres de familia, la lista de los padres asociados con un enlace a la ficha de cada uno.

Para que el operador pueda consultar esta pantalla, es necesario asignarle el siguiente permiso al momento de agregarlo o modificar su perfil:

• Desde “Permisos globales” > Webhooks.
  • Prechecks: Permite consultar la pestaña Prechecks y sus ocho tablas de validación.

El administrador de la escuela consulta esta pantalla sin necesidad de asignarle ningún permiso.

1. Desde tu Panel de control selecciona Usuarios API.
2. El panel Usuarios API lista las cuentas activas, una por renglón, con las columnas:
   • La primera columna, sin título, muestra un indicador de color con la leyenda “Activo”.
   • Nombre de usuario: El identificador con el que la integración se conecta. Da clic en él para abrir el detalle del usuario.
   • Nombre y Apellido: A quién o a qué sistema corresponde la cuenta.
   • Correo electrónico: El correo registrado en la cuenta.
   • Creado por: El usuario que dio de alta la cuenta.
   • Fecha y hora de creación: Cuándo se creó.
3. Puedes ordenar la tabla dando clic en el título de cualquiera de esas columnas.
4. Más abajo, el panel Usuarios API desactivados lista las cuentas que ya no están en uso, con su indicador, Nombre, Apellido, Correo electrónico y la columna Acciones. Estas cuentas ya no tienen nombre de usuario ni permisos.
5. Ambos paneles se pueden plegar y desplegar desde su encabezado.
6. Si el colegio todavía no tiene ninguna cuenta de este tipo, se muestra el aviso “No se han encontrado usuarios API”.

1. Desde tu Panel de control selecciona Usuarios API.
2. Da clic en el Nombre de usuario de la cuenta que quieres revisar.
3. A la izquierda se muestra la ficha del usuario, encabezada con su apellido y nombre y la leyenda Usuario API, con los datos registrados: Nombre de usuario (solo si la cuenta está activa), Nombre, Apellido, Correo electrónico, Direcciones IPv4 y CIDR y Direcciones IPv6 y CIDR desde las que se le permite conectarse. Si la cuenta tiene acceso a todos los grupos, aparece además Todos los grupos bajo Permisos de grupo.
4. A la derecha se muestra el panel Endpoints, plegado. Al desplegarlo verás, agrupados, todos los endpoints de la API con el método de cada uno —el catálogo completo, no solo los de esta cuenta—. Lo que distingue a los que tiene concedidos es el icono: palomita verde si lo tiene, tacha roja si no. Al auditar hasta dónde llega una integración, fíjate en el icono y no en la longitud de la lista.
5. Debajo, el panel Permisos de grupo enlista los grupos a los que alcanza la cuenta, organizados por campus, sección y grado. Este panel no se muestra cuando la cuenta tiene acceso a todos los grupos.
6. El campo Filtrar permisos, arriba de los paneles, acota lo que se muestra conforme escribes.
7. Nota: Si la cuenta está desactivada se muestra el aviso “Usuario desactivado” y no se despliegan los paneles de endpoints ni de grupos, porque al desactivarla se le retiraron todos.