API Users

Any person with access to ITRP can use the API. For integration purposes you may want to setup special API users. One way to achieve this is described below.

You will end up with a user for which nobody knows the password and you need to have the Account Administrator role to reset the password (after changing the email address).

The API Token will be the only means to access ITRP for this API user.

Create a new user

  1. login as an account administrator
  2. click on the Records console icon in the toolbar and select the option “People”
  3. press the “Add” ( + ) button in the toolbar to open a new person record
  4. set Name field to something like “… API User” (hint: use a naming convention)
  5. provide an email address that you own (address must be unique within account)
  6. select an Organization in the Organization field
  7. select the roles (for example, only the Auditor role so that the API user has read-only access to everything)
  8. press the “Save” button

Complete the enrollment

  1. click on the link in the mail to set an ITRP Password for the API user
  2. set a difficult long password
  3. log in using this new password
  4. forget this password (i.e. do not save it anywhere)
  5. do not log out yet…

Remember the API Token

  1. click on the rightmost option in the toolbar
  2. select the “My Profile” option from the menu
  3. open the section “Personal Information”
  4. scroll to the bottom and reveal the API Token
  5. write down the API Token
  6. click on the rightmost option in the toolbar once more
  7. select the “Sign Out” option

Change the email address

  1. log back in as an account administrator
  2. click on the Records console icon in the toolbar and select the option “People”
  3. select the new API user
  4. press the “Edit” button in the toolbar
  5. change the email to dwh-export.api.myorganization@example.com (again use a naming convention)