Tabla de Contenidos

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.

  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.
    • Puedes darle acceso también para los perfiles de estudiantes “Solicitantes”, “Graduados” y “Desactivados”.
  7. Para guardar da clic en Aceptar.

Modificar usuario API

  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.

Webhooks

  1. Desde tu “Panel de control” selecciona Usuarios API.
  2. Despliega “Webhooks” y selecciona Webhooks.
  3. En Pagos agrega la URL o IP desde donde se reciben las peticiones.
    • Da clic en Ver detalles para que observes como está construida la petición.
    • Haz clic en Pagos para que se te envíe a la documentación de la API.
  4. Para agregar Cabeceras marca la casilla.
    • Se muestra el campo de “Llave” y “Valor” para que agregues la información.
    • Si deseas agregar más de una cabecera, da clic en Agregar fila.
    • Para borrar alguna cabecera, da clic en el ícono de Eliminar
  5. Marca la casilla de Autenticación por HTTP para poder agregar:
    • Username: El nombre de usuario que se utilizará para la autenticación.
    • Password: La contraseña que se utilizará para la autenticación.
  6. En Usuarios agrega la URL o IP desde donde se reciben las peticiones.
    • Da clic en Ver detalles para que observes como está construida la petición.
    • Al dar clic en cada uno de los perfiles de usuario, se te enviará a la documentación de la API.
  7. Para agregar Cabeceras marca la casilla.
    • Se muestra el campo de “Llave” y “Valor” para que agregues la información.
    • Si deseas agregar más de una cabecera, da clic en Agregar fila.
    • Para borrar alguna cabecera, da clic en el ícono de Eliminar
  8. Marca la casilla de Autenticación por HTTP para poder agregar:
    • Username: El nombre de usuario que se utilizará para la autenticación.
    • Password: La contraseña que se utilizará para la autenticación.
  9. Para guardar da clic en Aceptar.

Colas pendientes

  1. Desde tu “Panel de control” selecciona Usuarios API.
  2. Despliega “Webhooks” y selecciona Colas pendientes.
    • NOTA: Se mostrarán colas pendientes cuando los intentos de envío sean a partir de 6.
      • En 5 minutos envía 3 intentos.
      • En 10 minutos envía 4 intentos.
      • En 30 minutos envía 5 intentos.