====== 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. - En tu "Panel de control" selecciona **Usuarios API.** - Da clic en **Agregar usuario API.** - 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" {{icon>fas fa-user-check text-blue action-item__icon}}. * Si deseas que el sistema genere el "Nombre de usuario" da clic en el ícono "Generar nombre de usuario" {{icon>fas fa-magic text-blue action-item__icon}} . * **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" {{icon>fas fa-clipboard action-item__icon text-purple}} para copiarla y poder compartirla con el usuario. * Si es necesario generar una nueva contraseña, da clic en el ícono "Contraseña nueva" {{icon>fas fa-redo action-item__icon text-dark}}. * **Direcciones IPv4 y CIDR:** Agrega una dirección IP con CIDR. * **Direcciones IPv6 y CIDR:** Agrega una dirección IP con CIDR. - En la parte media se muestran los **Endpoints** para que selecciones aquellos a los que tendrá acceso este usuario. - En la tabla **Endpoints internos** selecciona los endpoints a los que darás acceso a este usuario. - 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". - Para guardar da clic en **Aceptar.** ===== Modificar usuario API ===== - Desde tu "Panel de control" selecciona **Usuarios API.** - Haz clic en el nombre del operador en donde quieres realizar la modificación. - Da clic en **Modificar.** - 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" {{icon>fas fa-redo action-item__icon text-dark}}. * Aparecerá un mensaje indicando que esta acción generará un nuevo token, para continuar da clic en **Actualizar.** - Para guardar los cambios da clic en **Aceptar.** ===== Webhooks ===== - Desde tu "Panel de control" selecciona **Usuarios API.** - Despliega "Webhooks" y selecciona **Webhooks.** - 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. {{:a:users:users:ver_detalles_webhook.png?direct&400|}} * Haz clic en **Pagos** para que se te envíe a la documentación de la API. {{:a:users:users:pagos_peticion_api.png?direct&400|}} - 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** {{icon>far fa-trash-alt text-red}} - 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. - 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. {{:a:users:users:ver_detalles_webhook_usuarios.png?direct&400|}} * Al dar clic en cada uno de los perfiles de usuario, se te enviará a la documentación de la API.{{:a:users:users:api_usuarios.png?direct&400|}} - 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** {{icon>far fa-trash-alt text-red}} - 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. - Para guardar da clic en **Aceptar.** ===== Colas pendientes ===== - Desde tu "Panel de control" selecciona **Usuarios API.** - 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.