API access keys and iCalendar in depth

The API access key is the central authentication mechanism a user relies on to access browser-based add-ons of Rillsoft Integration Server without logging in again — including iCalendar and timeline. Integrations with Redmine, holiday planning, or SAP also require an API access key according to the email templates, see E-mail templates list.

Life cycle of an API access key

In the user list under Administration > Users, the API access key column offers the following actions, see Users:

  • Generate API access key

  • Display API access key

  • Switch to the user’s iCalendar or timeline

  • Send API access key to the user by e-mail

  • Delete API access key

A deleted or no-longer-valid key is the most common cause when iCalendar sync suddenly stops working, see Why doesn’t iCalendar sync work?.

Prerequisite: the matching user role

An API access key alone is not enough — the user also needs the matching user role (e.g. iCalendar user for iCalendar), see Roles and permissions matrix.

iCalendar template per client

Which appointment information is shared via iCalendar with external calendar programs such as Outlook is additionally defined per client via the iCalendar template — independent of the individual user’s API access key, see iCalendar.

  • Users — manage API access keys

  • iCalendar — iCalendar template and calendar types

  • Timeline — timeline module (uses the same access-key mechanism)

  • E-mail templates list — e-mail template for the API access key

api access key, api key, icalendar authentication, icalendar, time entry, feedback, holiday planning, dms, timeline, email notification, it-administration