Project Insight allows administrators to install the REST API Add-On and create API tokens that approved external applications can use to access live Project Insight data. This can support workflows such as presenting Project Insight project data in Power BI or connecting another authorized tool to the Project Insight REST API.
Best for: Project Insight administrators who need to enable REST API access and create an API token for Power BI or another external application.
What does the Project Insight REST API Add-On allow teams to do?
The Project Insight REST API Add-On allows authorized administrators to make live Project Insight data available to applications outside of Project Insight.
For example, an organization might connect Power BI to the Project Insight REST API to create reports using current project data.
Project Insight does this by allowing an administrator to create an API token that runs within a selected Project Insight user context. The external application can then use that token when requesting data through the REST API.
Who can install the REST API Add-On and create API tokens?
You must be a Project Insight administrator to:
- Install the REST API Add-On
- Configure the add-on
- Create an API token
- Choose the Project Insight user context for the token
- Enable web application access for the token
The selected user context determines which Project Insight user the API token runs as.
How do you install the REST API Add-On in Project Insight?
- Sign in to Project Insight as an administrator.
- Select Add-Ons.
- Select Get More Add-Ons.
- Find REST API Access.
- Open the add-on.
- Select Install.
Once the installation is complete, you can configure the add-on and create an API token.
How do you open the REST API Add-On configuration?
After installing the add-on:
- Return to the installed add-ons area.
- Find the REST API Add-On.
- Select Configure.
This opens the REST API Add-On page, where administrators can create and manage API tokens.
How do you create a REST API token?
From the REST API Add-On configuration page:
- Select Create REST API Token.
- Choose the Project Insight user context the token should run as.
- Enter a recognizable name for the token.
- Select an expiration date, or leave the token without an expiration date if appropriate.
- Select Enable Web App Access with the API Token.
- Select Create Token.
Project Insight then generates the API token for use in the approved external application.
What is the API token user context?
The user context identifies the Project Insight user account that the API token will run as.
When creating the token, select the appropriate user from the available user context options. In the video, the administrator selects their own user account.
Choose the user context carefully because the external application will connect through that selected Project Insight context.
How should you name an API token?
Enter a name that identifies the application or purpose of the token.
For example, the video uses the name PowerBI Demo for a token intended for a Power BI connection.
A specific name makes it easier for administrators to identify and manage the token later.
[SCREENSHOT PLACEHOLDER: API token name field containing PowerBI Demo — video timestamp 01:14]
Does a Project Insight API token need an expiration date?
Project Insight allows the administrator to select an expiration date when creating the token. The video also indicates that the token can be created without an expiration date.
In the example, the administrator selects the end of the current month.
Choose an expiration date that matches your organization’s access and security requirements. After the token expires, the external application will no longer be able to use that token to connect.
[SCREENSHOT PLACEHOLDER: API token expiration date field — video timestamp 01:25]
Why must you enable web application access?
Select Enable Web App Access with the API Token when the token will be used by Power BI or another external web application.
This setting allows the external tool to use the token when accessing the Project Insight REST API.
If this option is not enabled, the external application may not be able to connect using the token.
How do you copy the API token?
After selecting Create Token, Project Insight displays the generated token.
- Copy the token.
- Paste it into the external application that will connect to Project Insight.
- Select OK when finished.
Treat the token as a sensitive credential. Do not expose it in screenshots, public documentation, unsecured messages, or shared files.
Can you view an API token again after creating it?
Yes. After the token has been created, it appears in the REST API Add-On token list.
Select View Token to display and copy it again when needed.
The token record also shows:
- The token name
- The date it was created
- The expiration date, when one was selected
What should you check before using the token in another application?
Before connecting Power BI or another external tool, confirm that:
- The REST API Add-On is installed.
- The token uses the intended Project Insight user context.
- The token has a clear, recognizable name.
- The expiration date is appropriate.
- Enable Web App Access with the API Token is selected.
- The token has not expired.
- The token value was copied accurately.
You will also need the appropriate Project Insight REST API URL and endpoint when configuring the external application.
What common mistakes should administrators avoid?
Installing the add-on without administrator access
Only a Project Insight administrator can install and configure the REST API Add-On.
Selecting the wrong user context
The token runs as the selected Project Insight user. Confirm that you selected the intended user context before creating it.
Forgetting to enable web application access
Power BI or another external web application may not be able to connect unless Enable Web App Access with the API Token is selected.
Using an expired token
Check the expiration date shown in the REST API Add-On if an existing connection stops working.
Giving the token an unclear name
Avoid generic names that make it difficult to determine which application or connection uses the token.
Exposing the API token
Do not display the token in public screenshots, documentation, recordings, or unsecured communications.
In short, how do you enable REST API access?
Install the REST API Add-On from Add-Ons > Get More Add-Ons, open its configuration page, and create a REST API token.
When creating the token:
- Select the Project Insight user context.
- Give the token a recognizable name.
- Choose an expiration date if needed.
- Enable web application access.
- Create and securely copy the token.
The token can then be used by Power BI or another authorized application when connecting to the Project Insight REST API.
Related questions
Can Project Insight connect to Power BI?
Yes. Power BI can use the Project Insight REST API to retrieve live Project Insight data. The REST API Add-On and an API token must be configured before creating the connection.
Do I need to be an administrator to install the REST API Add-On?
Yes. The transcript specifies that an administrator must install the add-on and create the API token.
Can I create more than one REST API token?
The REST API Add-On displays created tokens in a token list. Create and name tokens according to the external applications or connections your organization needs.
Can an API token run as a specific Project Insight user?
Yes. You select a user context when creating the token, and the token runs within that selected user context.
Can I create a token without an expiration date?
Yes. The video indicates that administrators can select an expiration date or create the token without one.
Why can’t Power BI use my API token?
Confirm that the token has not expired and that Enable Web App Access with the API Token was selected when the token was created.
Where can I view an existing token?
Open the REST API Add-On configuration page and select View Token beside the appropriate token.
Comments
0 comments
Please sign in to leave a comment.