Setup for PlanCare 2 version 11.33.1

Base address of the service

The actual base address of the service is based on the settings RESTApiServiceHostname and RESTApiServicePortNumber as defined in PlanCare 2. The settings can be looked up using the backoffice of PlanCare 2. A screenshot of the settings involved is found here.

The base address is composed like: https://[RESTApiServiceHostname]:[RESTApiServicePortNumber]/plancare2api/ (RESTApiServiceHostname and RESTApiServicePortNumber refer to the value of the application settings in PlanCare 2)

Example: https://webapi.deheer-software.nl/plancare2api

Requesting a token

A token can be requested using the /token endpoint of the api (e.g. POST https://www.yourhosting.url/plancare2api/token).

The POST request for the token has the following form fields:

• grant_type: fixed value is "password" (without the quotes)
• username: the username of a PlanCare2 user
• password: the password of this user
• apikey: the API key assigned by De Heer Software
• employmentId: (optional) the employment of the user. If not given, the default or first active employment will be used
• onBehalfOf: (optional) the username or Windows username of a PlanCare2 user for whom the access is requested for (impersonated access)
• onBehalfOfEmploymentId: (optional) the employment of the user for whom the access is requested for (impersonated access)

An issued token is valid for a given period of time. After this time a new token should be requested. This bearer token then should be included in the authorization header of every request.

Optionally, the employmentId of the PlanCare2 user can be added in the header to override the employmentId which was used to request the token

To use the API you should request an API Key from De Heer Software (info@deheer-software.nl).

Azure Active Directory integration

It is possible to authenticate against an Azure Active Directory. After registering the necessary applications in the Azure Active Directory the Application Id, Tenant Id and Audience must be set in PlanCare 2. In case of Azure Active Directory authentication the Application Id is used as the API Key.

Schema

The WADL document for the Plancare 2 REST api can be found here.
An OpenApi (Swagger v2) schema definition is available at this location.