BI Book API connection Methods

Last updated About 1 month ago

There are two general ways of connecting to BI Book API.

Either by using REST API or OData connection. The latter is the recommended connection type.

For instructions on how to do this see the API docs for BI Book from this link:

  • Introduction – API Reference - please note that the available endpoints cover BI Book Files and BI Book forms. In order to return other data from database please see the instruction below.

OData connection in Excel or Power BI

For establishing OData connection follow these steps:

/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBbG9CIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--8513e346a67e078078c7b629943ded43a8e05d6b/connection%20methods1.png

Here 52 is company id in BI Book:

/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBbHNCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--280942df71d8cb0f175dfd79d00caebace58a488/connection%20methods12.png
/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBbHdCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--5c73061b2f043651e01df71da31043f43c776fb6/connection%20methods13.png
  • Click "OK"

There are 2 authentication methods available - either "Basic" or "Organizational account".

Basic authentication

Select Basic auth and enter the following details:

/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBbDRCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--11c4122629898161f2b828c26e1fddfc658899f2/connection%20methods14.png
/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBbDBCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--1a3adf64d4546e52a8f2be9f708df2c4e215987e/connection%20methods15.png
  • Odata connection completed

/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBbDhCIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--f8fe3bc5d321dd82216bde3f19a3ad840d593f3c/connection%20methods16.png

Authentication with Organizational account

This authentication method is available if your environmental Admin enabled it for you.

  • To authenticate with Organizational account, select this option here:

/rails/active_storage/blobs/redirect/eyJfcmFpbHMiOnsibWVzc2FnZSI6IkJBaHBBZ1lDIiwiZXhwIjpudWxsLCJwdXIiOiJibG9iX2lkIn19--94f7d3a2ed2c6e044bf189e2d7d906c75228b2cc/Screenshot%202024-06-27%20134515.png
  • Click sign-in

  • Choose your organizational account (the one that was used to sign up for BI Book)

  • OData connection completed.

Additional reading

Check this article out to learn about simplified way to connect to your data via OData connection and how you can navigate between data tables: Connecting to your data with ODC file