Documentación API Seguir

Artículo dirigido a usuario Administrador

En este documento se describe el uso y consideraciones para utilizar el web service de ABC de usuarios en Lernit.

Autenticación

Para utilizar el API de Lernit se requiere tener la llave de usuario y el token de acceso. Ambos datos son entregados por el equipo de Lernit al momento de entregar la plataforma configurada para el cliente. En caso de no contar con alguno de los datos necesarios se puede enviar un correo a bryan.vazquez@lernit.com.mx para hacer la petición de la información.

La llave de usuario debe ser enviada como parámetros en el header de la petición para obtener una respuesta positiva por parte del servidor. Esta llave incluye los datos necesarios para identificar al cliente y los parámetros de seguridad. Se tiene estimado que esta llave se pueda generar de forma automática desde la plataforma a mediados de Septiembre.

En caso de que alguno de los valores no se incluyan o sean incorrectos se recibe una respuesta con el error correspondiente.

Las peticiones se hacen en la siguiente dirección:

POST

El servicio recibe una lista de usuarios, los usuarios incluidos serán creados o actualizados con la información que se manda. Los usuarios no incluidos no se modifican.

• password - El password es obligatorio solo si es un nuevo usuario, si el usuario ya existe incluir el password hace que se actualice el valor actual por el que se está mandando.
• tipoUsuario - Hay 4 posibles opciones. A - Administrador, I - Instructor, P - Participante y L - Participante Lite. Si el valor enviado no se incluye en estas opciones se pone por default P

Nota: Si se incluyen varios registros con el mismo correo en la petición se toma en cuenta únicamente el primero para hacer las actualizaciones necesarias y el resto son desechados

Atributos adicionales

Los campos principales que acepta el API son los enlistados previamente, sin embargo el API se puede extender para aceptar otros campos definidos por el usuario desde la sección de Administrador en la pestaña de Atributos.

Con este proceso se pueden adicionar tantos campos como sean necesarios a un usuario y de forma automática el API los puede procesar con las características que se definan, por ejemplo hacer estos datos opcionales u obligatorios o solicitarlos en un formato específico.

Hay 6 tipos de datos que se pueden aceptar:

Texto: Campo con formato String

Número: Campo numérico con formato BigInt

Fecha: String con formato Date

Email: Se recibe como texto, pero debe tener formato de correo válido.

Opción Múltiple: Puede ser un campo de texto o numérico, sin embargo del lado de la plataforma se define la lista de opciones aceptadas y el API valida que el parámetro enviado coincida con las opciones permitidas.

Booleano:

Recibe true o false como parámetros aceptados.

Es importante considerar que el formato seleccionado debe ser el único enviado ya que de lo contrario la creación o actualización de usuario regresará un error.

Hay que tomar en cuenta que el atributo puede tener cualquier nombre pero se tienen 4 campos reservados:

• Campos requeridos reservados para la generación dc3 y dc4, estos tendrán que ser agregados como atributos adicionales o de lo contrario no será posible la generación de estos
  • clave_estado
  • clave_municipio
  • clave_ocupacion
  • clave_sucursal

Adicionalmente se pueden definir valores esperados desde la misma pantalla, en estos casos aunque el tipo de dato coincida si no es parte de los valores aceptados definidos por el administrador se regresa un error. El nombre con el que se debe mandar debe coincidir con lo que se escriba en el campo "Nombre" al momento de crear el atributo, y si se se pone como " "Obligatorio" en la opción de "Tipo de campo de Importación" sera necesario incluirlo en los datos del usuario o no se veran reflejados los cambios del usuario que no lo tenga

No se tiene un límite en la cantidad de los campos que se pueden agregar, pero si los campos no se agregan correctamente en la pantalla de Atributos o bien si un campo es eliminado el sistema no los va a tomar en cuenta.

Respuesta recibida

Al terminar de ejecutar los cambios solicitados se regresará una respuesta con el siguiente formato, en el cual se enlista la cantidad y detalles de usuarios importados/modificados, usuarios eliminados y usuarios con error, así como el estatus de la respuesta.

Si existe cualquier duda, puedes contactar con tu Account Executive para agendar una sesión con nuestro equipo de IT.