API v2: Allowing Access to the API

To use the Cezanne HR API you will first need to enable access to users of the system. This article shows how to do this within Cezanne and contains the following sections:

  1. Enable API Access
  2. Manage Exceptions

Note:

  • We recommend limiting access to the API to selected users or security roles. If you wish to deploy an application that uses the API to everyone within your organisation, then we recommend that you contact our Support Team to set up a new Authorised Application. For more information, please refer to the following pdf: oAuth2Flows.pdf.
OAuth2Flows.pdf

1. Enable API Access

This can be done by navigating to: System Setup >> Security Settings >> Authorised Applications:

  1. Select and Enable the OData authentication service.
  2. Specify the users or roles who can access the API by clicking Advanced...
1. Enable API Access

2. Manage Exceptions

  1. Select No-one from the Availability drop-down.
  2. Click the pencil icon to Manage Exceptions
2. Manage Exceptions
  1. Specify the user(s) or Security Role(s) which can use the API by using the 'Add new' buttons.