Create an API user

To ensure secure and controlled API access, each person or system interacting with the API should have a unique API user.

1. Navigate to API users under API menu.

2. Click “Add user”

3. Fill in “User name” and “Enabled”. Users marked as Disabled will not be permitted to make API requests.

Manage permissions

1. Navigate to API Permissions under API menu.

2. Click “Add group”

3. Fill in the group details to specify which API users are allowed to use which API endpoints:

        1. Group name*: Enter the name of the group of API users.

        2. Select user(s)*: Choose the API users you want to include in this group.

        3. Select role(s)*: Assign roles that represent the API endpoints these API users can make API request.

*Required

4. After creating the group, the admin users must define the specific permissions for each role. These permissions include:

        1. List: Allow the API users to retrieve a list of records.

        2. Details: Allow the API users to retrieve details of records.

        3. Create: Allow the API users to create new records.

        4. Edit: Allow the API users to modify existing records.

        5. Delete: Allow the API users to remove records.