API de Highbond - Consulta de datos desde Power BI

Modified on Wed, 27 Nov, 2024 at 3:41 PM



Tabla de contenido



¿Qué es la API de HighBond?


La API de HighBond es la interfaz para desarrolladores de la plataforma HighBond. Puede utilizarla para automatizar interacciones con HighBond, crear informes e integrar HighBond con otros sistemas de su empresa. Para mayor información respecto a la API y sus usos puede revisar: HighBond API Reference (1.1.0)



En resumen para utilizar la API de Highbond con Power BI debe tener presente que la API devuelve como respuesta un archivo con los datos en formato JSON, luego de una conexión exitosa. 



¿Qué necesito para acceder a datos de Diligent One desde Power BI?


Antes de establecer la conexión desde Power BI debe tener a mano lo siguiente:


1. Cadena de la petición de información que desea obtener


Por ejemplo: 

Supongamos que usted desea obtener una lista de registros de una tabla almacenada dentro del módulo de Resultados de Diligent One. Para obtener esta información, según se indica en HighBond API Reference (1.1.0), la cadena de petición es la siguiente:


Si observamos la cadena de la imagen en texto se ve así:

{protocol}://{server}/v1/orgs/{org_id}/tables/{table_id}/records 


En la cadena de petición anterior, al sustituir los parámetros encerrados entre corchetes "{}", utilizando la información de los documentos de HighBond API Reference (1.1.0)la cadena de petición anterior se vería similar a la siguiente:

https://apis-us.highbond.com/v1/orgs/#####/tables/409534/records


Observaciones: 

  • {protocol}: https 
  • {server}: apis-us.highbond.com
  • {org_id}: Es el número de Lauchpad Id de su organización. En este ejemplo, no se coloca por temas de seguridad y se representa como "#####".
  • {table_id}: Es el número de tabla de la cual se desea obtener los registros.



2. Datos de autenticación para la cadena de petición


Todas las solicitudes requieren autenticación. Para autenticarse, utilice Launchpad para crear un token (portador) de la API de HighBond para su cuenta. El token es una cadena que le autentica y le permite acceder de forma segura a la API de HighBond.


El parámetro <TOKEN> hace referencia al API Token de Diligent One. Para mayor información puede ver Administrar tokens de acceso


Una vez creado el token, puede indicarlo en la cabecera de la solicitud y la instrucción se vería similar a la siguiente:

Authorization: Bearer 59ef1e1f772#######################################


Nota: Asegúrese de revisar detalladamente la documentación de ayuda y valide que usted cuente con los permisos mínimos requeridos.



Tengo los requisitos, ¿Cómo me conecto desde Power BI?


Una vez tenga lista la información a la mano vaya a su herramienta de Power BI y genere una nueva consulta desde Power Query, utilice la imagen de abajo como referencia:



En su ventana de Power Query vaya a Inicio > Nuevo Origen > Web > Uso Avanzado, complete los siguientes campos y de clic en Aceptar:

  • En la sección "Partes de la URL" coloque su cadena de petición con los valores de su organización.
  • En la sección "Parámetros de encabezado de solicitud HTTP (opcional)" 
    • En el campo Izquierdo, escriba "Authorization"
    • En el campo derecho coloque su Bearer <Token>, reemplazando <Token> por su token de usuario.


Una vez establecida la conexión con la API de Highbond, es posible que le aparezca esta ventana, en donde debe dar clic en el botón Aceptar.




Ya me conecté, ¿Cómo visualizo la información?


En la ventana de Power Query verá un contenido similar a la imagen de abajo, el cual es la respuesta a su petición en formato JSON, por lo cual deberá realizar unos pasos antes de ver el contenido en forma de tabla. 


Paso #1

En el panel "Configuración de la consulta" > Pasos aplicados > Origen (de doble clic sobre esta opción). En la ventana que se abre vaya a la opción "Abrir archivo como" y de la lista seleccione "Json" y de clic en Aceptar:


Ahora el contenido de su ventana de Power Query se verá como la siguiente imagen:


Paso #2

En la fila "data" de clic derecho en "List"  y seleccione "En tabla":


Esto transforma su contenido en una tabla con dos columnas ("Name", "Value) y dos filas (1,2):


Paso #3

En la columna "Name" de clic en las opciones (flecha que apunta hacia abajo a nivel del nombre de la columna), deseleccione "Columnas" y de clic en Aceptar:


Esto actualiza su contenido en una tabla con dos columnas ("Name", "Value) y una fila (1):


Paso #4

En la columna "Value" de clic en las opciones (dos flechas que apuntan hacia lados opuestos a nivel del nombre de la columna), seleccione "Expandir en nuevas filas":


Esto actualiza su contenido en una tabla con dos columnas ("Name", "Value) y varias filas:



Paso #5

Nuevamente en la columna "Value" de clic en las opciones (dos flechas que apuntan hacia lados opuestos a nivel del nombre de la columna), esto le mostrará ahora una la lista de columnas que corresponden a su tabla, para finalizar de clic en Aceptar:

Opcional: Puede deseleccionar la opción "Usar el nombre de columna original como prefijo".


Finalmente podrá visualizar los datos de su tabla:


Con esto ya habrá accedido a los datos de las interpretaciones de Highbond y sólo tendrá que utilizar las herramientas disponibles en Power BI para estructurarlos.



Notas: 
1. Cualquier procesamiento de datos dentro de Power BI queda fuera del alcance del soporte de RISCCO & Diligent One.
2. Cualquier otra forma de conexión desde Power BI hacia los datos de Diligent queda fuera del alcance del soporte de RISCCO & Diligent One.
3. Es posible que los resultados de su conexión puedan variar a lo mostrado en este artículo.





Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article