Saltar al contenido principal

Método de autenticación: oAuth 2.0

OAuth 2.0 es un framework de autorización basado en autenticación por token que permite acceder a la API sin revalar las credenciales de usuario gracias a que utiliza tokens de acceso.

Este método utiliza las credenciales del usuario (ID de usuario y contraseña) para validar la identidad y entregar un token de acceso para el uso de la API.

Credenciales de Usuario​

El ID de usuario y la contraseña los genera y entrega Gosocket tanto para ambiente de pruebas como para ambiente productivo.

UserName: xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxx
Password: xxxxxxxxxxxxxx

Para generar las credenciales de tipo oAuth 2.0 es necesario contar con un usuario de dominio @gosocket.net y que tenga perfil de administrador.

  1. Se inicia sesión en el portal
  2. Se ingresa a las configuraciones de la empresa
  3. Se selecciona la pestaña de Apikeys: En esta pestaña se visualizan las credenciales existentes y se pueden crear nuevas credenciales.
  4. Para crear una nueva credencial, se debe dar clic en el botón para Agregar Apikey y seleccionar el método de autenticación: oAuth_20_metodo

Luego de confirmar el método, se insertará una fila en el listado de credenciales

oAuth_20

Obtención de Token​

Para obtener el token de acceso, se debe consumir el end point:

Se utiliza método POST y los siguientes parámetros:

  • Grand Type: client_credentials
  • Client_id: UserName de las credenciales generadas por Gosocket
  • Client_secret: Password de las credenciales generadas por Gosocket
  • scope: All

El token obtenido es de tipo "Bearer"

Ejemplo:

{
    "access_token": "NAjqd5J2p61Pc6EYX8yKbz1oPnDQFYFY",
    "expires_in": 7200,
    "token_type": "bearer"
}

Consumo API​

Para consumir la API es necesario utilizar el token obtenido y configurar el método de autenticación Bearer Token. Se debe tener en cuenta la vigencia del token ya que si vence, se debe generar uno nuevo.

oAuth_20_Authorization