Configuración

API keys

El complemento Construye tu propia integración permite a los usuarios que lo adquieran una mayor facilidad para gestionar los usuarios que estarán consumiendo las API´s de academic.

​

Nota: Para obtener más información sobre la gestión de complementos consulta la guía rápida: Gestión de complementos

Contenido

1. Ruta.

​

• Construye tu propia integración:
1. API keys:
1. Filtro y listado.
2. Usuarios:
1. Registrar.
2. Editar.
3. Peticiones:
• Detalle.

Para que un usuario administrador con permisos pueda acceder a configurar los usuarios que serán usados por las API´s de academic es necesario acceder a la siguiente ruta:

​

Configuración > Complementos > Gestión de complementos

​

Desde esta ventana se mostrarán los complementos que la institución tiene opción de incorporar a la plataforma.

​

Al identificar el complemento: Construye tu propia integración se dará clic sobre la tarjeta para acceder al detalle.

Ruta

Desde esta ventana será posible visualizar la información del complemento:

​

• Descripción: Una breve introducción a la funcionalidad del complemento.

​

• Características: Algunos puntos clave del complemento.

​

• Botones:
• Solicitar información.
• Obtener:
• Webhooks.
• API keys.
• Quitar.

​

​

Construye tu propia integración

En esta ventana se mostrará el campo opcional de Nombre para Buscar algún usuario creado

​

Si el campo se deja vacío el listado mostrará todos los registros de usuarios que se tengan.

​

Cada opción del listado contará con sus columnas:

​

• Nombre: Tanto para los usuarios que ya se tenían generados o los nuevos usuarios.

​

• Opciones: Los botones a mostrar para cada usuario son:
• Seleccionar.
• Peticiones.
• Eliminar.

API keys

Filtro y listado

API keys

Anteriormente era necesario que cada usuario tuviera registrados los campos obligatorios de:

​

• Nombre.
• Apellido paterno.
• Apellido materno.
• Correo electrónico.
• Contraseña.
• Confirmación de contraseña.

​

Al Guardar la información se creaba el Token de petición para el usuario.

​

Ahora, para Registrar únicamente es necesario el Nombre del usuario para que se generen las credenciales.

​

Usuarios

Construye tu propia integración

​

Al dar clic en el botón Seleccionar de alguna de las opciones del listado se mostrará su información registrada, si se muestran los campos de Apellidos será el indicador para saber qué se trata de un registro anterior.

​

Ambos tipos de credenciales serán válidos para el uso de las API y cada uno mostrará su ventana correspondiente según la información con la que fueron creados.

Seleccionar

Nota: Ya no será posible dar de alta con el método anterior.

API keys

Al dar clic en el botón de Peticiones de cualquiera de los usuarios registrados se mostrará una ventana con un listado ordenado donde cada registro mostrará las solicitudes realizadas con las credenciales seleccionadas.

​

El listado estará paginado y ordenado de la petición más reciente a la más antigua y cada petición ejecutada tendrá la información:

​

• Fecha: Fecha y hora en que se realizó la petición.
• Tipo: Según el tipo de API que se utilice.
• Resultado: Código numérico y de color correspondiente (200 o 404).
• Opciones: Botón Ver detalle.

​

Peticiones

Nota: En caso de que el usuario no cuente con peticiones registradas se mostrará el icono y mensaje correspondiente

Al dar clic en el botón Ver de cualquiera de las peticiones del listado histórico de algún usuario se mostrará la ventana con el Detalle y los campos de:

​

• Fecha: Cuando se realizó la petición.
• Resultado: Icono y color según el tipo de respuesta:
• 200:
• 500:
• Detalle: Mensaje de retorno según el API.
• ENDPOINT:
• Get: Este tipo de petición NO genera un Body.
• Post: Par este tipo de petición se tendrá un Body.
• Body: Gracias a un visor será posible ver el código de la petición realizada para aquellas de tipo POST.

​

El botón Regresar permitirá volver al listado de peticiones del usuario.

Peticiones

Detalle