Description
Read this article if you want to set up an integration between levvr and 3rd party software. As project professionals we use various tools and platforms (Sharepoint, Primavera, Revit) to facilitate our work. Integrating tools and platforms enable users to create a broader picture of the context and helps in achieving efficiencies. The project levvr API is a programmable connection that defines what data can be transmitted from levvr to the 3rd party software.
Step-by-step explanation
1. Assign the required role
As a user you need the appropriate role assigned to setup and maintain integrations. Go to your subscription settings and assign the ‘integrations administrator’ role to your username by ticking the box. Note, you need the ‘subscription administrator’ role to assign different roles to users.
2. Create integration to authenticate external app
Go to the project you would like to set up an integration for. Next, click on project settings in the top right corner and create a new integration by clicking on add integration. Fill out:
The application name (client ID)
For example “Sharepoint Company ABC”
The consumer key
You can determine one yourself, for example: “Sharepoint_ABC”
Note: you are not able to use spaces in the consumer key field.
Based on the application name (client ID) and the consumer key an integration secret is created. This secret is a unique code which can be used by the third party system to access levvr’s project API. Make sure to copy the secret and paste it into the designated field in the third party app together with the consumer key. After performing these operations, the external application is registered as an authenticated app for the entire levvr subscription.
3. Set access level for project
Once the external application is authenticated, you can define the access level for this integration per project. You can choose:
None:
Which means the integration cannot access this project’s data through the project API;
Read:
Which means the integration can only read this project’s data through the project API;
Write:
Which means the integration can not only read this project’s data & but also perform create, update & delete operations through the project API;
Please note, authenticating an app is only required once, after that, per project you can define the access level by simply going to the project settings and selecting none, read or write.
And that's that, you've now successfully authenticated a third party app and are ready to perform CRUD operations using our project API.
Troubleshooting
I have lost my secret, what do I need to do? No worries, you can regenerate a new secret. Go to settings and integrations, by clicking on the arrow next to your particular integration for which you lost the secret.