API access group

The access group allows you to define the rights of the user group.
It is necessary to refer to the specifications of each set of data you want to retrieve to know the rights attached to it.

The creation of a specific group for each external tool that accesses the API is recommended.
It is preferable to create this access group in the Management residence so that it can be synchronized with all the residences.

In the control panel, the menu Access Right→Access Group allows the creation of the group. Click on the plus in the right corner to open the creation window.

• Enter a separate name for the access group related to the tool. (Only the name is required for the API)
• Click on Save

All you have to do is to give rights for each module that is needed according to the data that the tool must be able to access.

From the configuration panel, the menu «Access rights->Manage rights» allows to give the specific rights to the access group of the API.

1. Click on Group on the left side of the screen
2. Then browse the “Group” drop-down list to find the access group you created previously.
3. Depending on the rights required for the API, check the corresponding rights boxes for each identified module.