SetUp Open Project Client

Prerequisites

In order to allow for a smooth integration of the Open Project we need to set up a user account which in this case would act as a service account.
Make sure the service account has Administrator rights. Either on user creation make sure to have the Administrator checkbox ticked or if you want to use an existing service account, find it under /users and tick the checkbox there.

Steps to generate an Open Project API Key

  1. We first log in to the OpenProject instance and we navigate to the user settings icon on the top right corner.

  1. By clicking on the Account settings Link in the right Navigation we can open the Access tokens page from the left navigation.

  1. On the access token settings page we click the "+ API Token" button to create a new one and give it a name.

Share Credentials

In conclusion after creating the service account and the API token what needs to be sent accordingly in a safe fashion to our team to complete the integration would be:

  • The username and password of the service account which has the right permissions which we created in the prerequisites.

  • The API key which we generated in the above defined steps.

  • The open project instance URL.