Añadir / Habilitar acceso a la API (Generar ID de cliente y secreto)

Para utilizar la API de Cezanne, primero tendrás que habilitar el acceso de un usuario dentro del sistema. Para ello, existen dos opciones principales dependiendo del tipo de acceso que requiera el usuario:

Añadir una nueva aplicación API con Client ID y Secret

Si estás creando tu propia aplicación o integración con Cezanne, necesitarás un ID de Cliente y un Secreto con permisos de Lectura o Lectura y Escritura.

Para añadir tu propio ID de Cliente y Secreto:

Navega a: Administración >> Configuración de seguridad >> Aplicaciones autorizadas

  1. Haz clic en Añadir nuevo.
  2. Introduce un Nombre y una Descripción para su aplicación (el Nombre puede aparecer cuando conceda acceso a la aplicación dentro de su flujo oAuth2, la Descripción sólo aparece en la pantalla Aplicaciones autorizadas).
  3. Haz clic en OK.
4. Establezca las llamadas de retorno permitidas (uris de redirección). Si no tiene llamadas de retorno que introducir, puede dejarlo por defecto.
5. Selecciona un usuario de cuenta de servicio.

Nota:

  • Lo ideal es que el usuario de la cuenta de servicio sea un usuario profesional de RR.HH. externo con la opción La contraseña nunca caduca marcada, ya que si la contraseña caduca, la aplicación API dejará de funcionar hasta que se cambie la contraseña.
Authorised Applications - Cezanne OnDemand and 6 more pages - Work - Microsoft​ Edge
6. Clic en Guardar.
7. El usuario de la cuenta de servicio se convertirá automáticamente en un usuario de excepción. Si deseas añadir más usuarios como excepciones, haga clic en el Lápiz y añade cualquier otro usuario o función que necesite.
8. Aquí se muestra tu Secreto de Cliente, que tendrás que Copiar ya que sólo estará disponible mientras la pantalla esté abierta.
9. Si necesitas regenerarlo en cualquier momento, puedes hacer clic en Regenerar y el nuevo Secreto se mostrará hasta que abandones la pantalla.
10. Una vez que hayas copiado el ID de cliente y el secreto, selecciona la pestaña Ámbitos de aplicación.
11. Conmuta el acceso de lectura de la API y el acceso de escritura de la API según sea necesario.
12. Haz clic en Guardar. El ID de cliente y el secreto ya están listos para tu uso.
Authorised Applications - Cezanne OnDemand and 6 more pages - Work - Microsoft​ Edge

Habilitar el acceso de la API a las fuentes OData (por ejemplo, Power Query / Power BI)

Si sólo deseas extraer datos utilizando un feed OData, como en Power Query, puedes utilizar la autenticación Básica, pero primero debe establecer que cualquier usuario que desee que tenga acceso sea una excepción de usuario para la aplicación OData Authentication Service.

Navega hasta: Administración >> Configuración de seguridad >> Aplicaciones autorizadas

  1. Selecciona y habilita la aplicación del servicio de autenticación OData.
  2. Especifica los usuarios o roles que pueden acceder a la API haciendo clic en Configuración avanzada.
Authorised Applications - Cezanne OnDemand and 6 more pages - Work - Microsoft​ Edge
3. Asegúrate de que la opción Habilitar todos los usuarios no está marcada.
4. Haz clic en el icono del lápiz para Gestionar Excepciones
Authorised Applications - Cezanne OnDemand and 6 more pages - Work - Microsoft​ Edge
5. Especifica los usuarios o funciones de seguridad que pueden utilizar la API mediante los botones «Añadir nuevo».
6. Una vez que haya añadido todas las excepciones necesarias, haga clic en Guardar.