Configurar aplicaciones

La creación de aplicaciones, es un proceso que debes llevar a cabo si deseas conectarte con nuestra API. Puedes crear máximo 5 aplicaciones.

Cuando creas una aplicación, esta queda asociada a un clientId y un clientSecret, estos dos campos son necesarios, para obtener un token de acceso (access_token), el cual será el que te permitirá consumir nuestra API.

Este flujo de autenticación es llamado Client Credentials Grant, para conocerlo más en detalle, te puedes dirigir a la documentación oficial(RFC 6749 - The OAuth 2.0 Authorization Framework (ietf.org)).

El token de acceso tiene una vida útil de 10 minutos, una vez esté ha caducado, se debe obtener un nuevo token de acceso para acceder a la API.

De la siguiente manera puedes realizar una petición para obtener el token de acceso:

Variables involucradas en el proceso:

• url_endpoint_token: Esta url la puedes ver en la pantalla de configuración de las aplicaciones.
• basic_valor: Este valor lo obtenemos realizando un base64 de clientId:clientSecret
• clientId: Es el clientId que obtuviste cuando configuraste tu aplicación.

Ejemplo de petición:

curl --location '{url_endpoint_token}' \
--header 'Authorization: Basic {basic_valor}' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'client_id={clientId}'

Al realizar esta petición, obtienes como respuesta el siguiente json:

{
"access_token": "asdfasdfasdfsadfsdafsdafasdf4854878449849",
"expires_in": 600,
"token_type": "Bearer"
}

En el cual puedes encontrar el token de acceso (access_token), el cual utilizaras pasándolo en cada petición a nuestra API con el tipo de autenticación bearer.

Se debe tener en cuenta lo siguiente:

• Al indicar el nombre de la aplicación, puede usar nombres que indiquen el departamento o la aplicación que usa la API, un ejemplo puede ser "Interface Contabilidad", la cual se usara para obtener los costos ingresados en las ordenes de trabajo.
• Se solicitara un correo electrónico, al cual se notificara sí se genera algún fallo en el consumo de la API.
• Es importante seleccionar la zona horaria en la cual se encuentra, pues de esto depende la hora en la cual se mostraran los registros cargados a través de la API.
• Una vez cree la aplicación, es necesario que almacene en un lugar seguro el Client Id y el Client Secret (no incrustarlos en códigos visibles desde un navegador como javascript o HTML ni en archivos de fácil acceso) porque cualquier persona con acceso a ellos podría realizar acciones indebidas en su cuenta.
• No volverá a ver el ClientSecret generado una vez abandone esta página.
• URL del token_endpoint al cual usando el clientId y clientSecret generados, puedes pedirle el token de acceso para consumir los servicios de la API Rest: https://users-test-env.auth.us-east-2.amazoncognito.com/oauth2/token
• Al igual que los usuarios del sistema, debe perfilar los permisos de esta aplicación asignándole Grupos de Usuario. Dependiendo de los permisos o privilegios que posean los grupos es que esta aplicación podrá realizar acciones en el sistema.
• Puede asociar varios grupos.

Para Acceder al maestro de las Aplicaciones ingrese al menú de Empresa > Configuracion > Seguridad > Integraciones

Desde este punto se pueden realizar varias acciones como son:

• Crear nuevas Aplicaciones
• Ver Aplicaciones

Crear Aplicaciones

Para generar las credenciales de las aplicaciones siga los siguientes pasos:

• Ingrese al menú de Empresa > Configuracion > Seguridad > Aplicaciones
• Ingrese al enlace de
• Ingrese la informacion solicitada en el formulario
• Haga clic en Asociar sobre cada grupo o grupos de usuarios con los permisos que tendrá la API
• Haga clic en Generar, para poder obtener Client Id y el Client Secret

Ver Aplicaciones

Se cuenta con un maestro de las aplicaciones, en las cuales podrá ver la informacion ingresada, como el nombre de esta, al igual que el Client Id, para que puede identificar de forma rápida, además puede realizar varias acciones sobre estas aplicaciones, usando el botón de Acciones , el cuenta con las opciones de:

• Modificar, esta opción le permite modificar la informacion ingresada como el nombre, correo o asignar mas grupos de usuarios.
• Eliminar, borra los datos de la aplicación y no podrá usarse nuevamente.