Analyzing data is one of the most important steps in business structure and planning for the future of the organization. Therefore, we created the open data API so that you can analyze the data that is registered in Elofy, within the BI tool used by your company in order to make the process faster and easier.

In this article, you will also learn how to integrate the API data with Power BI and Google Sheets tools.

NOTE 01 - It is recommended that the API integration be done by the technology or data analysis department of your company, since they have more experience with the use of data systems.

NOTE 02 - This article is intended for administrators (without cumulation with another profile), based on the access permissions for the features. If you want to know more about profiles, click here.

Enjoy!

Click on one of the options below:

1. Using the Open API

1.1 Using the open API in Power BI

1.2 Using the open API in Google Sheets

2. Errors that may happen in the API

This first step is valid for all BI tool types.

Access the API Data’s link.

In the API data, log in with your Elofy password or use your user token (if you use the platform by Google or Microsoft).

Select the login tab.

Click ‘Try it out’ and enter your Elofy login and password, inside the quotation marks.

Click on ‘Execute’.

And, again, click "Execute".

On execution, scroll down and copy the token without quotation marks.

Go up the screen again and click on "Authorize".

Paste the token into "value" and then click "authorize". Then close it by clicking "close".

In the intended API, click on "Try it out" and on "Execute" and again on "Execute".

NOTE 01 - For the API (Individual Development Plan), you must insert the start and end date of the period before clicking execute.

NOTE 02- Some APIs need the period/window ID in order to work. These are:

The period ID is obtained from the Period API. So, first run the Period API to get back into the intended API and enter the ID number.

Inside the API with the mandatory filter, first click on ‘Try Out’, then enter the period ID in the following box:

Finally, click on ‘execute’ and then again on ‘execute’.

Check the data in the Responses section.

If the process fails, the system will report an error.

First, go to Settings > Integrations and API.

On the screen, collect your token from the Public API Token - Module Data option.

Go back to the API link and within the wanted API, click on the padlock icon.

Paste your Elofy token into "value" and then click "authorize". Next, click "close".

Then in the same API, click on "Try it out" and on "Execute" and again on "Execute".

NOTE 01 - For the API (Individual Development Plan), you must enter the start and end date of the period before clicking execute.

NOTE 02 - Some APIs need the period/window ID in order to work. These are:

The period ID is obtained from the Period API. So, first run the Period API to get back into the intended API and enter the ID number.

Inside the API with the mandatory filter, first click on "Try Out", then enter the period ID in the following box:

Finally, click on "execute" and then again on "execute".

Check the data in the Responses section.

If the process fails, the system will report an error.

Once you have performed the previous steps of the "Using the open API" session, open your Power BI and click on "get data".

Find the "web" option and click connect.

On the web screen, in the "advanced" tab, fill in the following data.

1 - Paste the URL of the data API that will be used from Elofy: https://api.elofy.com.br/complemento

NOTE - In case of mandatory filters (Period/Window ID), the URL of the API must be obtained in "Curl", as shown below:

*Copy the URL without quotation marks.

2 - Next, fill in "Authorization" and "Bearer + space + the token you copied from the API" in step 02.

NOTE - You must type the "Authorization" option, as it is not listed in the parameters.

And that's it, now you just need to adjust Power BI according to what you want.

In order to use Google Sheets you do not need to perform the steps in the "Using the open API" session.

Download the spreadsheet located in this folder. Then place the sheet into your Google Sheets.

In the spreadsheet, enter your Elofy login and password. Automatically, the data will be displayed in the other tabs. If you use the Google or Microsoft login options, please contact our CS team, so we can help you.

NOTE 01 - For the API (Individual Development Plan), you must insert the start and end date of the period.

NOTE 02 - Some API's need the period/window ID in order to work. These are:

So, once you have entered your email and password, go to the "periods" tab and copy the ID and paste it into the field indicated with the start and end date.

The errors that may occur when connecting to Elofy’s API are listed below.

Any other errors that are not listed are probably related to the software used by your company, in which case, it is recommended that you contact the responsible technology department.

The API request has exceeded the time limit, in other words, the system search within the database has taken too long. In this case, please contact Elofy support.

The profile you are using does not have permission to access the intended feature data. Example: If your profile does not include the company's OKRs feature, you will not be able to access the API.

Some APIs need the date to search the data (PDI) that must be provided in the data API’s link, before generating the URL in the ‘Execute’ button. So, if the date is not entered or is entered in the incorrect format, this error will be reported.

Some APIs require the period ID to search for data. Thus, if not inserted or a non-existent ID is inserted, this error will be reported.

These are:

If your token is invalid or you did not enter it correctly.

This problem may also be reported when a user has more than one profile attached (for example: manager and administrator). So, you only need to have one administrator profile to access the API, according to the access permissions.

If the URL entered for searching the data is invalid.

If you have any questions, please contact us, we will be happy to help you.

If you have any questions, please contact us, we'll be glad to help!