Saltar al contenido principal

Referencia de la API de OAuth

Ventajas de la autenticación OAuth simplificada​

La autenticación OAuth simplificada de Idukay ofrece varias ventajas para los usuarios y las integraciones, entre las cuales se incluyen:

  • Sesión única: Los usuarios pueden acceder a las integraciones sin necesidad de iniciar sesión nuevamente.

  • Seguridad: La autenticación OAuth simplificada utiliza un flujo de autorización seguro y estándar. Esto garantiza que los datos del usuario estén protegidos y que las integraciones cumplan con los estándares de seguridad.

  • Facilidad de uso: La autenticación OAuth simplificada es fácil de configurar y utilizar, y los usuarios no necesitan realizar ninguna configuración adicional para acceder a las integraciones.

  • Compatibilidad: La autenticación OAuth simplificada es compatible con la mayoría de las integraciones de Idukay. Esto permite a los usuarios acceder a una amplia variedad de servicios y aplicaciones sin tener que preocuparse por la autenticación.

Flujo OAuth simplificado​

La solución de autenticación OAuth simplificada de Idukay se basa en el flujo de autorización estándar de OAuth 2.0, que consta de los siguientes pasos:

Nota

Para efectos de esta documentación se usan ejemplos de dominios y datos ficticios. Estos ejemplos se representan de la siguiente manera:

  • https://integracion.com/oauth/authorize: Endpoint del sistema externo encargado de manejar la autorización con Idukay, el cual debe ser proporcionado por el sistema externo.

1. Solicitud de autorización​

El proceso comienza cuando un usuario hace clic en una integración desde el portal de servicios de Idukay. Esto realiza una llamada inicial a la API de Idukay para obtener la URL de autorización de la integración.

curl --request GET \
     --url 'https://idukay.net/api/oauth/authorize?client_id=CLIENT_ID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE' \
     --header 'Content-Type: application/json'
  • client_id: Identificador único de la integración (proporcionado por Idukay).
  • redirect_uri: URL que se usará para redireccionar al usuario después de la autorización.
  • response_type: Tipo de flujo de autorización. En este caso, se utiliza el flujo de autorización de código.
Respuesta▼

El usuario es redireccionado al endpoint de autorización de la integración. Aquí puede ver un ejemplo de cómo se vería la URL de autorización al ser redireccionado:

https://integracion.com/oauth/authorize?grant_type=code&code=0c774dd5529b3c137a7bcfbaa65509c9227503b0dfe50a57891904b81d006471

2. Autorización acceso datos del usuario​

En este paso, el usuario se encuentra en la URL de autorización de la integración. En este punto, la integración ya cuenta con el código de autorización que se usará para obtener los datos del usuario.

https://integracion.com/oauth/authorize?grant_type=code&code=0c774dd5529b3c137a7bcfbaa65509c9227503b0dfe50a57891904b81d006471
  • grant_type: Tipo de flujo de autorización.
  • code: Código de autorización.

Estos valores son necesarios para solicitar autorización sobre los datos del usuario. La integración solicitará los datos del usuario al endpoint de Idukay de la siguiente manera:

curl --request GET \
     --url 'https://idukay.net/api/oauth/{INTEGRATION_ID}/userinfo?grant_type=code' \
     --header 'Content-Type: application/json' \
     --header 'X-Authorization: {AUTHORIZATION_CODE}'
  • INTEGRATION_ID: Identificador único de la integración que se está autorizando (proporcionado por Idukay).
  • AUTHORIZATION_CODE: Código de autorización que se obtuvo en el paso anterior.
Respuesta OK▼
Respuesta Error▼

3. Validación de sesión​

Una vez que la integración obtiene los datos del usuario, se valida la sesión del usuario. Si la sesión es válida, el usuario es redireccionado al portal de la integración. En caso contrario, el usuario es redireccionado al portal de Login.