Table of Contents

Obtención de Credenciales de Acceso

Para consumir cualquier endpoint de ejecución, es obligatorio obtener un Token Bearer previamente.

Parámetros necesarios para generar un token

Las credenciales usadas en el Json del Body (accessToken, accessTokenSecret) se obtienen desde la interfaz de Lynn según el ambiente, por un usuario con perfil administrador para Tenant

Tip

Se recomienda crear una credencial única para cada aplicación cliente que va consumir las API, esto permitirá dar de baja a una credencial sin afectar a otras aplicaciones.

Para agregar una nueva credencial hacemos click en el icono de Crear (+), ubicado en la esquina superior derecha el cual abrirá el siguiente formulario:

  • Nombre: Se debe colocar un nombre descriptivo que identifique la aplicación que consume la API.
  • Tenant: Se desplegará una lista con los tenant a los cuales el usuario tiene acceso. En este campo, el usuario debe seleccionar en cuál de los tenant disponibles desea crear la credencial. (Se incluirá entre paréntesis el número del Tenant a utilizar en la API).
  • Division: Las api de Reportería son multi-división, es decir puedes tener una o más divisiones seleccionadas, en la cual la información a recuperar son filtradas en base a esta configuración, es obligatorio tener al menos una división seleccionada en caso contrario al utilizar el token la API va devolver un error. Estas divisiones seran cargadas segun el tenant seleccionado en el campo anterior.
  • Token (accessToken): Autogenerado (Valor a utilizar en la API).
  • Token Secreto (accessTokenSecret): Autogenerado (Valor a utilizar en la API).
  • Webhook: Url en la cual Lynn notifica los mensajes para los clientes, este parámetro se usa para las API de mensajería, en la Api de reportería no aplica se deja vacío.
  • Uso Interno: funciones de aplicaciones propias de Lynn no aplica para el uso de las API.