Todas las colecciones
Como utilizar de la API de datos abiertos
Como utilizar de la API de datos abiertos

En este artículo, le enseñaremos cómo usar la API de datos de Elofy para el análisis en herramientas de BI. ¡Echa un vistazo!

Actualizado hace más de una semana

El análisis de datos es uno de los pasos más importantes para estructurar el negocio y planificar el futuro de la organización. Por eso, creamos la API de datos abiertos para que puedas analizar los datos registrados en Elofy, dentro de la herramienta de BI que utiliza tu empresa, para que el proceso sea más rápido y sencillo.

En este artículo, también le enseñaremos cómo integrar datos de API en herramientas de Power BI y Google Sheets.

NOTA 01 - Recomendamos que la integración de la API sea realizada por el sector de tecnología o análisis de datos de su empresa, considerando que tienen más experiencia en el uso de sistemas de datos.

NOTA 02 - Este artículo está destinado a usuarios con perfil de administrador (sin superposición con otro perfil), de acuerdo con los permisos de acceso a las funciones. Para obtener más información sobre los perfiles, haga clic aquí.

¡Aprovéchalo!

Haz clic en una de las siguientes opciones:

Uso de la API abierta

Esta primera parte es válida para todo tipo de herramienta de BI.

Accede al enlace de la API de datos.

Dentro de la API de datos, inicia sesión con tu nombre de usuario y contraseña de Elofy o usa tu token de usuario (si usas la plataforma a través de Google o Microsoft).

☝️Con usuario y contraseña de Elofy

Paso 01

Seleccione la pestaña de inicio de sesión.

Paso 02

Haga clic en "Try It Out" y escriba su correo electrónico y contraseña de Elofy dentro de las comillas.

Paso 03

Haz clic en "Execute".

Paso 04

Y nuevamente haz clic en "Execute".

Paso 05

Al ejecutar, desplácese hacia abajo y copie el token sin las comillas.

Paso 06

Sube de nuevo la pantalla y haz clic en "Authorize".

Paso 07

Pegue el token en "value” y luego haz clic en "authorize". Luego cierra con "close".

Paso 08

Dentro de la API deseada, haz clic en "Try It Out" y en "Execute" y nuevamente en "Execute".

NOTA 01: Para la API del Plan de Desarrollo Individual, debes insertar la fecha de inicio y finalización del período antes de hacer clic en execute.

NOTA 02: Algunas API necesitan la identificación del período/ventana para que puedan funcionar. Son ellas:

  • Objetivos y resultados clave

  • Revisión del ciclo:

    • Status de las evaluaciones

    • Promedios finales y calificaciones por fase

    • Calificaciones por evaluador

    • Promedios - fase por resultados

    • Promedios - etapa por habilidades

    • NBox

    • Público

El ID de período se obtiene de la API de períodos. Por lo tanto, primero ejecute la API de períodos para volver a la API deseada e ingrese el número de ID.

Dentro de la API con filtro obligatorio, primero haz clic en "Try Out", luego ingrese la ID del período en el siguiente campo:

Finalmente, haz clic en "execute" y nuevamente en "execute".

Paso 09

Revisa los datos en la parte de Response.

Si el proceso no funcionó, el sistema mostrará “error”.

☝️Con tu token de usuario

Paso 01

Accede, primero, en Elofy las Configuraciones > Integraciones y API.

Dentro de la pantalla, recopile su token en la opción Token API Público – Datos de módulos.

Paso 02

Vuelva al enlace de la API y, dentro de la API deseada, haz clic en el icono del candado.

Paso 03

Pegue su token Elofy en "value" y luego haga clic en "authorize". Luego cierra en "close".

Paso 04

Luego, en la misma API, haz clic en "Try It Out" y en "Execute" y nuevamente en "Execute".

NOTA 01 - Para la API del Plan de Desarrollo Individual, debe insertar la fecha de inicio y finalización del período antes de hacer clic en ejecutar.

NOTA 02 - algunas API necesitan la identificación del período/ventana para que puedan funcionar. Son ellos:

  • Objetivos y resultados clave

  • Revisión del ciclo:

    • Status de las revisiones

    • Promedios finales y calificaciones por fase

    • Calificaciones evaluador

    • Promedios - fase por resultados

    • Promedios - fase por habilidades

    • NBox

    • Público

El ID del período se obtiene de la API de períodos. Por lo tanto, primero ejecute la API de períodos para volver a la API deseada e ingrese el número de ID.

Dentro de la API con filtro obligatorio, primero haga clic en "Try Out", luego ingrese la ID del período en el siguiente campo:

Finalmente, haz clic en "execute" y nuevamente en "execute".

Paso 05

Revisa los datos en la parte de Responses.

Si el proceso no funcionó, el sistema mostrará “error.”


Uso de la API abierta en Power BI

Paso 01

Después de realizar los pasos anteriores en la sesión "Uso de la API abierta", abra su Power BI y haga clic en "Obtener datos".

Paso 02

Busque la opción "web" y haz clic en conectar.

Paso 03

En la pantalla web, en la pestaña "avanzado", rellena los siguientes datos.

  1. Pegue la URL de la API de datos que se utilizará desde Elofy: https://api.elofy.com.br/complemento

    NOTA - La URL de la API, en el caso de filtros obligatorios (ID/Periodo/Ventana), debe recopilarse en "Curl", como se muestra en la imagen a continuación:

    *Copie la URL sin las comillas.

  2. Llene, en secuencia, "Authorize" y "Berear + espacio + el token que copió de la API" en el paso 03 de la sección anterior.

    • NOTA - Debes escribir la opción "Authorization", ya que no aparece en los parámetros.

Paso 04

Bien, ahora solo ajuste Power BI, según lo que desee.


Uso de la API abierta en Google Sheets

Para utilizar Google Sheets, no es necesario realizar los pasos de la sección "Uso de la API abierta".

Paso 01

Descargue la hoja de cálculo que se encuentra en esta carpeta. Y luego coloque la hoja de cálculo en su Google Sheets.

Paso 02

En la hoja de cálculo, complete los datos de inicio de sesión de Elofy y la contraseña de acceso. De esta forma, automáticamente, los datos se presentarán en las otras pestañas. Si usa las opciones de inicio de sesión de Google o Microsoft, comuníquese con nuestro equipo de CS para que podamos ayudarlo.

NOTA 01 - Para la API del Plan de Desarrollo Individual, es necesario insertar la fecha de inicio y finalización del período.

NOTA 02 - Otras API necesitan la ID del período/ventana para que puedan funcionar. Son ellos:

  • Objetivos y resultados clave

  • Revisión del ciclo:

    • Status de las evaluaciones

    • Promedios finales y calificaciones por fase

    • Calificaciones por evaluador

    • Promedios - fase por resultados

    • Promedios - fase por habilidades

    • NBox

    • Público

Por tanto, tras introducir el correo electrónico y la contraseña, acceda a la pestaña de "períodos" y copie el ID deseado y péguelo en el campo indicado con la fecha de inicio y finalización.


Errores que pueden ocurrir en la API

Los errores que pueden ocurrir al conectarse a la API de Elofy se enumeran a continuación.

De esta forma, cualquier otro error que no esté catalogado probablemente esté relacionado con el software que utiliza su empresa, en cuyo caso, le recomendamos que se ponga en contacto con el sector tecnológico responsable.

Problema 01 - Endpoint request timed out

Se agotó el tiempo de espera de la solicitud de API, es decir, la búsqueda del sistema dentro de la base de datos tomó demasiado tiempo. En ese caso, póngase en contacto con el soporte de Elofy.

Problema 02 - You dont have permission

El perfil utilizado no tiene permiso de acceso a los datos de la feature deseada. Ejemplo: si su perfil no incluye la feature de OKR de la empresa, no podrás acceder a la API.

Problema 03 - InitialDate is required o finalDate is required

Algunas API necesitan la fecha para obtener los datos (PDI) que debe ser informado en el enlace de la API de datos, antes de generar la URL en el botón "Execute". Por lo tanto, si la fecha no se inserta o se inserta en un formato incorrecto, se informará de este error.

Problema 04 - PeriodId is required

Algunas API necesitan la ID del período para obtener los datos. Por lo tanto, si no se inserta o se inserta una ID inexistente, se informará de este error.

Siendo ellos:

  • Objetivos y resultados clave

  • Revisión del ciclo:

    • Status de las evaluaciones

    • Promedios finales y calificaciones por fase

    • Calificaciones por evaluador

    • Promedios - fase por resultados

    • Promedios - fase por habilidades

    • NBox

    • Público

Problema 05 - Not Authorized

Si su token no es válido o no lo ha ingresado correctamente.

Este problema también se puede acusar, cuando un usuario tiene más de un perfil vinculado (por ejemplo, gerente y administrador). De esta forma, solo necesitas tener un perfil de administrador para acceder a la API, según los permisos de acceso.

Problema 06 - Method attribute is invalid

Si la URL (edpoint) ingresada para buscar datos no es válida.

Cualquier duda, contáctanos, estaremos encantados de ayudarte 😄


¡Listo!

Cualquier duda, por favor póngase en contacto con nosotros, estaremos encantados de ayudar!

¿Ha quedado contestada tu pregunta?