Accessing your API from within Workforce Management

Note: For custom pages in the application, you can access an API from within the application if you have the appropriate permissions.

This topic outlines how to grant access permissions and test your API from within the application.

Before starting this procedure, you must complete these steps for an existing API Suite:

To access your API from within Workforce Management:

  1. Navigate to Maintenance > Security > API Security > API Suites.
  2. Click Edit for the API Suite that you want to configure access.
  3. In the API Suite Groups section of the maintenance form, click the “+” icon.
  4. Specify this information:
    Security Group
    Specify the security group in Workforce Management that you want to grant access. The user in Workforce Management that will access the API must be part of this security group.
    Permissions
    Specify one of these values: Edit (GET and POST requests), None (No permissions), View (GET requests only).
  5. Click Save.
  6. Navigate to Maintenance > System Administration > Public API User Access Test.
  7. You have two options:
    • For GET requests, specify a valid value in the API URI box and click GET. If the request is successful, a JSON format response will appear in the API Response section of this page.

      For example, /services/api/public/v1/system/health/system-health may return a list of employees in JSON format if the request is successful.

    • For POST requests, specify a valid value in the URI PARAMS box and click POST. If the request is successful, you will see a Success 200 OK message.